Core API – Common
Cross-module Core API endpoints shared by all OMN modules: components, glossaries, keywords, links, locales, messages and transformations.
Endpoints
Common
GET /api/core/v1/common/links/bulk/{id}
Content Type
-
application/xml;charset=UTF-8
-
application/json;charset=UTF-8
-
application/json+compact;charset=UTF-8
GET /api/core/v1/common/keywords/bulk/{id}
Content Type
-
application/xml;charset=UTF-8
-
application/json;charset=UTF-8
-
application/json+compact;charset=UTF-8
GET /api/core/v1/common/glossaryEntries/bulk/{id}
Content Type
-
application/xml;charset=UTF-8
-
application/json;charset=UTF-8
-
application/json+compact;charset=UTF-8
GET /api/core/v1/common/glossaries/bulk/{id}
Content Type
-
application/xml;charset=UTF-8
-
application/json;charset=UTF-8
-
application/json+compact;charset=UTF-8
POST /api/core/v1/common/glossaries/perform
Perform actions on glossaries (delete)
Description
Allows you to execute actions on glossaries such as delete operations. This endpoint uses the perform action pattern to remove glossaries by their ID.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
PimTypeDto |
PimType with ActionsType containing glossary action details. For delete: specify dataType='glossary', id, and type='delete'. 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 OmnType with ResponsesType containing statuses about each performed action on glossaries |
|
400 |
Bad Request: Invalid input provided |
|
401 |
Unauthorized: Not authorized to access the endpoint |
|
404 |
Not Found: Glossary not found or access rights error |
|
500 |
Server Error: An unknown internal error occurred |
POST /api/core/v1/common/glossaryEntries/perform
Perform actions on glossary entries
Description
Allows you to execute actions on glossary entries such as delete, copy to glossary, or move to glossary operations. Supports managing the lifecycle and organization of terminology entries.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
PimTypeDto |
OmnType with ActionsType containing glossary entry action details. For delete: specify dataType='glossaryEntry', id/tid, and type='delete'. For copy/move: also provide target glossaryId. 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 OmnType with ResponsesType containing statuses about each performed action on glossary entries |
|
400 |
Bad Request: Invalid input provided |
|
401 |
Unauthorized: Not authorized to access the endpoint |
|
404 |
Not Found: Glossary entry not found or access rights error |
|
500 |
Server Error: An unknown internal error occurred |
POST /api/core/v1/common/keywords/perform
Perform actions on keywords
Description
Allows you to execute actions on keywords such as delete, move, or copy operations. Supports batch operations on multiple keywords with proper error handling.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
PimTypeDto |
PimType with ActionsType containing keyword action details. Specify keyword identifiers and action types for operations like delete, move, or copy. 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 statuses about each performed action on keywords |
|
400 |
Bad Request: Invalid input provided |
|
401 |
Unauthorized: Not authorized to access the endpoint |
|
404 |
Not Found: Keyword not found or access rights error |
|
500 |
Server Error: An unknown internal error occurred |
POST /api/core/v1/common/glossaries/persist
Create or update glossaries
Description
Allows you to create new glossaries or update existing ones. This endpoint provides a flexible way to manage glossary information including metadata and attribute values.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
PimTypeDto |
OmnType with GlossariesType for glossary operations. For creation: specify name and optional metadata. For updates: provide ID/TID with new values. 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 OmnType with ResponsesType containing statuses about each persisted glossary |
|
400 |
Bad Request: Invalid input provided |
|
401 |
Unauthorized: Not authorized to access the endpoint |
|
404 |
Not Found: The requested resource could not be found |
|
500 |
Server Error: An unknown internal error occurred |
POST /api/core/v1/common/glossaryEntries/persist
Create or update glossary entries
Description
Allows you to create new glossary entries or update existing ones. This endpoint provides a flexible way to manage terminology entries including terms and sentences with multilingual links and metadata.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
PimTypeDto |
PimType with GlossaryEntriesType for entry operations. For creation: specify parentId/parentTid, locale, type, and value. For updates: provide entry ID/TID with new values. 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 statuses about each persisted glossary entry |
|
400 |
Bad Request: Invalid input provided |
|
401 |
Unauthorized: Not authorized to access the endpoint |
|
404 |
Not Found: The requested resource could not be found |
|
500 |
Server Error: An unknown internal error occurred |
POST /api/core/v1/common/keywords/persist
Create or update keywords
Description
Allows you to create new keywords or update existing ones in the keyword hierarchy. Supports creating keyword structures with localized names and organizing keywords in taxonomies.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
PimTypeDto |
PimType with KeywordsType for keyword operations. Specify keyword path, name, and optional localized names for creation or updates. 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 statuses about each persisted keyword |
|
400 |
Bad Request: Invalid input provided |
|
401 |
Unauthorized: Not authorized to access the endpoint |
|
404 |
Not Found: Referenced parent keyword not found |
|
500 |
Server Error: An unknown internal error occurred |
POST /api/core/v1/common/links/persist
Create links
Description
Create relationships between OMN objects such as assets and products. Supports flexible linking scenarios including single-to-single, one-to-many, many-to-one, and many-to-many relationships with both TID and ID-based identification.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
PimTypeDto |
PimType with LinksType containing asset-to-product relationships. Supports various linking patterns: single asset to single product, multiple assets to single product, single asset to multiple products, or multiple assets to multiple products. 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 statuses about each created link |
|
400 |
Bad Request: Invalid input provided |
|
401 |
Unauthorized: Not authorized to access the endpoint |
|
404 |
Not Found: Referenced asset, product, or attribute not found |
|
500 |
Server Error: An unknown internal error occurred |
POST /api/core/v1/common/messages/persist
Send messages to users and/or groups
Description
Allows you to send messages to users and/or groups within the system. This endpoint provides a way to communicate notifications, alerts, and other information to specific recipients. If both user and role are specified, the role has precedence.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
MessagesPersistRequestDto |
MessagesPersistRequest with an array of message objects. Each message must specify either recipientUser or recipientRole (or both). Required fields: subject and body. Optional: tid, severity, senderApplication, senderPlugin, and parameters. MessagesPersistRequestDto |
X |
POST /api/core/v1/common/components/retrieve
Retrieve a list of components
Description
Retrieve the status of enabled OMN components in the system. This endpoint provides real-time information about which components are active or inactive, useful for system monitoring, diagnostics, and configuration validation.
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success: Returns a map of component names and their statuses (active/inactive) |
Map[[string]] |
400 |
Bad Request: Invalid input provided |
|
401 |
Unauthorized: Not authorized to access the endpoint |
|
404 |
Not Found: The requested resource could not be found |
|
500 |
Server Error: An unknown internal error occurred |
POST /api/core/v1/common/glossaries/retrieve
Retrieve glossaries with optional filtering
Description
Allows you to fetch a list of glossaries based on specified parameters. Glossaries contain terms and sentences that can be used for localization and terminology management. Supports filtering by names, IDs, and locales.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
GlossaryRequestDto |
GlossaryRequest with optional parameters: names/ids for specific glossaries, retrieveLinks for including entries, sourceLocales/targetLocales for language filtering. GlossaryRequestDto |
- |
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 list of glossaries and their metadata |
|
400 |
Bad Request: Invalid input provided |
|
401 |
Unauthorized: Not authorized to access the endpoint |
|
404 |
Not Found: The requested resource could not be found |
|
500 |
Server Error: An unknown internal error occurred |
POST /api/core/v1/common/keywords/retrieve
Retrieve keywords by path
Description
Allows you to retrieve keywords by a specified path. This endpoint provides a flexible way to navigate and explore hierarchical keyword structures with optional level control and linked asset retrieval.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
KeywordRequestDto |
KeywordRequest with path parameter and optional level (default 1, -1 for all levels) and retrieveLinks flag for including linked assets. KeywordRequestDto |
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 list of keywords and their metadata |
|
400 |
Bad Request: Invalid input provided |
|
401 |
Unauthorized: Not authorized to access the endpoint |
|
404 |
Not Found: The requested resource could not be found |
|
500 |
Server Error: An unknown internal error occurred |
POST /api/core/v1/common/locales/retrieve
Retrieve locales by mode or identifiers
Description
Allows you to retrieve locales (language settings) by mode, IDs, or identifiers. This endpoint provides a flexible way to access language configuration information with options for all locales, content locales, frontend locales, or specific locales by ID/TID.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
LocaleRequestDto |
LocaleRequest with mode parameter (ALL, CONTENT, FRONTEND, ID, or TID) and optional ids/tids arrays. If mode is ID, provide ids array. If mode is TID, provide tids array. ExportConfig flag controls configuration information inclusion. LocaleRequestDto |
X |
Content Type
-
application/xml;charset=UTF-8
-
application/json;charset=UTF-8
-
application/json+compact;charset=UTF-8
POST /api/core/v1/common/links/bulk
POST /api/core/v1/common/keywords/bulk
POST /api/core/v1/common/glossaryEntries/bulk
POST /api/core/v1/common/glossaries/bulk
POST /api/core/v1/common/transform
Transform PimType in different formats
Description
Transform data between different API formats (XML, JSON, Compact JSON) while preserving content. The source format is specified by Content-Type header and target format by Accept header. Essential for system interoperability and supporting different client application requirements.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
PimTypeDto |
PimType data in source format (XML, JSON, or Compact JSON). The format is determined by the Content-Type header. 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 the same data transformed into the target format specified by the Accept header |
|
400 |
Bad Request: Invalid input format, malformed data, or unsupported Content-Type/Accept headers |
|
500 |
Internal Server Error: An unknown internal error occurred during transformation |
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 |
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 |
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} |
GlossaryRequestDto
Request object for retrieving glossary information and terms
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
names |
List of [string] |
The names of the glossaries to retrieve |
|||
ids |
List of [long] |
The ids of the glossaries to retrieve |
int64 |
||
retrieveEntries |
Boolean |
It defines whether the contained entries (terms and sentences) should be included in the response |
|||
sourceLocales |
List of [string] |
Limits the source languages to the specified list of locales. Default: empty array which means all languages |
|||
targetLocales |
List of [string] |
Limits the target languages to the specified list of locales. Default: empty array which means all languages |
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 |
KeywordRequestDto
Request object for retrieving keyword hierarchy with optional linked items
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
path |
String |
A keyword path |
|||
level |
Integer |
It defines how many level should be loaded. Default value is 1. -1 means to load all levels. 0 is invalid value |
int32 |
||
retrieveLinks |
Boolean |
It defines whether linked to keyword items should be retrieved or not |
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 |
LocaleRequestDto
Request object for retrieving locale information
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
ids |
List of [long] |
Locale ids |
int64 |
||
tids |
List of [string] |
Locale identifiers. Each identifier consists of a language- and country-code separated by an underscore '_' |
|||
mode |
X |
Retrieve mode |
Enum: ID, TID, ALL, CONTENT, FRONTEND, |
||
exportConfig |
Boolean |
Option to retrieve locales with additional information. E.g. custom date formats |
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 |
MessageDto
Message object containing communication details and metadata
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
tid |
String |
The technical id of the message which can optionally be set by the client |
|||
id |
Long |
The internal system id of the message |
int64 |
||
creationDate |
Date |
The date when the message was persisted. |
date-time |
||
subject |
X |
String |
The subject of the message. |
||
body |
X |
String |
The main body text of the message. |
||
severity |
The severity level of the message. |
Enum: INFO, WARN, ERROR, |
|||
recipientUser |
String |
The name of the user this message is sent to. |
|||
recipientRole |
String |
The name of the role this message is sent to. |
|||
senderUser |
String |
The name of the user who sent this message. |
|||
senderApplication |
X |
String |
The name of the application who sent this message. |
||
senderPlugin |
X |
String |
The name of the plugin who sent this message. |
||
isRead |
Boolean |
Indicates if this message is read. |
|||
parameters |
Map of [string] |
Additional properties of this message. |
MessagesPersistRequestDto
Request object for persisting multiple message objects
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
messages |
List of MessageDto |
List of messages to be persisted |
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 |
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 |