Asset Management — API Reference

Manage resources used across the system

161 endpoints across 8 tags.

Documents

• GET /schema-service/v2/documents/{slug}/generate — Generate document (slug)
• POST /schema-service/v2/documents/{slug}/generate — Generate document (slug)
• POST /schema-service/v2/documents/{documentId}/generate — Generate document (document UUID)
• POST /schema-service/v2/documents/create — Create document
• POST /schema-service/v2/documents/createNew — Initialize document
• POST /schema-service/v2/documents/{documentId}/audience — Add audience to document
• POST /schema-service/v2/documents/{documentId}/content — Add content to document
• PUT /schema-service/v2/documents/{documentId}/name — Rename document
• PUT /schema-service/v2/documents/{documentId}/priority — Update priority in document
• POST /schema-service/v2/documents/preview/by/{identifierType} — Preview document content for a profile
• POST /schema-service/v2/documents/{documentIdentifier}/generate/by/{identifierType} — Generate document for a profile
• POST /schema-service/v2/documents/preview/grouped-by/groups/list — List grouped documents
• GET /schema-service/v2/documents — List documents
• POST /schema-service/v2/documents/preview/list — List documents from groups
• GET /schema-service/v2/documents/{slug} — Get document by slug
• GET /schema-service/v2/documents/by/slug/{slug}/predecessors — Get predecessors for document
• GET /schema-service/v2/documents/{documentId}/predecessors — Get predecessors for document
• GET /schema-service/v2/documents/by/slug/{slug}/successors — Get successors for document
• GET /schema-service/v2/documents/{documentId}/successors — Get successors for document
• GET /schema-service/v2/documents/{documentId} — Get document by UUID
• POST /schema-service/v2/documents/{documentId} — Update document
• DELETE /schema-service/v2/documents/{documentId} — Delete document
• POST /schema-service/v2/documents/{documentId}/copy — Copy document
• POST /schema-service/v2/documents/{documentId}/directory/{directoryId}/attach — Assign document to directory
• POST /schema-service/v2/documents/directory/{directoryId} — Rename document directory
• DELETE /schema-service/v2/documents/directory/{directoryId} — Delete document directory
• GET /schema-service/v2/documents/directory — List document directories
• POST /schema-service/v2/documents/directory — Add document directory
• DELETE /schema-service/v2/groups/{groupId} — Delete document group
• GET /schema-service/v2/groups — List groups
• POST /schema-service/v2/groups — Add group
• POST /schema-service/v2/documents/{documentId}/status/finish — Finish document
• POST /schema-service/v2/documents/{documentId}/status/activate — Activate document
• POST /schema-service/v2/documents/{documentId}/status/resume — Resume document
• POST /schema-service/v2/documents/{documentId}/status/pause — Pause document
• GET /schema-service/schemaTypes — Get schema types
• POST /schema-service/schemaTypes — Add schema type
• DELETE /schema-service/schemaTypes — Delete schema types

Screen views

• GET /schema-service/v3/screen-views/{feedSlug}/generate — Generate screen view from feed
• POST /schema-service/v3/screen-views/{feedSlug}/generate — Generate screen view from feed
• POST /schema-service/screen-views/create — Create screen view
• POST /schema-service/v2/screen-views/createNew — Initialize screen view
• POST /schema-service/v2/screen-views/{screenViewId}/content — Add content to screen view
• POST /schema-service/v2/screen-views/{screenViewId}/audience — Add audience to screen view
• PUT /schema-service/v2/screen-views/{screenViewId}/priority — Update screen view priority
• PUT /schema-service/v2/screen-views/{screenViewId}/name — Rename screen view
• POST /schema-service/v2/screen-views/{feedSlug}/generate/by/{identifierType} — Preview screen view with a profile context
• GET /schema-service/v2/screen-views/feeds — List screen view feeds
• POST /schema-service/v2/screen-views/feeds — Create screen view feed
• GET /schema-service/v2/screen-views — List screen views
• GET /schema-service/v2/screen-views/{screenViewId} — Get screen view
• DELETE /schema-service/v2/screen-views/{screenViewId} — Delete screen view
• POST /schema-service/v2/screen-views/{screenViewId}/copy — Copy screen view
• GET /schema-service/v2/screen-views/{screenViewId}/predecessors — Get predecessors for screen view
• GET /schema-service/v2/screen-views/{screenViewId}/successors — Get successors for screen view
• GET /schema-service/v2/screen-views/directory — List screen view directories
• POST /schema-service/v2/screen-views/directory — Add screen view directory
• POST /schema-service/v2/screen-views/directory/{directoryId} — Rename screen view directory
• DELETE /schema-service/v2/screen-views/directory/{directoryId} — Delete screen view directory
• POST /schema-service/v2/screen-views/{screenViewId}/directory/{directoryId}/attach — Assign screen view to directory
• POST /schema-service/v2/screen-views/{screenViewId}/feed — Assign screen view to feed
• POST /schema-service/v2/screen-views/feeds/{feedId} — Rename screen view feed
• DELETE /schema-service/v2/screen-views/feeds/{feedId} — Delete screen view feed
• POST /schema-service/scheduler/entry — Schedule object
• GET /schema-service/scheduler/entry/{objectType}/{objectId} — Get schedule the schedule of an object
• POST /schema-service/v2/screen-views/{screenViewId}/status/finish — Finish screen view
• POST /schema-service/v2/screen-views/{screenViewId}/status/resume — Resume screen view
• POST /schema-service/v2/screen-views/{screenViewId}/status/activate — Activate screen view
• POST /schema-service/v2/screen-views/{screenViewId}/status/pause — Pause screen view

