For the complete documentation index, see llms.txt.
Skip to main content
Version: 8.10 (unreleased)

Ingest catalog assets

PUT 
/catalog/assets/ingestion

Ingests the full set of catalog assets.

For each asset, the actual element template JSON file as well as an accompanying README file must be provided. The README should provide a description of the asset and can use Markdown syntax. It must contain a YAML frontmatter section with a template field that references the element template by its file name. Optionally, the frontmatter can specify a category and a list of tags that can be used to search and filter assets in the catalog.

---
template: banking-system-connector.json
category: Finance
tags:
  - invoice
  - payment
  - transaction
---
## Description
...

## Usage
...

The files must be provided as multipart/form-data with the named parts readme and template (the part name is the same for each file of the respective type).

Previously ingested assets that are not included in the request payload will be marked as unpublished in the catalog. Unpublished assets are only accessible to administrators; regular modeling users cannot use them for new diagram elements anymore. Existing diagrams using assets that get unpublished will continue to work as before.

Request​

Responses​

The catalog assets were ingested successfully.