Core API – CM
Core API endpoints of the CM module (Channel Management): channels and related resources. Errors are reported as a ResponseType with status ERROR and a list of issues; every issue carries a numeric code and a description. Error codes: 1000 An unknown internal error occurred (HTTP 500), 1001 Invalid input provided (HTTP 400), 1002 The requested resource could not be found (HTTP 404), 1003 The resource already exists (HTTP 409), 1004 The media type sent and/or received is not acceptable (HTTP 406), 1005 The specified user could not be found, 1006 The specified role could not be found, 1007 The requested resource has invalid type, 1008 Error during download directory creation, 1009 Error during copying file, 1010 Access to the requested resource endpoint is forbidden (HTTP 403). Persist and perform endpoints report per-object results in the responses element of the returned PimType, one response with status SUCCESS, WARNING or ERROR per processed object.
Endpoints
Cm
GET /api/core/v1/cm/channels/bulk/{id}
Get the result of a bulk channel operation
Description
Returns the result of a bulk operation started with POST /api/core/v1/cm/channels/bulk. While the operation is still running the response is 204 No Content; poll again after a delay. Each poll restarts the orphan timeout. Once finished, the body is the PimType with ResponsesType that the synchronous endpoint would have returned, one response per processed channel. The result is removed when it has been read: a second GET for the same operation id answers 404 Not Found, as does an unknown id, a result that was evicted after the orphan timeout, or a request that reaches a different WebApp node than the one that started the operation.
Content Type
-
application/xml;charset=UTF-8
-
application/json;charset=UTF-8
-
application/json+compact;charset=UTF-8
-
application/xml; charset=UTF-8
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success: the bulk operation has finished; the body is the PimType with ResponsesType of the executed operation |
|
204 |
No Content: the operation is still running |
|
400 |
Bad Request (error code 1001): the operation failed because the request contained invalid or missing data (e.g. no projects); the error envelope names the problem |
|
401 |
Unauthorized: Not authorized to access the endpoint |
|
404 |
Not Found (error code 1002): unknown operation id, or the result has already been fetched or was evicted |
|
500 |
Server Error (error code 1000): the operation failed unexpectedly; the supportId in the error envelope identifies the entry in the server log |
POST /api/core/v1/cm/channels/persist
Persist channel information
Description
Creates channels and updates the name, attribute values, asset links and PEO links of existing channels. Child channels can be nested inside a project to create hierarchies. Each channel gets its own status in the response; failures of single channels do not fail the request.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
PimTypeDto |
PimType with projects. A channel is looked up by tid, otherwise by id, and created if it does not exist; creating requires tid and type, the parent (parentTid, parentId or an enclosing project) is optional and a root channel is created without one. For existing channels only name, vals, links and peos are applied; type, parent and orderSequence are ignored. Only provided attribute values are changed in the default mode (projects mode delta); mode full deletes child channels missing from the request, together with their subtrees, and rejects a top-level channel when the stored subtree of any existing channel in it, at any nesting level, contains a channel the user may not access (a listed channel is found by tid wherever it is stored and is not moved). PimTypeDto |
X |
Content Type
-
application/xml;charset=UTF-8
-
application/json;charset=UTF-8
-
application/json+compact;charset=UTF-8
-
application/xml; charset=UTF-8
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success: Returns a PimType with responses, one per processed channel. status is SUCCESS, WARNING (the channel was saved but some values were skipped, e.g. an attribute not defined for the channel type; description names them), ERROR (with a description, e.g. unknown channel type), NOT_ACCESSIBLE (the channel was not imported because the user may not access it, its parent or, in mode full, one of its nested channels or a stored descendant of an existing channel in it; checked at every nesting level, the reason is in description) or the text 'Attribute <name> not updated because of insufficient permissions.' for attribute values that were dropped. |
|
400 |
Bad Request: Invalid input (error code 1001), e.g. the PimType contains no projects ('No channels to persist') or the body could not be parsed |
|
401 |
Unauthorized: Not authorized to access the endpoint |
|
403 |
Forbidden: No access to the endpoint |
|
500 |
Server Error: An unknown internal error occurred (error code 1000) |
POST /api/core/v1/cm/channels/query
Query channel TIDs hierarchically
Description
Returns the TIDs of a channel and its descendants, or of all root channels. Query by channel ID or TID, optionally limiting the depth with level, or set root to true to list all channels without a parent. The response is a ChannelRequest that can be posted unchanged to POST /api/core/v1/cm/channels/retrieve.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
ChannelQueryDto |
ChannelQueryDto. Set root to true to list all root channels (all other parameters are then ignored). Otherwise identify the channel by id or tid; if both are set, id takes precedence. level limits the depth of returned descendants (0 = only the channel itself, default 100). The deprecated withChildren=false returns only the channel itself and overrides level. ChannelQueryDto |
X |
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success: Returns a ChannelRequest whose tids contain the requested channel itself followed by its descendants up to the requested level, or all root channels. Channels the user may not access are left out (each channel is checked on its own, so accessible descendants of an inaccessible channel are still returned). The order of the TIDs is not guaranteed. A request with neither root=true nor a usable id (> 0) or tid (non-empty) also answers 200, with an empty object. |
|
400 |
Bad Request: The request body could not be parsed (error code 1001) |
|
401 |
Unauthorized: Not authorized to access the endpoint |
|
403 |
Forbidden: No access to the endpoint |
|
404 |
Not Found (error code 1002): the given tid or id does not identify a channel the user may access; an inaccessible channel answers exactly like an unknown one. If both are set, an unknown tid answers 404 even if the id is valid. |
|
500 |
Server Error: An unknown internal error occurred (error code 1000) |
POST /api/core/v1/cm/channels/briefings/retrieve
Retrieve channel briefings
Description
Returns the briefing of one channel as a patch-briefing XML document: the channel’s briefing layout with its boxes, positions, sizes, attribute values in the requested locale and image references. briefingModuleCfgTid selects the briefing module plugin configuration by its name.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
ChannelBriefingRequestDto |
ChannelBriefingRequestDto with exactly one channel in tids or ids (if both are set, the tid is used) and briefingInfo with locale (OMN language such as de_DE) and briefingModuleCfgTid, both required. ChannelBriefingRequestDto |
X |
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success: Returns the patch-briefing XML document. If neither tids nor ids contain a channel, the body is empty. |
|
400 |
Bad Request: Invalid input (error code 1001): more than one tid ('Only one tid is supported') or id ('Only one id is supported'), missing briefingInfo ('Briefing Info is required'), missing or empty locale (reported as 'Briefing Type is required and must not be empty') or missing or empty briefingModuleCfgTid |
|
401 |
Unauthorized: Not authorized to access the endpoint |
|
403 |
Forbidden: No access to the endpoint |
|
404 |
Not Found (error code 1002): unknown channel tid or id, unknown locale, no briefing module plugin configuration with the name briefingModuleCfgTid ('Briefing Module Configuration with TID '…' not found'), or the briefing could not be generated for the channel. Every failure while generating the briefing is reported as 404. |
|
500 |
Server Error: An unknown internal error occurred (error code 1000) |
POST /api/core/v1/cm/channels/retrieve
Retrieve channel details
Description
Returns channels by their IDs or TIDs as projects of a PimType: type, name, order sequence, parent, metadata and attribute values, plus linked assets, linked PEOs and the PEO hierarchy depending on the request parameters and server configuration. Channels that do not exist or are not accessible to the user are omitted.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
ChannelRequestDto |
ChannelRequestDto with tids and/or ids of the channels to return (tids are used if at least one of them exists, otherwise ids). Optional: includePeoHierarchy adds the product/article/variant hierarchy of the linked PEOs; retrieveLinkedAssets and retrieveLinkedAssetsBehavior control the asset links (omitted: server default). At most omn.eai.api.page.size channels (default 1000) per request. ChannelRequestDto |
X |
Content Type
-
application/xml;charset=UTF-8
-
application/json;charset=UTF-8
-
application/json+compact;charset=UTF-8
-
application/xml; charset=UTF-8
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success: Returns a PimType whose projects contain the requested channels, ordered by orderSequence and TID. Unknown or inaccessible channels are omitted without notice, and attribute values the user may not read are removed. If nothing matches, projects is absent (an empty request returns an empty PimType). |
|
400 |
Bad Request: Invalid input (error code 1001), e.g. more than omn.eai.api.page.size channels requested ('Too many projects requested'), an unknown retrieveLinkedAssetsBehavior value or an unparsable body |
|
401 |
Unauthorized: Not authorized to access the endpoint |
|
403 |
Forbidden: No access to the endpoint |
|
500 |
Server Error: An unknown internal error occurred (error code 1000) |
POST /api/core/v1/cm/channels/bulk
Start a bulk channel operation
Description
Starts an asynchronous bulk operation on channels. The request body is the PimType accepted by POST /api/core/v1/cm/channels/persist. The operation runs in the background and the response carries only the operation id (plain text); fetch the result with GET /api/core/v1/cm/channels/bulk/{id}. Use the bulk endpoint for large payloads whose synchronous processing would exceed the request timeout of a proxy or load balancer. One operation id is returned per request; the result is kept until it is fetched or the orphan timeout (api.core.bulk.orphanTimeout, default one hour) has passed. Operations and their results are held in memory on the WebApp node that accepted the request: with several nodes behind a load balancer, the GET for the result must reach the same node (sticky sessions), and results are lost when the node restarts.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
PimTypeDto |
PimType with the same content as accepted by POST /api/core/v1/cm/channels/persist. PimTypeDto |
X |
Responses
| Code | Message | Datatype |
|---|---|---|
201 |
Created: the bulk operation has been started. The body is the operation id for GET /api/core/v1/cm/channels/bulk/{id}. Every parsable body is accepted; validation errors of the payload (e.g. no projects) are only reported by GET /api/core/v1/cm/channels/bulk/{id}, as 400 with the error envelope. |
|
400 |
Bad Request: the request body could not be parsed |
|
401 |
Unauthorized: Not authorized to access the endpoint |
|
403 |
Forbidden: No access to 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 |
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 |
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 |
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 |
ChannelBriefingRequestBriefingInfoDto
Info about BriefingModule Plugin Configuration and Language
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
locale |
String |
OMN Locale in which to retrieve the briefing information |
|||
briefingModuleCfgTid |
String |
Name of the BriefingModule plugin configuration of the mandator (the plugin configuration identifier). A configuration of another plugin with that name is not accepted. |
ChannelBriefingRequestDto
Request object for channel briefing with project identifiers and briefing information
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
tids |
List of [string] |
Filter parameter, Project TIDs, identifying unique project. The value of this parameter will be preferred over id. |
|||
ids |
List of [long] |
Filter parameter, Project ID, identifying unique project. The value of this parameter will be disregarded if tid is set. |
int64 |
||
briefingInfo |
Briefing information object containing detailed briefing data |
ChannelQueryDto
Query object for channel filtering with project identification, hierarchy levels, and child inclusion options
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
tid |
String |
Filter parameter, channel (project) TID identifying a unique channel. Ignored when empty. If id is set as well, id takes precedence, but an unknown tid still fails the request. |
|||
id |
Long |
Filter parameter, channel (project) ID identifying a unique channel. Ignored when not greater than 0. Takes precedence over tid if both are set. |
int64 |
||
withChildren |
Boolean |
DEPRECATED. Use level instead. Export child projects as well, default is true. If set to false the 'level' parameter will be ignored and no children will be returned. |
|||
level |
Integer |
How deep in the hierarchy child projects should be returned. 0 will return only the requested project without children. 1 will return the project itself and first grade immediate child projects. And so on. Default is 100 for legacy compatibilty of 'withChildren', so make sure to set this to a more appropriate value |
int32 |
||
root |
Boolean |
Return all root level projects. When this is set to true all other parameters are ignored. |
ChannelRequestDto
Request object for retrieving channel information with linked assets and PEO hierarchy options
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
tids |
List of [string] |
Filter parameter, channel (project) TIDs. Unknown TIDs are skipped. Used instead of ids if at least one of the TIDs exists. |
|||
ids |
List of [long] |
Filter parameter, channel (project) IDs. Only used if none of the given tids exists. |
int64 |
||
includePeoHierarchy |
Boolean |
Adds a peoHierarchy element with the product/article/variant hierarchy of the PEOs linked to the channel. Omitted: false. Only used by retrieve. |
|||
retrieveLinkedAssets |
Boolean |
Whether to return the assets linked to the channel. Omitted: the server property omn.eai.exporter.cm.exportLinks decides (default withChildren); false: no asset links; true: retrieveLinkedAssetsBehavior decides. Only used by retrieve. |
|||
retrieveLinkedAssetsBehavior |
Which asset links are returned when retrieveLinkedAssets is true: direct = the linked assets and directories, withChildren = additionally the files directly inside linked directories, withDescendants = all asset links at any level of the channel's link paths. Omitted: direct. Ignored unless retrieveLinkedAssets is true. Only used by retrieve. |
Enum: direct, withChildren, withDescendants, |
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 |
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 |
Import mode of the domain value list: FULL (default) replaces the existing domain values of the attribute with the given list, DELTA adds the given values to the existing ones. Case-insensitive. |
Enum: FULL, DELTA, |
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 |
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 |
||||
config |
Effective configuration of the system (omn.eai.* properties), grouped into item collections |
||||
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 |
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 |
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 |
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 |