Catalogs

• GET /catalogs/bags/{catalogId}/csv — Get all items as CSV file
• POST /catalogs/bags/{catalogId}/items/upload — Add items from CSV
• GET /catalogs/bags — Get catalogs
• POST /catalogs/bags — Add catalog
• DELETE /catalogs/bags — Delete catalogs
• GET /catalogs/bags/{catalogId}/keys — Get catalog keys
• GET /catalogs/bags/{catalogId} — Get catalog info
• DELETE /catalogs/bags/{catalogId} — Delete catalog
• GET /catalogs/bags/{catalogId}/items — Get items from catalog
• POST /catalogs/bags/{catalogId}/items — Add item
• POST /catalogs/bags/{catalogId}/items/batch — Batch add items
• PATCH /catalogs/bags/{catalogId}/enrichment/fields — Update enrichment fields
• GET /catalogs/bags/{catalogId}/items/itemKey/{itemKey} — Get single item by itemKey
• DELETE /catalogs/bags/{catalogId}/items/itemKey/{itemKey} — Delete single item by itemKey
• GET /catalogs/bags/{catalogId}/items/{itemId} — Get single item by database ID
• POST /catalogs/bags/{catalogId}/items/{itemId} — Update single item by database ID
• DELETE /catalogs/bags/{catalogId}/items/{itemId} — Delete single item by database ID
• GET /catalogs/items — Get all items
• POST /catalogs/bags/{catalogId}/mappings — Add mapping
• GET /catalogs/mappings — Get all mappings
• DELETE /catalogs/mappings/{bpActionParamKey} — Delete mapping
• GET /catalogs/itemDetail — Get single item by unique key
• DELETE /catalogs/v2/bags/{catalogId}/items — Delete all items from a catalog
• DELETE /catalogs/v2/bags/{catalogId}/items/batch — Delete items by itemKeys
• PATCH /catalogs/v2/bags/{catalogId}/enable/filtering — Enable filtering
• PATCH /catalogs/v2/bags/{catalogId}/disable/filtering — Disable filtering
• POST /catalogs/v1/async/bags/{catalogId}/item — Add or update item asynchronously
• PATCH /catalogs/v1/async/bags/{catalogId}/item — Add or update (partial) item asynchronously
• POST /catalogs/v1/async/bags/{catalogId}/items — Batch add or update items asynchronously
• PATCH /catalogs/v1/async/bags/{catalogId}/items — Batch add or update (partial) items asynchronously

Asset tags

• GET /tags-collector/directories — Get all directories
• POST /tags-collector/directories — Create directory
• GET /tags-collector/directories/types — Get directory types
• POST /tags-collector/directories/types — Create directory type
• PATCH /tags-collector/directories/{directoryHash} — Update directory
• DELETE /tags-collector/directories/{directoryHash} — Delete directory
• GET /tags-collector/directories/{directoryHash}/tags — Get tags from directory
• POST /tags-collector/directories/{directoryHash}/tags — Assign tags to directory
• DELETE /tags-collector/directories/{directoryHash}/tags — Unassign tags from directory
• PUT /tags-collector/directories/{directoryHash}/types — Update directory type
• GET /tags-collector/tags — Get tag list
• POST /tags-collector/tags — Create tag
• PATCH /tags-collector/tags/{tagHash} — Update tag

