Core API – DAM
Core API endpoints of the DAM module (Digital Asset Management): assets, versions, variations, directories, previews and related resources.
Endpoints
Dam
POST /api/core/v1/dam/assets/checkin
POST /api/core/v1/dam/assets/presigned-url
POST /api/core/v1/dam/assets/histories/retrieve
Get histories for asset
Description
Retrieve comprehensive historical information about assets in the Digital Asset Management system. Provides detailed examination of asset lifecycle events, property changes, user activities, and temporal sequences of modifications for compliance, forensic analysis, and change management.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
HistoryRequestDto |
HistoryRequest object specifying assets to retrieve history for. Use ids for numeric identifiers, tids for Transaction IDs, or paths for file path-based lookup. HistoryRequestDto |
X |
Content Type
-
application/xml;charset=UTF-8
-
application/json;charset=UTF-8
-
application/json+compact;charset=UTF-8
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success: Returns PimType with AssetsType containing comprehensive historical information including change events, user activities, and temporal sequences |
|
400 |
Bad Request: Invalid input provided (e.g., malformed identifiers) |
|
401 |
Unauthorized: Not authorized to retrieve asset histories |
|
404 |
Not Found: Specified assets not found or inaccessible |
|
500 |
Server Error: An unknown internal error occurred |
POST /api/core/v1/dam/assets/previews/retrieve
get assets previews information
Description
Retrieve comprehensive metadata information about various preview formats and renditions of assets in the Digital Asset Management system. Enables discovery of available preview formats, access URLs, dimensional information, and status across multiple quality levels and formats.
Content Type
-
application/xml;charset=UTF-8
-
application/json;charset=UTF-8
-
application/json+compact;charset=UTF-8
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success: Returns PimType with AssetsType containing comprehensive preview metadata including dimensions, file types, URLs, generation status, and technical specifications for all requested preview formats |
|
400 |
Bad Request: Invalid input provided (e.g., malformed identifiers or unsupported formats) |
|
401 |
Unauthorized: Not authorized to retrieve asset preview information |
|
404 |
Not Found: Specified assets not found or inaccessible |
|
500 |
Server Error: An unknown internal error occurred |
POST /api/core/v1/dam/assets/variations/retrieve
get variations for asset
Description
Retrieve comprehensive information about asset variations in the Digital Asset Management system. Variations represent links between assets, showing relationships between original assets and their derived versions for complex asset hierarchy management.
Content Type
-
application/xml;charset=UTF-8
-
application/json;charset=UTF-8
-
application/json+compact;charset=UTF-8
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success: Returns PimType with VariationsType containing asset variation relationships including parent-child hierarchies and variation types |
|
400 |
Bad Request: Invalid input provided (e.g., malformed identifiers) |
|
401 |
Unauthorized: Not authorized to retrieve asset variations |
|
404 |
Not Found: Specified assets not found or inaccessible |
|
500 |
Server Error: An unknown internal error occurred |
GET /api/core/v1/dam/assets/bin
GET /api/core/v1/dam/dirs/bulk/{id}
Content Type
-
application/xml;charset=UTF-8
-
application/json;charset=UTF-8
-
application/json+compact;charset=UTF-8
GET /api/core/v1/dam/assets/bulk/{id}
Content Type
-
application/xml;charset=UTF-8
-
application/json;charset=UTF-8
-
application/json+compact;charset=UTF-8
POST /api/core/v1/dam/assets/variations/types
get variation types
Description
Retrieve a complete list of all available asset variation types in the Digital Asset Management system. Variation types define the categories of relationships that can exist between original assets and their derived versions.
Content Type
-
application/xml;charset=UTF-8
-
application/json;charset=UTF-8
-
application/json+compact;charset=UTF-8
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success: Returns PimType with VariationTypesType containing all configured variation type categories |
|
400 |
Bad Request: Invalid input provided |
|
401 |
Unauthorized: Not authorized to retrieve variation types |
|
404 |
Not Found: Variation types configuration not available |
|
500 |
Server Error: An unknown internal error occurred |
POST /api/core/v1/dam/assets/perform
perform assets
Description
Execute various asset management operations including delete, move, copy, and version control (checkin/checkout). Supports batch operations with transaction consistency and comprehensive error handling.
Content Type
-
application/xml;charset=UTF-8
-
application/json;charset=UTF-8
-
application/json+compact;charset=UTF-8
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Asset operations performed successfully |
|
400 |
Invalid operation parameters or asset conflicts |
|
401 |
Not authorized - operation permissions required |
|
404 |
Asset not found or destination directory not found |
|
500 |
Server error - operation execution failure |
POST /api/core/v1/dam/dirs/perform
perform directories
Description
Execute various operations on directories in the Digital Asset Management system. Supports deletion, moving, copying, and creating directory paths with flexible identification methods and detailed status reporting.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
PimTypeDto |
PimType with ActionsType containing directory operations. Specify dataType='dir', operation type (delete/move/copy/createPath), and directory identification (tid/id/path). Move/copy operations require destination and overwrite parameters. PimTypeDto |
X |
Content Type
-
application/xml;charset=UTF-8
-
application/json;charset=UTF-8
-
application/json+compact;charset=UTF-8
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success: Returns PimType with ResponsesType containing status information about the directory operation including operation details and monitor IDs for tracking |
|
400 |
Bad Request: Invalid input provided (e.g., invalid operation type or missing parameters) |
|
401 |
Unauthorized: Not authorized to perform directory operations |
|
404 |
Not Found: Directory or destination not found |
|
500 |
Server Error: An unknown internal error occurred |
PUT /api/core/v1/dam/assets/bin/chunked/persist/{uploadId}
Chunked upload - finish
Description
Finishes the chunked upload session identified by uploadId and persists the uploaded file. The path and tid parameters should match the ones sent to /dam/assets/bin/chunked/start.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
AssetUploadRequestDto |
AssetUploadRequest with the same path and tid used when starting the chunked upload, plus optional doPreviewsAsync and doOverwrite flags. AssetUploadRequestDto |
X |
Content Type
-
application/xml;charset=UTF-8
-
application/json;charset=UTF-8
-
application/json+compact;charset=UTF-8
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success: Returns PimType with ResponsesType containing the status and information about the uploaded asset |
|
400 |
Bad Request: Invalid input provided |
|
401 |
Unauthorized: Not authorized to access the endpoint |
|
500 |
Server Error: An unknown internal error occurred |
POST /api/core/v1/dam/assets/persist
persist assets
Description
Save asset information including metadata updates, asset renaming, and keyword associations. Supports partial updates where only provided attributes are modified. Validates attribute compatibility and enforces business rules.
Content Type
-
application/xml;charset=UTF-8
-
application/json;charset=UTF-8
-
application/json+compact;charset=UTF-8
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Assets persisted successfully with status information |
|
400 |
Invalid asset data or validation failures |
|
401 |
Not authorized - modification permissions required |
|
404 |
Asset not found or keywords not found |
|
500 |
Server error - persistence operation failure |
POST /api/core/v1/dam/dirs/persist
persist directories
Description
Create new directories or update existing ones in the Digital Asset Management system. Supports creating directories at root level within RNCs, as subdirectories, and updating directory properties with comprehensive attribute support.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
PimTypeDto |
PimType with DirectoriesType for directory operations. For creation: specify rnc or parent TID and directory name. For updates: provide directory TID and new properties. Supports comprehensive directory attributes. PimTypeDto |
X |
Content Type
-
application/xml;charset=UTF-8
-
application/json;charset=UTF-8
-
application/json+compact;charset=UTF-8
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success: Returns PimType with ResponsesType containing status information about the directory creation or update operation |
|
400 |
Bad Request: Invalid input provided (e.g., missing required parameters, name conflicts) |
|
401 |
Unauthorized: Not authorized to create or modify directories |
|
404 |
Not Found: Parent directory or RNC not found |
|
500 |
Server Error: An unknown internal error occurred |
POST /api/core/v1/dam/assets/query
query assets
Description
Search for assets based on multiple criteria including modification dates, file types, and directory locations. Returns asset TIDs for further processing. Supports flexible filtering with AND logic for precise asset discovery.
POST /api/core/v1/dam/assets/retrieve
retrieve assets
Description
Retrieve detailed information about assets in the Digital Asset Management system. Supports multiple identification methods (IDs, TIDs) and optional inclusion of historical data and preview information. This endpoint provides comprehensive asset metadata, attributes, and technical properties.
Content Type
-
application/xml;charset=UTF-8
-
application/json;charset=UTF-8
-
application/json+compact;charset=UTF-8
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Assets retrieved successfully with comprehensive metadata |
|
400 |
Invalid input - check asset identifiers and request format |
|
401 |
Not authorized - authentication required |
|
404 |
Assets not found or no access permissions |
|
500 |
Server error - internal processing failure |
POST /api/core/v1/dam/assets/bin/retrieve
Retrieve binary assets
Description
Retrieves the binary data of assets specified by an AssetRequest (ids, tids, formats). When multiple assets and/or formats are requested, the files are compressed into a zip with one directory per tid/id.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
AssetRequestDto |
AssetRequest with filter parameters: tids (asset TIDs), ids (asset IDs) and formats (preview format or asset). AssetRequestDto |
X |
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success: Returns the binary data. A single file for one asset/format, or a zip when multiple assets and/or formats are requested |
|
400 |
Bad Request: Invalid input provided |
|
401 |
Unauthorized: Not authorized to access the endpoint |
|
500 |
Server Error: An unknown internal error occurred |
POST /api/core/v1/dam/assets/statuses
retrieve assets statuses
Description
Retrieve status information for specified assets including import states and object states. Essential for monitoring asset processing, workflow management, and troubleshooting operations.
Content Type
-
application/xml;charset=UTF-8
-
application/json;charset=UTF-8
-
application/json+compact;charset=UTF-8
POST /api/core/v1/dam/attribute-definitions/retrieve
Retrieve DAM attribute definitions
Description
Retrieves DAM metadata attribute definitions by ids or tids, or all of them at once. The response is returned in the same format as PIM attribute definitions.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
AttributeDefinitionsRequestDto |
AttributeDefinitionsRequest with one of: ids, tids arrays, or the all flag (default false). If all=true, ids and tids are ignored. If both ids and tids are provided, ids are ignored. AttributeDefinitionsRequestDto |
X |
Content Type
-
application/xml;charset=UTF-8
-
application/json;charset=UTF-8
-
application/json+compact;charset=UTF-8
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success: Returns PimType with a filled AttributeDefinitionsType containing the requested DAM metadata attribute definitions |
|
400 |
Bad Request: Invalid input provided |
|
401 |
Unauthorized: Not authorized to access the endpoint |
|
404 |
Not Found: Requested attribute definitions not found |
|
500 |
Server Error: An unknown internal error occurred |
POST /api/core/v1/dam/dirs/retrieve
retrieve directories
Description
Retrieve a list of sub-directories of a given Root Name Container (RNC) or directory in the Digital Asset Management system. Supports hierarchical directory browsing with configurable depth levels and multiple identification methods.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
DirectoryRequestDto |
DirectoryRequest specifying which directories to retrieve. Use rncTid for top-level directories, dirTid for sub-directories by TID, or dirPath for sub-directories by path. The level parameter controls depth (1=immediate children, -1=all levels). DirectoryRequestDto |
X |
Content Type
-
application/xml;charset=UTF-8
-
application/json;charset=UTF-8
-
application/json+compact;charset=UTF-8
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success: Returns PimType with DirectoriesType containing requested directory information including TID, name, RNC, and metadata |
|
400 |
Bad Request: Invalid input provided (e.g., invalid level parameter) |
|
401 |
Unauthorized: Not authorized to access directories |
|
404 |
Not Found: Directory, RNC, or path not found |
|
500 |
Server Error: An unknown internal error occurred |
POST /api/core/v1/dam/rncs/retrieve
retrieve rncs
Description
Retrieve a complete list of all Root Node Configurations (RNCs) in the Digital Asset Management system. RNCs represent top-level storage containers with configuration information about storage locations, preview generation settings, server connections, and volume management.
Content Type
-
application/xml;charset=UTF-8
-
application/json;charset=UTF-8
-
application/json+compact;charset=UTF-8
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success: Returns PimType with RncsType containing comprehensive configuration information for all Root Name Containers including storage settings, server details, and preview generation configurations |
|
401 |
Unauthorized: Not authorized to retrieve RNC configurations |
|
404 |
Not Found: RNC configuration service not available |
|
500 |
Server Error: An unknown internal error occurred |
POST /api/core/v1/dam/assets/variations/types/retrieve
get variation types
Description
Retrieve a complete list of all available asset variation types in the Digital Asset Management system. Variation types define the categories of relationships that can exist between original assets and their derived versions.
Content Type
-
application/xml;charset=UTF-8
-
application/json;charset=UTF-8
-
application/json+compact;charset=UTF-8
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success: Returns PimType with VariationTypesType containing all configured variation type categories |
|
400 |
Bad Request: Invalid input provided |
|
401 |
Unauthorized: Not authorized to retrieve variation types |
|
404 |
Not Found: Variation types configuration not available |
|
500 |
Server Error: An unknown internal error occurred |
POST /api/core/v1/dam/assets/bin/chunked/start
Chunked upload - start
Description
Starts a chunked asset upload session. The chunk upload workflow consists of three steps: start the upload, upload N chunks, then finish the upload. The response contains the upload tid required for the next steps.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
AssetUploadRequestDto |
AssetUploadRequest specifying the target path and tid of the file to upload. AssetUploadRequestDto |
X |
Content Type
-
application/xml;charset=UTF-8
-
application/json;charset=UTF-8
-
application/json+compact;charset=UTF-8
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success: Returns OmnType with ResponsesType containing the upload tid (unique identity of the upload session) |
|
400 |
Bad Request: Invalid input provided |
|
401 |
Unauthorized: Not authorized to access the endpoint |
|
500 |
Server Error: An unknown internal error occurred |
POST /api/core/v1/dam/dirs/bulk
POST /api/core/v1/dam/assets/bulk
POST /api/core/v1/dam/assets/bin/persist
Asset upload
Description
Uploads a binary file for an asset in a single request without splitting it into chunks. Semantically identical to the chunked asset upload.
Content Type
-
application/xml;charset=UTF-8
-
application/json;charset=UTF-8
-
application/json+compact;charset=UTF-8
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success: Returns PimType with ResponsesType containing the status and information about the upload asset operation |
|
400 |
Bad Request: Invalid input provided |
|
401 |
Unauthorized: Not authorized to access the endpoint |
|
500 |
Server Error: An unknown internal error occurred |
POST /api/core/v1/dam/assets/bin/chunked/upload/{uploadId}
Chunked upload - upload a chunk
Description
Uploads a single chunk of the file for the upload session identified by uploadId. The request is a multipart form with the binary 'payload' part and the 'chunkId' part.
Content Type
-
application/xml;charset=UTF-8
-
application/json;charset=UTF-8
-
application/json+compact;charset=UTF-8
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success: Returns PimType with ResponsesType containing the status of the chunk upload |
|
400 |
Bad Request: Invalid input provided |
|
401 |
Unauthorized: Not authorized to access the endpoint |
|
500 |
Server Error: An unknown internal error occurred |
POST /api/core/v1/dam/assets/variations/bin/persist
Upload as variation
Description
Uploads a binary file as a variation of an existing asset. The variation type is provided in the request; an optional variation file name can be supplied.
Content Type
-
application/xml;charset=UTF-8
-
application/json;charset=UTF-8
-
application/json+compact;charset=UTF-8
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success: Returns PimType with ResponsesType containing the status and information about the uploaded asset variation |
|
400 |
Bad Request: Invalid input provided |
|
401 |
Unauthorized: Not authorized to access the endpoint |
|
500 |
Server Error: An unknown internal error occurred |
POST /api/core/v1/dam/assets/versions/bin/persist
Upload as version
Description
Uploads a binary file as a new version of an existing asset. The feature creates a version of the file currently on the system and then replaces it with the uploaded file. Semantically identical to the chunked version upload, but performed in a single request without splitting the file into chunks.
Content Type
-
application/xml;charset=UTF-8
-
application/json;charset=UTF-8
-
application/json+compact;charset=UTF-8
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success: Returns PimType with ResponsesType containing the status and information about the upload asset version operation |
|
400 |
Bad Request: Invalid input provided |
|
401 |
Unauthorized: Not authorized to access the endpoint |
|
500 |
Server Error: An unknown internal error occurred |
Models
AbbreviationTypeDto
Container for abbreviated name items with technical identifier
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
itm |
List of ItemTypeDto |
List of abbreviated name items |
|||
tid |
String |
Technical identifier |
ActionTypeDto
Action to be performed on objects such as delete, copy, move, checkout, and checkin
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
meta |
parameters container |
||||
dataType |
X |
String |
Item type on which action should be performed |
||
tid |
X |
String |
Technical identifier of the target object |
||
type |
X |
String |
Action type. Check which action types support chosen dataType. |
||
id |
X |
Long |
Target object identity |
int64 |
|
path |
X |
String |
Unique path to the target object |
ActionsTypeDto
Container for multiple action definitions and operations
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
action |
List of ActionTypeDto |
List of individual action definitions |
ArticleTypeDto
Article entity containing product information and variants
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
name |
String |
Article identifier (name) |
|||
meta |
Additional info |
||||
links |
Object relationships and links |
||||
vals |
Attributes values. More info about product attributes values |
||||
variants |
Article's variants products. |
||||
tid |
String |
Technical identifier |
ArticlesTypeDto
Container for a collection of articles
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
article |
List of ArticleTypeDto |
List of articles |
AssetDefinitionTypeDto
Asset definition containing attribute definitions and configuration
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
attrDefs |
Asset attribute definitions |
||||
config |
Asset configuration settings |
||||
tid |
X |
String |
Technical identifier |
||
type |
X |
String |
Asset definition type |
AssetDefinitionsTypeDto
Container for asset definition collections
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
assetDef |
List of AssetDefinitionTypeDto |
List of asset definition objects |
AssetQueryDto
Query object for asset filtering with modification dates, file types, file names, and directory restrictions
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
modifiedFrom |
Date |
Filter parameter, lower bound of change interval. The value of this parameter will be combined with other filters using logical AND |
date-time |
||
modifiedUntil |
Date |
Filter parameter, upper bound of change interval. The value of this parameter will be combined with other filters using logical AND. |
date-time |
||
fileTypes |
List of [string] |
Filter parameter, a filter on file types, array of discriminators to regard, e.g IMG. The value of this parameter will be combined with other filters using logical AND. |
|||
fileNames |
List of [string] |
Filter parameter, a filter on file names, array of file names to regard, e.g test.jpg. The value of this parameter will be combined with other filters using logical AND. |
|||
directory |
Directory identifier for filtering assets within specific directories |
AssetRequestDto
Request object for retrieving asset information with optional metadata, history, and previews
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
tids |
List of [string] |
Filter parameter, asset TIDs (Metatag GUID), identifying unique objects. |
|||
ids |
List of [long] |
Filter parameter, asset IDs, identifying unique objects. |
int64 |
||
formats |
List of [string] |
Filter parameter, asset formats, identifying preview format or asset. |
|||
retrieveHistory |
Boolean |
It defines whether history should be retrieved |
|||
retrievePreviews |
Boolean |
It defines whether previews info should be retrieved |
|||
retrieveMeta |
Boolean |
It defines whether meta info should be retrieved |
AssetTypeDto
Asset information including metadata, file details, and relationships
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
name |
String |
Asset file name |
|||
meta |
Asset info |
||||
vals |
Asset attributes values. See more in Asset attributes |
||||
keywords |
List of keywords identifiers, linked with the asset. (Deprecated: Use links instead) |
||||
links |
List of linked objects. Currently only contains linked keywords. |
||||
histories |
Asset history |
||||
previews |
List of preview infos |
||||
tid |
X |
String |
Asset technical identifier |
||
id |
Long |
Unique asset identifier |
int64 |
||
type |
X |
String |
File type |
||
parent |
String |
TID of asset parent (directory) |
|||
rnc |
String |
Root node configuration, where asset is stored |
|||
path |
String |
Path to the asset file |
AssetUploadRequestDto
Request object for uploading assets with optional configuration settings
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
path |
String |
Path to a new asset. It must not need to start with a '/'. So '/MAM/…' and 'MAM/…' are both valid inputs. The first path element is the RNC identifier. Might contain new file name with which new asset will be uploaded to the system |
|||
tid |
String |
Tid to set. This is an optional parameter and if not provided then it will be set by the server automatically. |
|||
doPreviewsAsync |
Boolean |
If it is set to false then the preview generation (the checkin) will be done synchronous/blocking. |
|||
doOverwrite |
Boolean |
If it is set to false an existing file will not be overwritten/updated. Instead a HTTP Status Code 403 (Already exists) is returned. |
AssetVariationUploadRequestDto
Request object for uploading asset variations with specific type and filename
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
tid |
String |
Tid of the asset for which the variation is being linked |
|||
variationType |
String |
Specific variation type |
|||
variationFileName |
String |
File name of new variation. The parameter is optional. If has not been set then the name will be taken from provided file. |
AssetVersionUploadRequestDto
Request object for uploading asset versions with optional protection and timeout settings
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
versionComment |
String |
Version comment for a source asset |
|||
id |
Long |
Id of the asset for which the version is being created |
int64 |
||
tid |
String |
Tid of the asset for which the version is being created |
|||
timeoutDate |
Date |
Date until when version will be stored |
date-time |
||
protectedAfterDate |
Date |
Date from when version will be protected |
date-time |
||
protectedBeforeDate |
Date |
Date until when version will be protected |
date-time |
AssetsTypeDto
Container for asset objects
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
meta |
Additional metadata information |
||||
asset |
List of AssetTypeDto |
List of asset objects |
AttrDefinitionTypeDto
Comprehensive attribute definition with metadata, validation, and domain constraints
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
meta |
Attribute definition metadata |
||||
name |
Attribute definition name with localization |
||||
abbr |
Attribute definition abbreviation |
||||
tooltip |
Attribute definition tooltip information |
||||
defaultVal |
Attribute default value definition |
||||
multiValued |
Multi-value capability configuration |
||||
validation |
Attribute validation rules |
||||
domainVals |
Attribute domain value definitions |
||||
domainRange |
Attribute domain range specification |
||||
tags |
Attribute definition tags |
||||
references |
Attribute reference configuration |
||||
noValidateAsRichText |
String |
Rich text validation bypass flag |
|||
id |
Long |
Unique attribute definition identifier |
int64 |
||
tid |
X |
String |
Technical identifier |
||
type |
X |
String |
Attribute type definition |
||
localized |
String |
Whether attribute is language-dependent ("true"/"false") |
|||
required |
String |
Cardinality constraint ("optional", "required", "requiredInAllLanguages") |
|||
domain |
String |
Attribute domain specification |
AttributeDefinitionsRequestDto
Request object for retrieving attribute definitions with optional bulk export
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
tids |
List of [string] |
Filter parameter, attribute definitions TIDs, identifying unique objects. |
|||
ids |
List of [long] |
Filter parameter, attribute definitions IDs, identifying unique objects. |
int64 |
||
all |
Boolean |
True if all attribute definitions should be exported. |
AttributeDefinitionsTypeDto
Container for attribute definition collections with type classification
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
attrDef |
List of AttrDefinitionTypeDto |
List of attribute definition objects |
|||
type |
String |
Attribute type classification |
AttributeTypeDto
Attribute definition containing metadata, validation rules, and domain constraints
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
defaultVal |
Attribute default value. See more in DefaultValueType |
||||
domainVals |
Attribute domain values. See more in DomainValuesType |
||||
domainRange |
Attribute domain range. See more in DomainRangeType |
||||
key |
String |
Attribute definition identifier |
|||
level |
String |
Attribute belonging to product type |
|||
inheritance |
String |
Inheritance type |
|||
restriction |
Attribute presence indicator |
Enum: optional, required, mandatory, |
|||
localized |
Availability of localization |
Enum: true, false, |
|||
cardinality |
Integer |
Linked elements limit |
int32 |
||
option |
Access rights option |
Enum: READONLY, OVERWRITE, SYNCHRONIZED, |
|||
id |
Long |
Unique attribute identifier |
int64 |
||
nodeId |
Long |
Node identifier |
int64 |
||
nodePath |
String |
Node path in classification |
AttributesTypeDto
Container for attribute definitions and configurations
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
attr |
List of AttributeTypeDto |
List of attribute objects |
CheckinRequestDto
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
rncIdentifier |
String |
||||
assetPath |
String |
||||
assetTid |
String |
||||
assetId |
Long |
int64 |
ClassificationNodesTypeDto
Container for classification node hierarchies
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
node |
List of NodeTypeDto |
List of classification node objects |
ClassificationTypeDto
Classification entity containing hierarchical structure and metadata
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
name |
Classification name with localization support |
||||
node |
Root classification node |
||||
tid |
String |
Unique identifier |
|||
id |
Long |
Unique classification id |
int64 |
ClassificationsTypeDto
Container for classification hierarchies and taxonomies
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
clazz |
List of ClassificationTypeDto |
List of classification objects |
|||
mode |
String |
Operation mode |
ConfigTypeDto
Configuration container with item collections
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
itms |
List of ItemsTypeDto |
List of configuration item collections |
DefaultValueTypeDto
Default value container for attribute definitions
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
itm |
List of ItemTypeDto |
List of default value items |
|||
tid |
String |
Technical identifier |
DeletionTypeDto
Deletion operation configuration with data type and options
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
dataType |
Type of data being processed |
Enum: product, attrDefinition, assetDefinition, classification, general, unknown, article, project, variant, tagDefinition, classNode, attribute, template, peo, mixed, projectTypes, locale, asset, productPreviewRefs, keyword, dir, glossary, variation, link, |
|||
tid |
String |
Technical identifier of the object to delete |
|||
option |
List of OptionTypeDto |
List of deletion options |
DeletionsTypeDto
Container for deletion operations and records
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
deletion |
List of DeletionTypeDto |
List of individual deletion operations |
DirectoriesTypeDto
Container for directory collections
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
dir |
List of DirectoryTypeDto |
List of directory objects |
DirectoryIdentifierDto
Directory identifier with multiple ways to reference a directory (TID, ID, or path)
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
tid |
String |
Technical ID of the directory |
|||
id |
Long |
Primary key ID of the directory in the database |
int64 |
||
path |
String |
Path to the directory with RNC (Resource Name Context) |
DirectoryRequestDto
Request object for retrieving directory information from Root Node Configuration
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
rncTid |
String |
A unique identifier of RNC. It is used to get a list of directories of the given RNC |
|||
dirTid |
String |
A unique identity of a directory (Metatag GUID). It is used to get a list of sub-directories of the given directory |
|||
dirPath |
String |
A directory path. It includes RNC identifier and relative path of the given directory |
|||
level |
Integer |
It defines how many level should be loaded. Default value is 1. -1 means to load all levels. 0 means don't load sub-directories but only the matching folder itself |
int32 |
DirectoryTypeDto
Directory object containing hierarchical file system information
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
name |
String |
Directory name |
|||
meta |
Directory metadata information |
||||
vals |
Directory attribute values |
||||
tid |
String |
unique directory identifier |
|||
rnc |
String |
Root node configuration identifier |
|||
parent |
String |
Parent directory tid |
DomainRangeTypeDto
Domain range specification for numeric attribute values
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
from |
String |
The initial value of the variable range of values |
|||
to |
String |
The final value of the variable range of values |
|||
intOnly |
Indicates integer or double type of value |
Enum: true, false, |
DomainValueTypeDto
Domain value definition with items and technical identifier
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
itm |
List of ItemTypeDto |
List of domain value items |
|||
tid |
X |
String |
Technical identifier |
DomainValuesTypeDto
Container for domain values with configuration options
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
domainVal |
List of DomainValueTypeDto |
List of allowed domain values |
|||
allowNewValue |
String |
Indicates whether a new value is possible |
true, false |
||
sortDirection |
String |
Ascending or descending arrangement of values |
|||
sortLanguageId |
Long |
Language by which sorting is applied |
int64 |
||
mode |
String |
Operation mode for domain values |
GlossariesTypeDto
Container for glossary definitions with attribute definitions
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
glossary |
List of GlossaryTypeDto |
List of glossary definitions |
|||
attrDefs |
Attribute definitions for glossaries |
GlossaryEntriesTypeDto
Container for multiple glossary entries in a glossary system
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
glossaryEntry |
List of GlossaryEntryTypeDto |
List of glossary entries containing terms and definitions |
GlossaryEntryTypeDto
Glossary entry containing term definitions and related information
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
meta |
Additional glossary entry attributes: value, last edit date and username, forbidden to usage flag. |
||||
vals |
Custom attribute values associated with the glossary entry |
||||
tid |
String |
TID of glossary entry. |
"24E654CF-2900-438D-83CF-01E3ABAA9B11" |
||
links |
List of linked glossary entries. |
||||
id |
Long |
ID of glossary entry. |
int64 |
||
parentId |
X |
Long |
ID of the parent glossary. Either parentId or parenTid must always be present. |
int64 |
|
parentTid |
X |
String |
TID of the parent glossary. Either parentId or parenTid must always be present. |
"24E654CF-2900-438D-83CF-01E3ABAA9B12" |
|
type |
X |
Type of the glossary entry: sentence or term. |
Enum: sentence, term, |
||
loc |
X |
String |
Locale identifier of the glossary entry. |
{langCode}_{contryCode} |
GlossaryTypeDto
Glossary configuration with metadata and values for terminology management
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
name |
String |
Name of the glossary |
|||
meta |
Metadata information for the glossary |
||||
vals |
Values and entries contained in the glossary |
||||
id |
Long |
Unique identifier of the glossary |
int64 |
||
tid |
String |
Transaction ID or type identifier |
HistoriesTypeDto
Container for historical tracking information
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
history |
List of HistoryTypeDto |
List of history records |
HistoryRequestDto
Request object for retrieving asset history information
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
tids |
List of [string] |
Filter parameter, asset TIDs (Metatag GUID), identifying unique objects. |
|||
ids |
List of [long] |
Filter parameter, asset IDs, identifying unique objects. |
int64 |
||
paths |
List of [string] |
Filter parameter, asset paths, identifying unique objects. |
HistoryTypeDto
Historical record containing tracking and audit information
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
meta |
Historical metadata information |
||||
id |
Long |
Unique history record identifier |
int64 |
I18NTypeDto
Internationalization container for localized content
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
itm |
List of ItemTypeDto |
List of localized items |
|||
loc |
String |
Locale identifier |
|||
mode |
String |
Operation mode |
ItemTypeDto
Item with a value and position information
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
value |
String |
The value content of the item |
|||
pos |
Long |
Position index of the item |
int64 |
||
key |
String |
Key identifier of the item |
|||
loc |
String |
Locale code |
ISO 639 |
||
order |
String |
Order for sorting |
|||
mode |
String |
Mode of operation |
ItemsTypeDto
Container for item collections with metadata
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
itm |
List of ItemTypeDto |
List of item objects |
|||
itms |
List of ItemsTypeDto |
List of nested items collections |
|||
id |
Long |
Unique identifier |
int64 |
||
tid |
String |
Technical identifier |
|||
loc |
String |
Locale identifier |
|||
type |
String |
Type identifier |
|||
attr |
String |
Attribute identifier |
|||
mode |
String |
Operation mode |
KeywordTypeDto
Keyword definition with hierarchical structure and metadata
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
name |
Name information for the keyword |
||||
meta |
Metadata information for the keyword |
||||
links |
Links related to the keyword |
||||
id |
Long |
Unique identifier of the keyword |
int64 |
||
parentId |
Long |
Parent keyword identifier |
int64 |
||
path |
String |
Full path to the keyword in the hierarchy |
|||
parentPath |
String |
Path to the parent keyword |
KeywordsTypeDto
Container for multiple keyword definitions in a keyword system
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
kwd |
List of KeywordTypeDto |
List of keyword definitions |
LinksTypeDto
Container for object relationships and links
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
itm |
List of ItemTypeDto |
List of link items |
|||
itms |
List of ItemsTypeDto |
List of link item collections |
LocaleTypeDto
Locale information for internationalization and localization
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
meta |
Additional locale info |
||||
config |
Locales configuration information |
||||
id |
Long |
Unique numeric identifier of the locale |
int64 |
||
tid |
String |
Technical identifier of the locale |
|||
language |
X |
String |
Language code |
ISO 639 |
|
country |
X |
String |
County code |
ISO 3166 |
|
name |
X |
String |
Display name of the locale |
LocalesTypeDto
Container for locale definitions with mode configuration
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
locale |
List of LocaleTypeDto |
List of locale definitions |
|||
mode |
String |
Mode configuration for locales |
MetaTypeDto
Metadata container with key-value information
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
itm |
List of ItemTypeDto |
List of metadata items |
MultiValuedTypeDto
Multi-value configuration with cardinality limits
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
value |
Multi-value indicator |
Enum: true, false, |
|||
cardinality |
Integer |
Maximum number of values |
int32 |
NameTypeDto
Container for localized name items
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
itm |
List of ItemTypeDto |
List of ItemType with localized names |
NodeTypeDto
Classification node containing hierarchical structure and attributes
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
name |
Node names, default and localized |
||||
attr |
List of AttributeTypeDto |
Assigned attributes to the node |
|||
node |
List of NodeTypeDto |
Children. If nested tree structure was used for retrieve |
|||
tid |
String |
Technical identity |
|||
id |
Long |
Node id |
int64 |
||
parentId |
Long |
parent node id |
int64 |
||
path |
String |
Path in classification |
/ (forward slash) - as separator |
||
parentPath |
String |
parent path in classification |
/ (forward slash) - as separator |
||
classificationTid |
String |
Classification identifier |
|||
mode |
String |
Operation mode |
OptionTypeDto
Key-value option pair for configuration and selection purposes
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
value |
String |
The display value or label of the option |
|||
key |
String |
The unique key identifier for the option |
ParamTypeDto
Parameter definition with key-value pair for configuration purposes
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
value |
String |
The parameter value |
|||
key |
String |
The parameter key identifier |
ParamsTypeDto
Container for parameters with hierarchical support
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
param |
List of ParamTypeDto |
List of individual parameter objects |
|||
params |
List of ParamsTypeDto |
Nested parameter groups |
|||
key |
String |
Key identifier for this parameter group |
PeoTypeDto
Product Entity Object (PEO) containing product relationships and template information
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
default |
String |
Default PEO indicator |
|||
meta |
PEO metadata information |
||||
name |
String |
Name of the PEO |
|||
links |
PEO relationships and links |
||||
vals |
PEO attribute values |
||||
tid |
String |
Technical id (identifier) of PEO |
|||
product |
String |
Product reference |
|||
template |
String |
Template reference |
|||
templateId |
Long |
Template identifier |
int64 |
||
templateTid |
String |
Template technical identifier |
|||
productId |
Long |
Product identifier |
int64 |
||
productTid |
String |
Product technical identifier |
PeosTypeDto
Container for Product Entity Object (PEO) collections
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
peo |
List of PeoTypeDto |
List of Product Entity Objects |
PimTypeDto
Product Information Management (PIM) system - provides access to resources of the PIM module. PIM refers to the management of all product-defining information and its provision for use in output channels.
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
meta |
Additional metadata information containing key/value pairs |
||||
locales |
List of supported locales with language and country codes |
||||
links |
Relations between OMN objects such as assets, products, projects, and keywords |
||||
tagDefs |
Tag definitions for object categorization and metadata |
||||
rncs |
Root Node Configurations representing filesystem access configurations |
||||
versions |
Different states of files, with only one active version at a time |
||||
variations |
Related files that are variations of assets, usually with different file names |
||||
variationTypes |
Types of asset variations available in the system |
||||
assets |
Digital assets such as images, videos, documents, and other media files |
||||
dirs |
Directory structure representing folders that can contain sub-directories or assets |
||||
kwds |
Hierarchical keyword structure for categorizing and tagging objects |
||||
glossaries |
Glossaries containing terms and sentences for translation and terminology management |
||||
glossaryEntries |
Individual entries within glossaries, can be terms or sentences |
||||
attrDefs |
Attribute definitions that define product properties, their types, and validation rules |
||||
assetDefs |
Asset definitions that define types and properties of digital assets |
||||
productPreviewRefs |
References to preview representations of products |
||||
classes |
Product classification system for organizing and categorizing products |
||||
products |
Product information including articles and variations with attributes and relationships |
||||
projectDefs |
Project definition templates and configurations |
||||
projects |
Project instances with metadata and associated resources |
||||
templates |
Templates for creating and structuring various types of objects |
||||
peos |
Product Export Objects defining how products are exported to different channels |
||||
deletions |
Records of deleted objects for tracking and audit purposes |
||||
responses |
Status information and results of performed operations with success, error, or warning details |
||||
actions |
Actions to be performed on objects such as delete, copy, move, checkout, and checkin |
||||
nodes |
Classification tree nodes that represent hierarchical categorization structure |
||||
attrs |
Product and node attributes with their values, inheritance, and localization settings |
||||
params |
Configuration parameters and settings |
||||
schemaVersion |
X |
String |
Version of the PIM schema being used |
PresignedUrlRequestDto
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
rncIdentifier |
String |
||||
method |
Enum: GET, PUT, |
||||
assetPath |
String |
||||
assetTid |
String |
||||
assetId |
Long |
int64 |
PreviewInfoRequestDto
Request object for retrieving preview information of assets
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
assetTids |
List of [string] |
Assets TIDs (Metatag GUID), identifying unique objects. |
|||
assetIds |
List of [long] |
Assets IDs, identifying unique objects. |
int64 |
||
assetPaths |
List of [string] |
Assets paths (Metatag GUID), identifying unique objects. |
|||
formats |
List of [string] |
Asset formats, identifying preview format to be retrieved |
PreviewInfoTypeDto
Preview information containing metadata and identification details
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
meta |
Metadata information for the preview |
||||
tid |
String |
Technical identifier for the preview |
|||
type |
String |
Type of the preview |
PreviewsInfoTypeDto
Container for preview information objects
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
preview |
List of PreviewInfoTypeDto |
List of preview information for different formats and types |
ProductPreviewRefsTypeDto
Container for product preview references containing item information
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
itm |
List of ItemTypeDto |
List of item references for product previews |
ProductTypeDto
Product information including articles and variations with attributes and relationships
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
name |
String |
Product name |
|||
node |
String |
Node path to product |
/ (forward slash) - as separator |
||
clazz |
String |
classification identifier |
|||
links |
Relations to assets/channels/products |
||||
meta |
Additional info |
||||
vals |
Attributes values. More info about product attribute values |
||||
articles |
List of children articles |
||||
tid |
String |
Technical identifier |
ProductsTypeDto
Container for product collections with metadata
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
meta |
Additional metadata information |
||||
product |
List of ProductTypeDto |
List of product objects |
ProjectDefinitionTypeDto
Project definition containing attribute definitions and configuration
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
attrDefs |
Project attribute definitions |
||||
config |
Project configuration settings |
||||
tid |
X |
String |
Technical identifier |
ProjectDefinitionsTypeDto
Container for project definition collections with operational mode
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
projectDef |
List of ProjectDefinitionTypeDto |
List of project definition objects |
|||
mode |
String |
Operation mode for project definitions |
ProjectTypeDto
Project entity containing hierarchical structure, metadata, and product relationships
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
name |
String |
Project name |
|||
meta |
Project metadata information |
||||
vals |
Project attribute values |
||||
links |
Project relationships and links |
||||
project |
X |
oas_any_type_not_mapped |
|||
peos |
Product entities within project |
||||
peoHierarchy |
Product hierarchy structure |
||||
id |
Long |
Unique project identifier |
int64 |
||
tid |
String |
Technical identifier |
|||
parentId |
Long |
Parent project identifier |
int64 |
||
parentTid |
String |
Parent project technical identifier |
|||
type |
String |
Project type classification |
|||
orderSequence |
Long |
Project ordering sequence |
int64 |
ProjectsTypeDto
Container for project collections with operational mode
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
project |
List of ProjectTypeDto |
List of project objects |
|||
mode |
String |
Operation mode for projects |
ReferenceTypeDto
Reference to another object by technical identifier
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
tid |
String |
Technical identifier of the referenced object |
ReferencesTypeDto
Container for reference objects and relationships
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
reference |
List of ReferenceTypeDto |
List of reference objects |
ResponseTypeDto
Response containing status information about performed operations with success, error, or warning details
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
status |
X |
Operation result status |
Enum: SUCCESS, ERROR, WARNING, |
||
description |
String |
General description of the response |
|||
issues |
List of ItemsTypeDto |
List of issues encountered during operation |
|||
details |
Response details |
||||
dataType |
Type of data being processed |
Enum: product, attrDefinition, assetDefinition, classification, general, unknown, article, project, variant, tagDefinition, classNode, attribute, template, peo, mixed, projectTypes, locale, asset, productPreviewRefs, keyword, dir, glossary, variation, link, |
|||
tid |
String |
Tid of processed object |
|||
id |
Long |
Id of processed object |
int64 |
||
action |
String |
Performed action |
|||
path |
String |
Path of processed object |
|||
key |
String |
Key identifier of the object |
|||
nodePath |
String |
Path to the classification node |
|||
nodeId |
Long |
ID of the classification node |
int64 |
ResponsesTypeDto
Container for multiple response objects with operation status information
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
response |
List of ResponseTypeDto |
List of individual response objects |
RncTypeDto
Root Node Configuration containing filesystem access configuration and metadata
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
meta |
Key/value info of RNC record |
||||
tid |
X |
String |
Technical id (identifier) of RNC |
RncsTypeDto
Container for Root Node Configuration (RNC) collections representing filesystem access configurations
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
rnc |
List of RncTypeDto |
List of Root Node Configuration objects |
TagDefinitionTypeDto
Tag definition containing value and technical identifier
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
value |
String |
Tag definition value |
|||
tid |
String |
Technical identifier of the tag definition |
TagDefinitionsTypeDto
Container for tag definition objects
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
tagDef |
List of TagDefinitionTypeDto |
List of tag definitions |
TagTypeDto
Tag object containing metadata and identification information
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
value |
String |
Tag value content |
|||
tid |
String |
Technical identifier |
TagsTypeDto
Container for tag metadata and labeling information
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
tag |
List of TagTypeDto |
List of tag objects |
TemplateTypeDto
Template definition containing metadata and classification nodes
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
meta |
Template metadata information |
||||
node |
List of NodeTypeDto |
Template classification nodes |
|||
tid |
X |
String |
Technical identifier |
||
clazz |
String |
Template class definition |
TemplatesTypeDto
Container for template collections with operational mode
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
template |
List of TemplateTypeDto |
List of template objects |
|||
mode |
String |
Operation mode for templates |
TooltipTypeDto
Tooltip information with localized content items
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
itm |
List of ItemTypeDto |
List of tooltip items with content |
|||
tid |
String |
Technical identifier of the tooltip |
UploadAssetChunkRequest
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
chunkId |
Integer |
int32 |
|||
payload |
File |
binary |
UploadAssetVariationRequest
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
params |
|||||
payload |
File |
binary |
UploadAssetVersionRequest
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
params |
|||||
payload |
File |
binary |
ValidationTypeDto
Validation rules and constraints for attribute values
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
type |
String |
Regular expression of the form |
|||
minLength |
Integer |
Minimum length |
int32 |
||
maxLength |
Integer |
Maximum length |
int32 |
ValueTypeDto
Value object containing attribute data with localization and metadata
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
itm |
List of ItemTypeDto |
List of item values |
|||
i18N |
List of I18NTypeDto |
List of internationalization objects |
|||
tags |
Tags associated with the value |
||||
attr |
String |
Attribute identifier |
|||
type |
String |
Value type identifier |
|||
origin |
String |
Origin identifier |
|||
inheritance |
String |
Inheritance type |
|||
parent |
String |
Parent identifier |
|||
node |
String |
Node identifier |
|||
dataType |
String |
Data type identifier |
|||
mode |
String |
Operation mode |
ValuesTypeDto
Container for value objects with attributes and localization
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
val |
List of ValueTypeDto |
List of value objects |
VariantTypeDto
Product variant containing detailed information and attributes
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
name |
String |
Variant identifier |
|||
meta |
Addtitional info |
||||
links |
Object relationships and links |
||||
vals |
Attributes values. More info about product attributes values |
||||
tid |
String |
Technical identifier |
VariantsTypeDto
Container for product variants
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
variant |
List of VariantTypeDto |
List of variant objects |
VariationRequestDto
Request to get variations for objects. Allow to get asset variations by tids or by ids or by paths
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
assetIds |
List of [long] |
Unique identities of asset |
int64 |
||
assetTids |
List of [string] |
Unique identifiers of a asset (Metatag GUIDs) |
|||
assetPaths |
List of [string] |
Unique paths to an asset |
VariationTypeDto
Asset variation definition with metadata and parent-child relationships
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
meta |
Metadata information for the variation |
||||
assetId |
Long |
Asset identifier for the variation |
int64 |
||
assetTid |
String |
Technical identifier of the asset |
|||
parentTid |
String |
Technical identifier of the parent asset |
VariationTypeTypeDto
Variation type definition with technical identifier
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
tid |
String |
Technical identifier for the variation type |
VariationTypesTypeDto
Container for multiple variation type definitions
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
variationType |
List of VariationTypeTypeDto |
List of variation type definitions |
VariationsTypeDto
Container for multiple variation definitions
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
variation |
List of VariationTypeDto |
List of variation definitions |
VersionTypeDto
Asset version information with metadata and identifiers
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
name |
String |
Name of a version |
|||
meta |
Version metadata information |
||||
tid |
String |
Technical id |
|||
assetTid |
String |
Asset technical id |
|||
assetId |
Long |
Asset id |
int64 |
VersionsTypeDto
Container for asset version collections
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
version |
List of VersionTypeDto |
List of version objects |