Tags

• GET /v4/clients/tags — Get all tags
• POST /v4/tags — Create a tag
• PUT /v4/tags/{tagID} — Update a tag
• DELETE /v4/tags/{tagID} — Remove a tag
• GET /v4/clients/{clientId}/tags — Get profile tags
• POST /v4/clients/{clientId}/tags/{tagID} — Assign tag to profile
• DELETE /v4/clients/{clientId}/tags/{tagID} — Remove tag from profile

Uploader

• POST /uploader-service/clients/files/by/{identifierType} — Add files for dynamic attachments
• POST /uploader-service/storages/{container}/upload — Upload file
• GET /uploader-service/storage-files/list — List files from workspace
• GET /uploader-service/v2/list — List files from workspace
• POST /uploader-service/storage-files/delete-by-uuid — Remove files
• POST /uploader-service/storage-files/add-star-by-uuid — Add stars
• POST /uploader-service/storage-files/remove-star-by-uuid — Remove stars

Documents (legacy)

• POST /schema-service/document/preview — Preview document (deprecated)
• POST /schema-service/document/{uuid} — Create document version (deprecated)
• GET /schema-service/document/{id} — Get raw document (deprecated)
• POST /schema-service/document/{uuid}/{id} — Update document (deprecated)
• GET /schema-service/v2/document/slug/{slug}/content — Generate processed document (only content) (deprecated)
• GET /schema-service/document/slug/{slug}/content — Generate processed document (only content) (deprecated)
• POST /schema-service/document/slug/{slug}/content — Generate processed document (only content) (deprecated)
• GET /schema-service/document/certification/{slug} — Generate certification document with specific slug. (deprecated)
• GET /schema-service/document/slug/{slug} — Generate processed document (deprecated)
• POST /schema-service/document/slug/{slug} — Generate processed document (deprecated)
• GET /schema-service/document/by-schema/{schema} — Generate documents by schema (deprecated)
• GET /schema-service/document — List documents (deprecated)
• POST /schema-service/document — Create document (deprecated)
• DELETE /schema-service/document — Delete documents (deprecated)
• GET /schema-service/document/{uuid}/versions — Get document versions (deprecated)
• POST /schema-service/document/{uuid}/publish — Publish document (deprecated)
• GET /schema-service/document/slug/{slug}/check — Check if slug is correct (deprecated)

Screen views (legacy)

• GET /schema-service/screenViews — Get all screen views (deprecated)
• POST /schema-service/screenViews/byKeys — Get screen views by keys (deprecated)
• GET /schema-service/screenViews/single/{screenViewId}/{screenViewVersion} — Get screen view (deprecated)
• GET /schema-service/screenViews/versions/{screenViewId} — Get screen view versions (deprecated)
• GET /schema-service/screenViews/generate — Generate screen view (deprecated)
• GET /schema-service/v2/screenViews/generate — Generate screen view (deprecated)
• POST /schema-service/screenViews/createNew — Initialize screen view (deprecated)
• POST /schema-service/screenViews/content/{screenViewId}/{screenViewVersion}/copyFromExistingScreenView — Copy content (deprecated)
• POST /schema-service/screenViews/content/{screenViewId}/{screenViewVersion} — Add content (deprecated)
• POST /schema-service/screenViews/audience/{screenViewId}/{screenViewVersion} — Add audience (deprecated)
• POST /schema-service/screenViews/publish/{screenViewId}/{screenViewVersion} — Publish screen view (deprecated)
• POST /schema-service/screenViews/copyDraftFromExistingScreenView — Copy draft from existing screen view (deprecated)
• POST /schema-service/screenViews/createDraftFromExistingScreenView — Create draft from existing screen view (deprecated)
• PUT /schema-service/screenViews/single/{screenViewId}/{screenViewVersion}/description — Update screen view description (deprecated)
• PUT /schema-service/screenViews/single/{screenViewId}/{screenViewVersion}/priority — Update screen view priority (deprecated)
• POST /schema-service/screenViews/discardChanges/{screenViewId}/{screenViewVersion} — Discard changes (deprecated)
• DELETE /schema-service/screenViews/delete/{screenViewId} — Delete screen view (deprecated)
• DELETE /schema-service/screenViews/single/delete/{screenViewId}/{screenViewVersion} — Delete screen view version (deprecated)

Back to all API categories