Core API – PIM
Core API endpoints of the PIM module (Product Information Management): products, classifications, attributes 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
Pim
PUT /api/core/v1/pim/attributes/{id}/domain-value
Add a domain value to an attribute
Description
Adds a single value to the domain (the list of allowed values) of an attribute of type STRING, REAL or DATE. If the attribute has no domain rule of its own, the rule of its attribute definition is taken as the starting point and the extended rule is stored on the attribute. A value that is already part of the domain is not added again; the current domain is returned unchanged. Other attribute types are rejected with 400.
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success: Returns the resulting domain rule of the attribute as a JSON string - a plain array of the allowed values for STRING attributes, an object with type ARRAY and the ranges for REAL and DATE attributes |
|
400 |
Bad Request: The attribute type does not support domain values |
|
401 |
Unauthorized: Not authorized to access the endpoint |
|
404 |
Not Found: No attribute with the given identity |
|
500 |
Server Error: An unknown internal error occurred |
GET /api/core/v1/pim/attribute-definitions
Get attribute definitions
Description
Provides a simple way to retrieve information about all attribute definitions in the system. This endpoint uses a GET request method and requires no request parameters.
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 filled AttributeDefinitionsType containing all attribute definitions in the system |
|
401 |
Unauthorized: Not authorized to access the endpoint |
|
404 |
Not Found: Resource not found |
|
500 |
Server Error: An unknown internal error occurred |
GET /api/core/v1/pim/products/bulk/{id}
Get the result of a bulk product operation
Description
Returns the result of a bulk operation started with POST /api/core/v1/pim/products/bulk. While the operation is still running the response is 204 No Content; poll again after a delay. Once finished, the body is the PimType with ResponsesType that the synchronous endpoint would have returned, one response per processed product. 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 or a result that was evicted after the orphan timeout.
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; 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 |
GET /api/core/v1/pim/nodes/bulk/{id}
Get the result of a bulk classification node operation
Description
Returns the result of a bulk operation started with POST /api/core/v1/pim/nodes/bulk. While the operation is still running the response is 204 No Content; poll again after a delay. Once finished, the body is the PimType with ResponsesType that the synchronous endpoint would have returned, one response per processed classification node. 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 or a result that was evicted after the orphan timeout.
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; 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 |
GET /api/core/v1/pim/classes/bulk/{id}
Get the result of a bulk classification operation
Description
Returns the result of a bulk operation started with POST /api/core/v1/pim/classes/bulk. While the operation is still running the response is 204 No Content; poll again after a delay. Once finished, the body is the PimType with ResponsesType that the synchronous endpoint would have returned, one response per processed classification. 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 or a result that was evicted after the orphan timeout.
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; 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 |
GET /api/core/v1/pim/attributes/bulk/{id}
Get the result of a bulk attribute operation
Description
Returns the result of a bulk operation started with POST /api/core/v1/pim/attributes/bulk. While the operation is still running the response is 204 No Content; poll again after a delay. Once finished, the body is the PimType with ResponsesType that the synchronous endpoint would have returned, one response per processed attribute. 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 or a result that was evicted after the orphan timeout.
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; 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 |
GET /api/core/v1/pim/attribute-definitions/bulk/{id}
Get the result of a bulk attribute definition operation
Description
Returns the result of a bulk operation started with POST /api/core/v1/pim/attribute-definitions/bulk. While the operation is still running the response is 204 No Content; poll again after a delay. Once finished, the body is the PimType with ResponsesType that the synchronous endpoint would have returned, one response per processed attribute definition. 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 or a result that was evicted after the orphan timeout.
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; 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 |
GET /api/core/v1/pim/classes
get classes
Description
Allows you to retrieve a list of all classifications in the Product Information Management (PIM) system. Classifications are used to categorize and organize products, assets, and other entities in a hierarchical structure.
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 XML data with the list of classifications including identifiers, names, descriptions, and hierarchical structure information |
|
401 |
Unauthorized: Not authorized to access classifications |
|
404 |
Not Found: Classifications resource not found |
|
500 |
Server Error: An unknown internal error occurred |
GET /api/core/v1/pim/attributes/{node}
Get the attributes of a classification node
Description
Returns the attributes assigned to a classification node, including their attribute definitions, domain values and default values. The node is addressed by its path; a path that contains slashes is served by the wildcard variant GET /pim/attributes/** of this endpoint (for example GET /pim/attributes/Classification/node), so the path separator does not need to be encoded. Table attributes are included unless ignore-table-attributes=true.
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success: Returns the attributes of the node |
|
401 |
Unauthorized: Not authorized to access the endpoint |
|
403 |
Forbidden: No access to the endpoint |
|
404 |
Not Found: No classification node with the given path |
|
500 |
Server Error: An unknown internal error occurred |
GET /api/core/v1/pim/attributes/**
Get the attributes of a classification node (path with slashes)
Description
Variant of GET /pim/attributes/{node} for node paths that contain slashes: everything after /pim/attributes/ is taken as the node path, for example GET /pim/attributes/Classification/node/node1. Returns the same result as GET /pim/attributes/{node}.
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success: Returns the attributes of the node |
|
401 |
Unauthorized: Not authorized to access the endpoint |
|
403 |
Forbidden: No access to the endpoint |
|
404 |
Not Found: No classification node with the given path |
|
500 |
Server Error: An unknown internal error occurred |
POST /api/core/v1/pim/data-items/{id}/tree
Get data item with its parent and children by identity
Description
Retrieve a data item by its unique identifier along with its hierarchical context including parent and children elements. This endpoint provides detailed information about the data item structure and relationships.
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success: Data item found and returned with its hierarchical context |
|
401 |
Unauthorized: Not authorized to access the data item |
|
404 |
Not Found: Data item with the specified ID does not exist |
|
500 |
Server Error: An internal server error occurred while retrieving the data item |
POST /api/core/v1/pim/data-items/get-by-ids
Get several data items by ids
Description
Retrieve multiple data items by providing a list of identifiers. This endpoint allows batch retrieval of data items with optional filtering of table attributes.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
DataItemGetByIdsRequestDto |
Request containing a list of data item IDs to retrieve. The request must include at least one valid ID for the operation to succeed. DataItemGetByIdsRequestDto |
X |
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success: Data items found and returned. The states list carries one entry per requested identity, so a missing or inaccessible item is reported there while the found items are returned in results. |
|
400 |
Bad Request: Invalid input provided, such as malformed request body or invalid IDs |
|
401 |
Unauthorized: Not authorized to access the data items |
|
500 |
Server Error: An internal server error occurred while retrieving the data items |
POST /api/core/v1/pim/attribute-definitions/perform
Perform a list of attribute definitions
Description
Allows you to execute actions on attribute definitions. Currently supports the delete action, which removes attribute definitions from the system.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
PimTypeDto |
PimType with ActionsType containing action details. The action requires the attribute definition ID or identifier (tid or id) to be specified in the action attributes. Provide only one identifier per action. 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 attribute definitions |
|
400 |
Bad Request: Invalid input provided |
|
401 |
Unauthorized: Not authorized to access the endpoint |
|
404 |
Not Found: Requested attribute definition not found |
|
500 |
Server Error: An unknown internal error occurred |
POST /api/core/v1/pim/attributes/perform
Perform a list of attributes
Description
Allows you to execute actions on attribute definitions. Currently supports the delete action, which removes attribute definitions from the system.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
PimTypeDto |
PimType with ActionsType containing action details. The action requires the attribute ID to be specified in the action attributes for delete operations. 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 attributes |
|
400 |
Bad Request: Invalid input provided, such as missing required attribute ID |
|
401 |
Unauthorized: Not authorized to access the endpoint |
|
404 |
Not Found: Requested attribute not found |
|
500 |
Server Error: An unknown internal error occurred during the action |
POST /api/core/v1/pim/classes/perform
Perform actions for classifications
Description
Allows you to execute actions on classifications. Currently supports the delete action, which removes classifications and their associated classification nodes with attributes from the system.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
PimTypeDto |
PimType with ActionsType containing action details. Must provide either 'tid' (transaction ID) or 'id' for classification identification. Actions are performed by TID if both are present. 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 action performed on the classification |
|
400 |
Bad Request: Invalid input provided, such as missing required identifiers or wrong data type |
|
401 |
Unauthorized: Not authorized to access the endpoint |
|
404 |
Not Found: Requested classification not found by the provided ID or TID |
|
500 |
Server Error: An unknown internal error occurred during the action |
POST /api/core/v1/pim/nodes/perform
Perform actions with PIM classification node
Description
Allows you to execute actions on classification nodes. Currently supports the delete action to remove classification nodes from the system.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
PimTypeDto |
PimType with ActionsType containing action details. ActionType's type must be 'delete' and dataType must be 'classNode'. Node identification via either ID or path is required. 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 filled ResponsesType containing status information about each action performed |
|
400 |
Bad Request: Invalid input provided, such as missing required parameters or invalid node identification |
|
401 |
Unauthorized: User doesn't have permission to access the nodes perform API |
|
500 |
Server Error: An unknown internal error occurred during the delete operation |
POST /api/core/v1/pim/products/perform
Perform a list of product actions
Description
Execute actions on products: delete, copy and move. A move action re-links the product to the classification node given in the action meta (nodePath or nodeId); the product is unlinked from every other node of the same classification first, so a product is linked to exactly one node per classification after the move.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
PimTypeDto |
PimType with ActionsType containing actions to perform on products. Supported action types are delete, copy and move; the product is addressed by tid or id. copy takes newProductName (required) and newProductTid in the action meta, move takes nodePath or nodeId of the target classification node. PimTypeDto |
X |
Content Type
-
application/xml;charset=UTF-8
-
application/json;charset=UTF-8
-
application/json+compact;charset=UTF-8
POST /api/core/v1/pim/products/links/perform
Perform a list of product links actions
Description
Execute actions on product links. Currently supports the 'unlink' action, which removes the relationship between products.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
PimTypeDto |
PimType with ActionsType containing link actions to perform. The action requires additional information provided in MetaType in key/value format. PimTypeDto |
X |
Content Type
-
application/xml;charset=UTF-8
-
application/json;charset=UTF-8
-
application/json+compact;charset=UTF-8
POST /api/core/v1/pim/attribute-definitions/persist
Persist a list of attribute definitions
Description
Allows you to create and update attribute definitions. This endpoint provides functionality to define new attributes and modify existing ones with localized names.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
PimTypeDto |
PimType with filled AttributeDefinitionsType. The structure includes the attribute definition's identifier (tid), type, and localized names. Handles both creation and update operations automatically. 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 attribute definition |
|
400 |
Bad Request: Invalid input provided |
|
401 |
Unauthorized: Not authorized to access the endpoint |
|
404 |
Not Found: Requested attribute definition not found |
|
500 |
Server Error: An unknown internal error occurred |
POST /api/core/v1/pim/attributes/persist
Persist a list of attributes
Description
Allows you to save node attribute information. Provides functionality to create new attributes and update existing attribute values for classification nodes.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
PimTypeDto |
PimType with AttributesType. For creating attributes, specify either nodePath or nodeId. For updating, use attribute id, or nodeId/nodePath with attribute key. Attribute key refers to the attribute definition value. 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 attribute |
|
400 |
Bad Request: Invalid input provided, such as missing required node identifiers or invalid attribute configurations |
|
401 |
Unauthorized: Not authorized to access the endpoint |
|
404 |
Not Found: Requested attribute or node not found |
|
500 |
Server Error: An unknown internal error occurred during persistence operation |
POST /api/core/v1/pim/nodes/persist
Create or update classification nodes
Description
Allows you to save classification node structures. Provides functionality to create new nodes (both root nodes and child nodes) and update existing nodes. Multiple nodes can be persisted in a single request.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
PimTypeDto |
PimType with ClassificationNodesType. For creating nodes, specify parent node (parentId or parentPath) and node identifier (tid). For root nodes, specify classificationTid. For updating, identify node using path or ID. 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 responses containing statuses about each persisted node |
|
400 |
Bad Request: Invalid input provided, such as missing required parameters or invalid node structure |
|
401 |
Unauthorized: User doesn't have permission to access the endpoint |
|
403 |
Access Forbidden: This API is restricted for users without admin role. Only users with administrative privileges can access this endpoint |
|
500 |
Server Error: Returns error details in ResponseType, such as parent node not found or classification not found |
POST /api/core/v1/pim/classes/persist
Persist a list of classifications
Description
Allows you to save classifications and classification nodes with their attributes. Provides functionality to create new classifications, update existing ones, and manage the hierarchical structure of classification nodes.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
PimTypeDto |
PimType with ClassificationsType and optionally ClassificationNodesType. For new classifications, root node name must match classification name. Nodes are processed in the order specified. 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 classification |
|
400 |
Bad Request: Invalid input provided, such as root node name mismatch or invalid language codes |
|
401 |
Unauthorized: Not authorized to access the endpoint |
|
404 |
Not Found: Classification not found when attempting to update non-existent classification |
|
500 |
Server Error: An unknown internal error occurred during persistence operation |
POST /api/core/v1/pim/products/persist
Persist a list of products
Description
Save product information and product attribute details. This endpoint provides functionality to create new products, rename existing products, and update product attribute values.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
PimTypeDto |
PimType with ProductsType containing product data to persist. Only provided attribute values are persisted; other values not included in the request will remain unchanged. PimTypeDto |
X |
Content Type
-
application/xml;charset=UTF-8
-
application/json;charset=UTF-8
-
application/json+compact;charset=UTF-8
POST /api/core/v1/pim/products/links/persist
Persist a list of product links
Description
Create links between products. This endpoint provides functionality to establish relationships between products, enabling you to connect related items in various configurations.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
PimTypeDto |
PimType with LinksType containing product linking information. Supports various linking scenarios including single-to-single, multiple-to-single, single-to-multiple, and multiple-to-multiple product relationships. PimTypeDto |
X |
Content Type
-
application/xml;charset=UTF-8
-
application/json;charset=UTF-8
-
application/json+compact;charset=UTF-8
POST /api/core/v1/pim/attribute-definitions/query
Query attribute definition IDs by criteria
Description
Allows you to retrieve attribute definition IDs based on specific criteria. Currently supports filtering attribute definitions by their types.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
AttributeDefinitionsQueryRequestDto |
AttributeDefinitionsQueryRequest with filtering criteria. Currently supports filtering by types array containing attribute definition types (text, date, number, boolean, ref, table). AttributeDefinitionsQueryRequestDto |
X |
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success: Returns AttributeDefinitionsRequest with attribute definition IDs that match the specified criteria |
|
400 |
Bad Request: Invalid input provided |
|
401 |
Unauthorized: Not authorized to access the endpoint |
|
500 |
Server Error: An unknown internal error occurred |
POST /api/core/v1/pim/attributes/query
Query a list of attribute ids
Description
Allows you to retrieve a list of attribute IDs based on various criteria. Provides a way to find attributes associated with specific products or classification nodes.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
AttributesQueryRequestDto |
AttributesQueryRequest object with one query parameter: productId, productTid, nodeId, or nodePath arrays. Include includeParentAttributes flag to retrieve inherited attributes for node-based queries. AttributesQueryRequestDto |
X |
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success: Returns AttributesRequest object containing array of attribute IDs that match the query criteria |
|
400 |
Bad Request: Invalid input provided in query parameters |
|
401 |
Unauthorized: Not authorized to access the endpoint |
|
404 |
Not Found: Requested resources not found |
|
500 |
Server Error: An unknown internal error occurred during the query operation |
POST /api/core/v1/pim/nodes/query
Finds identities by parameter
Description
Allows you to retrieve classification node IDs based on various criteria. Provides a way to find nodes associated with specific products or attributes.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
NodesQueryRequestDto |
NodesQueryRequest object with one query parameter: productId, productTid, attributeDefinitionId, attributeDefinitionTid, or attributeId to find associated classification nodes. NodesQueryRequestDto |
X |
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success: Returns NodesRequest object containing array of node IDs that match the query criteria and associated level value |
|
400 |
Bad Request: Invalid input provided, such as missing or invalid query parameters |
|
401 |
Unauthorized: User doesn't have permission to access this endpoint (admin role required) |
|
500 |
Server Error: An unknown internal error occurred during the query operation |
POST /api/core/v1/pim/products/query
Query a list of product ids
Description
Retrieve product transaction IDs (TIDs) based on specific search criteria. This endpoint provides a flexible way to find products that match certain conditions without retrieving the full product data. The modification interval (modifiedFrom/modifiedUntil) is matched against both the modificationDate of the product object and its valueModificationDate (last change of an attribute value) with a logical OR, so a product is found if either timestamp lies within the interval. When nodePaths is set, only products linked directly to one of the given classification nodes are returned; articles and variants are never part of such a result because only products are linked to classification nodes. A query by modification date without nodePaths can also return modified articles and variants. searchStrategy names the strategy bean; defaultSearchStrategy is the only implementation shipped with OMN, so the parameter can be left empty. At least one of the modification bounds or nodePaths must be given.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
ProductQueryDto |
Product query containing search criteria: modification interval (modifiedFrom/modifiedUntil, each matched against modificationDate or valueModificationDate), classification node paths and search strategy. All given criteria are combined using the AND operator. ProductQueryDto |
X |
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success: Returns found product TIDs |
|
400 |
Bad Request: Invalid input error |
|
401 |
Not authorized |
|
404 |
Not found |
|
500 |
Server Error: Returns error details in ResponseType |
|
504 |
Gateway Timeout: the query did not finish within the timeout of a proxy or load balancer in front of OMN, typically under load or for queries that match very many products. The query keeps running on the server after the 504, so do not retry immediately: retry with exponential backoff and narrow the query (shorter modification interval, fewer node paths). |
POST /api/core/v1/pim/attribute-definitions/retrieve
Retrieve attribute definitions
Description
Allows you to fetch detailed information about attribute definitions. You can retrieve attribute definitions by their IDs, TIDs (technical identifiers), or get all attribute definitions at once.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
AttributeDefinitionsRequestDto |
AttributeDefinitionsRequest with one of: ids, tids arrays, or all flag. If all=true, ids and tids are ignored. If both ids and tids are provided, ids are ignored. Only one retrieval strategy should be used per request. AttributeDefinitionsRequestDto |
X |
Content Type
-
application/xml;charset=UTF-8
-
application/json;charset=UTF-8
-
application/json+compact;charset=UTF-8
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success: Returns PimType with filled AttributeDefinitionsType containing the requested attribute definitions |
|
400 |
Bad Request: Invalid input provided |
|
401 |
Unauthorized: Not authorized to access the endpoint |
|
404 |
Not Found: Requested attribute definitions not found |
|
500 |
Server Error: An unknown internal error occurred |
POST /api/core/v1/pim/attributes/retrieve
Retrieve a list of attributes
Description
Allows you to retrieve detailed information about attributes. Provides functionality to get attribute data based on various identifiers, with options to include domain values, default values, and inherited attributes.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
AttributesRetrieveRequestDto |
AttributesRetrieveRequest object with one of: ids, productIds, productTids, nodeIds, or nodePaths arrays. Include withDomainValues, withDefaultValues, and includeParentAttributes flags as needed. Only one input parameter should be specified per request. AttributesRetrieveRequestDto |
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 filled AttributesType containing detailed information about the requested attributes |
|
400 |
Bad Request: Invalid input provided in request parameters |
|
401 |
Unauthorized: Not authorized to access the endpoint |
|
404 |
Not Found: Requested resources not found |
|
500 |
Server Error: An unknown internal error occurred during retrieval |
POST /api/core/v1/pim/classes/retrieve
retrieve classifications
Description
Allows you to retrieve information about classifications, optionally including their nodes and node attributes. Provides flexibility in how classification data is returned, supporting both flat and hierarchical node structures.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
ClassificationRequestDto |
ClassificationRequest object with optional arrays of IDs or TIDs. Include 'withNodes' flag to retrieve nodes, and 'flatNodes' to control structure. Empty request returns all classifications. ClassificationRequestDto |
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 filled ClassificationsType. Structure varies based on request parameters (with/without nodes, flat/hierarchical) |
|
400 |
Bad Request: Invalid input provided in the request parameters |
|
401 |
Unauthorized: Not authorized to access the endpoint |
|
404 |
Not Found: Requested classifications not found |
|
500 |
Server Error: An unknown internal error occurred during retrieval |
POST /api/core/v1/pim/nodes/retrieve
get classification nodes
Description
Allows you to retrieve classification node structures with their attributes. Provides functionality to get root nodes, children of specific nodes, or nodes by their IDs.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
NodesRequestDto |
NodesRequest object with classification identifier (classificationId or classificationTid) for root nodes, path and level for children, or array of node IDs for specific nodes. Level parameter must be greater than 0. NodesRequestDto |
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 filled ClassificationNodesType representing a flattened tree structure of the requested nodes |
|
400 |
Bad Request: Invalid input provided, such as missing required parameters or invalid level value (must be > 0) |
|
401 |
Unauthorized: User doesn't have permission to access this endpoint (admin role required) |
|
403 |
Access Forbidden: This API is restricted for users without admin role |
|
500 |
Server Error: Returns error details in ResponseType for various scenarios like missing parameters or invalid requests |
POST /api/core/v1/pim/products/retrieve
Retrieve a list of products
Description
Retrieve a list of product trees by their identifiers. This endpoint returns detailed information about products, including their articles, variations, attributes, and linked resources. The response is streamed: each product fragment is written as soon as it has been exported, so large exports arrive incrementally. Note that once streaming has started the HTTP status can no longer change - if the export fails mid-stream, the response body is a truncated (not well-formed) document; consumers should always parse the payload strictly to detect this. Keep the number of products per request moderate: large requests can run into the gateway timeout (504) of a proxy in front of OMN.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
ProductRequestDto |
Product request containing either product IDs or TIDs (transaction IDs) to retrieve the corresponding product trees. ProductRequestDto |
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: the product tree is streamed directly to the response body; once the first bytes have been flushed the status code can no longer change, so a failure mid-export leads to a truncated document. |
|
400 |
Invalid input |
|
401 |
Not authorized |
|
403 |
Forbidden: No access to the endpoint |
|
404 |
Not found |
|
500 |
Server Error: Returns error details in ResponseType |
|
504 |
Gateway Timeout: the response did not start within the timeout of a proxy or load balancer in front of OMN. This happens under load or for large requests whose export takes longer than that timeout. The request keeps running on the server after the 504 and continues to consume CPU, memory and database connections, so do not retry immediately: retry with exponential backoff and reduce the number of products per request, especially when the exported product trees are large. |
POST /api/core/v1/pim/products/bulk
Start a bulk product operation
Description
Starts an asynchronous bulk operation on products. The request body is the PimType accepted by POST /api/core/v1/pim/products/persist; if it contains an actions element, it is handled like POST /api/core/v1/pim/products/perform instead. The operation runs in the background and the response carries only the operation id (plain text); fetch the result with GET /api/core/v1/pim/products/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.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
PimTypeDto |
PimType with the same content as accepted by POST /api/core/v1/pim/products/persist or POST /api/core/v1/pim/products/perform. Without an actions element the products are persisted; with an actions element the actions are performed. 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/pim/products/bulk/{id}. |
|
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 |
POST /api/core/v1/pim/nodes/bulk
Start a bulk classification node operation
Description
Starts an asynchronous bulk operation on classification nodes. The request body is the PimType accepted by POST /api/core/v1/pim/nodes/persist; if it contains an actions element, it is handled like POST /api/core/v1/pim/nodes/perform instead. The operation runs in the background and the response carries only the operation id (plain text); fetch the result with GET /api/core/v1/pim/nodes/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.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
PimTypeDto |
PimType with the same content as accepted by POST /api/core/v1/pim/nodes/persist or POST /api/core/v1/pim/nodes/perform. Without an actions element the classification nodes are persisted; with an actions element the actions are performed. 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/pim/nodes/bulk/{id}. |
|
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 |
POST /api/core/v1/pim/classes/bulk
Start a bulk classification operation
Description
Starts an asynchronous bulk operation on classifications. The request body is the PimType accepted by POST /api/core/v1/pim/classes/persist; if it contains an actions element, it is handled like POST /api/core/v1/pim/classes/perform instead. The operation runs in the background and the response carries only the operation id (plain text); fetch the result with GET /api/core/v1/pim/classes/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.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
PimTypeDto |
PimType with the same content as accepted by POST /api/core/v1/pim/classes/persist or POST /api/core/v1/pim/classes/perform. Without an actions element the classifications are persisted; with an actions element the actions are performed. 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/pim/classes/bulk/{id}. |
|
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 |
POST /api/core/v1/pim/attributes/bulk
Start a bulk attribute operation
Description
Starts an asynchronous bulk operation on attributes. The request body is the PimType accepted by POST /api/core/v1/pim/attributes/persist; if it contains an actions element, it is handled like POST /api/core/v1/pim/attributes/perform instead. The operation runs in the background and the response carries only the operation id (plain text); fetch the result with GET /api/core/v1/pim/attributes/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.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
PimTypeDto |
PimType with the same content as accepted by POST /api/core/v1/pim/attributes/persist or POST /api/core/v1/pim/attributes/perform. Without an actions element the attributes are persisted; with an actions element the actions are performed. 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/pim/attributes/bulk/{id}. |
|
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 |
POST /api/core/v1/pim/attribute-definitions/bulk
Start a bulk attribute definition operation
Description
Starts an asynchronous bulk operation on attribute definitions. The request body is the PimType accepted by POST /api/core/v1/pim/attribute-definitions/persist; if it contains an actions element, it is handled like POST /api/core/v1/pim/attribute-definitions/perform instead. The operation runs in the background and the response carries only the operation id (plain text); fetch the result with GET /api/core/v1/pim/attribute-definitions/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.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
PimTypeDto |
PimType with the same content as accepted by POST /api/core/v1/pim/attribute-definitions/persist or POST /api/core/v1/pim/attribute-definitions/perform. Without an actions element the attribute definitions are persisted; with an actions element the actions are performed. 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/pim/attribute-definitions/bulk/{id}. |
|
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 |
PATCH /api/core/v1/pim/data-items
Update a data item
Description
Updates an existing product, article or variation (and, through children, its sub-items) from a DataItem tree. Every item of the tree is addressed by its tID and must exist; otherwise the whole request is rejected with 404. Only the attribute values contained in the request are written, values not included keep their current content. Attribute values the user may not edit are left unchanged according to the access rights of the API user. The result lists one entry per written item.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
DataItemDto |
DataItem with the tID of the item to update, optionally a new name and the attribute values to write; children may carry further items of the same shape. DataItemDto |
X |
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success: Data item updated; one result per written item |
|
400 |
Bad Request: Invalid input provided, such as malformed request body or invalid data |
|
401 |
Unauthorized: Not authorized to update the data item |
|
404 |
Not Found: Data item with the specified ID does not exist |
|
500 |
Server Error: An internal server error occurred while updating the data item |
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 |
AccessRightsDto
Access rights configuration defining visibility and editability permissions
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
visible |
Map of [boolean] |
Map of visibility permissions by field/resource identifier |
|||
editable |
Map of [boolean] |
Map of editability permissions by field/resource 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 |
AttributeDefinitionDto
Attribute Definition object contains the basic domain information and its limitations of a data item property. They are used to define further attributes of the data items (e.g. products).
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
tID |
String |
technical ID, identifying unique object. It's unique over all software systems around OMN. |
|||
type |
String |
Attribute definition type |
|||
domain |
String |
Domain specification for the attribute |
|||
meta |
List of ValueItemDto |
additional indirect information about attribute definition |
|||
name |
List of ValueItemDto |
Attribute definition name with localization |
|||
abbreviation |
Abbreviation for the attribute definition |
||||
tooltip |
Tooltip information for the attribute |
||||
defaultValue |
Default value configuration |
||||
multiValued |
Multi-value capability configuration |
||||
validation |
Validation rules for the attribute |
||||
domainValues |
Domain values configuration |
||||
domainRange |
Domain range configuration |
||||
tags |
List of TagDto |
Tags associated with the attribute definition |
|||
references |
List of [string] |
References to other objects |
AttributeDefinitionsQueryRequestDto
Object to fetch ids of attributeDefinitions that match a parameter. Query only for one group. [Find by types]
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
types |
List of [string] |
Filter parameter, a filter on types, array of discriminators to regard, e.g text. |
AttributeDefinitionsRequestDto
Request object for retrieving attribute definitions with optional bulk export
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
tids |
List of [string] |
Filter parameter, attribute definitions TIDs, identifying unique objects. |
|||
ids |
List of [long] |
Filter parameter, attribute definitions IDs, identifying unique objects. |
int64 |
||
all |
Boolean |
True if all attribute definitions should be exported. |
AttributeDefinitionsTypeDto
Container for attribute definition collections with type classification
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
attrDef |
List of AttrDefinitionTypeDto |
List of attribute definition objects |
|||
type |
String |
Attribute type classification |
AttributeDto
Attribute object contains the domain information and its limitations about data in data items (e.g. in products or assets). This object also implies information about its attribute definition.
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
id |
Long |
Attribute identity |
int64 |
||
key |
String |
Attribute key identifier |
|||
level |
String |
Attribute level in the hierarchy |
|||
inheritance |
String |
Inheritance behavior of the attribute |
|||
restriction |
String |
Access restriction settings for the attribute |
|||
localized |
Boolean |
Whether the attribute supports localization |
|||
cardinality |
Integer |
Maximum number of values allowed for this attribute |
int32 |
||
option |
String |
Attribute option settings |
|||
defaultValue |
Default value configuration for the attribute |
||||
domainValue |
Domain values configuration for the attribute |
||||
domainRange |
Domain range configuration for the attribute |
||||
definition |
Attribute definition containing detailed metadata |
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 |
AttributeValueDto
Value of an attribute containing items, internationalization, tags, and metadata
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
items |
List of ValueItemDto |
List of value items for this attribute |
|||
i18N |
List of I18NValueDto |
Internationalization values for this attribute |
|||
tags |
List of TagDto |
Tags associated with this attribute value |
|||
key |
String |
Attribute key identifier |
|||
type |
String |
Attribute type |
|||
origin |
String |
Origin of the attribute value |
|||
inheritance |
Boolean |
Whether this attribute value is inherited |
|||
parent |
String |
Parent attribute identifier |
|||
node |
String |
Node where this attribute value is defined |
|||
dataType |
String |
Data type of the attribute value |
|||
accessRights |
Access rights configuration for this attribute value |
AttributesDto
Container for a collection of attribute definitions and results
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
results |
List of AttributeDto |
List of attribute definitions or results |
AttributesQueryRequestDto
Object to fetch ids of attributes that match parameters. Use 'productId' to query product attributes by product id, 'productTid' to query product attributes by product tid, 'nodeId' to query node attributes by node id, 'nodePath' to query node attributes by node path
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
productId |
Long |
Filter parameter, product id |
int64 |
||
productTid |
String |
Filter parameter, product tid |
|||
nodeId |
Long |
Filter parameter, node id |
int64 |
||
nodePath |
String |
Filter parameter, node path |
|||
includeParentAttributes |
Boolean |
True if inherited attributes should be included, default value is false for querying by nodeId or nodePath. Querying by productTid or productId is always with inherited attributes and this parameter is ignored |
AttributesRequestDto
Request object for retrieving attribute information
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
ids |
List of [long] |
Filter parameter, attribute IDs, identifying unique objects. |
int64 |
AttributesRetrieveRequestDto
Request object for retrieving detailed attribute information with optional domain values and defaults
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
ids |
List of [long] |
Filter parameter, attribute IDs, identifying unique objects. |
int64 |
||
productIds |
List of [long] |
Filter parameter, product IDs, identifying unique objects. |
int64 |
||
productTids |
List of [string] |
Filter parameter, product TIDs, identifying unique objects. |
|||
nodeIds |
List of [long] |
Filter parameter, node IDs. |
int64 |
||
nodePaths |
List of [string] |
Filter parameter, node paths. |
|||
includeParentAttributes |
Boolean |
True if inherited attributes should be included, default value is false for querying by nodeId or nodePath. Querying by productTid or productId is always with inherited attributes and this parameter is ignored |
|||
withDomainValues |
Boolean |
Whether to include domain values in the response |
|||
withDefaultValues |
Boolean |
Whether to include default values in the response |
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 |
ClassificationRequestDto
Request object for retrieving classification information with optional node structures
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
tids |
List of [string] |
Filter parameter, classifications TIDs, identifying unique objects. |
|||
ids |
List of [long] |
Filter parameter, classifications IDs, identifying unique objects. |
int64 |
||
withNodes |
Boolean |
True if node elements should be added, default is false. |
|||
flatNodes |
Boolean |
True if classification nodes structure should be flat, default is true. |
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 |
DataItemDto
Data Item object contains the data item object itself (e.g. Product, Article, Variation for PIM, assets for MAM, etc.) and the whole its hierarchy of related objects (parent and children items, if any). Attribute values of the data items are included.
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
tID |
String |
technical ID, identifying unique object. It's unique over all software systems around OMN. |
|||
name |
String |
name of the data item |
|||
informationType |
String |
type of the data item (e.g. Product, Article, Variation, Asset, etc.) |
|||
node |
String |
name of the node, where data item is stored |
|||
class |
String |
name of data item classification |
|||
meta |
List of ValueItemDto |
additional indirect information about data item |
|||
values |
List of AttributeValueDto |
attribute values associated with this data item |
|||
children |
List of DataItemDto |
child data items in the hierarchy |
DataItemGetByIdsRequestDto
Request object for retrieving data items by their unique identifiers
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
identities |
List of [string] |
List of unique identifiers for data items to retrieve |
DataItemPatchResponseDto
Response DTO for data item patch operations containing results
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
results |
List of DataItemPatchResponseItemDto |
List of individual patch operation results |
DataItemPatchResponseItemDto
Individual result item for data item patch operation
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
status |
String |
Status of the patch operation (e.g., SUCCESS, ERROR) |
|||
description |
String |
Description of the patch operation result |
|||
dataType |
String |
Type of data being patched |
|||
tID |
String |
Transaction ID of the patch operation |
|||
action |
String |
Action performed during the patch operation |
DataItemsResponseDto
Response containing data items with metadata and state information
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
meta |
Metadata information about used formats |
||||
results |
List of DataItemDto |
List of data item results |
|||
states |
List of DataItemsResponseStatesDto |
List of state information for data items |
DataItemsResponseIssuesDto
Issue information from data item responses including error codes and descriptions
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
code |
String |
Error or issue code |
|||
description |
String |
Human-readable description of the issue |
|||
content |
List of ValueItemDto |
Additional content related to the issue |
DataItemsResponseMetaDto
Metadata information about used formats and patterns for data display
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
numberFormatLocale |
String |
Locale used for number formatting |
|||
numberFormatPattern |
String |
Pattern used for number formatting |
|||
datePattern |
String |
Pattern used for date formatting |
DataItemsResponseStatesDto
State information for products/data items including status and issues
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
status |
String |
Current status of the data item |
|||
dataType |
String |
Type of the data item |
|||
tid |
String |
Technical identifier of the data item |
|||
issues |
List of DataItemsResponseIssuesDto |
List of issues related to this data item |
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 |
DomainRangeDto
Describes the range limitations of an attribute
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
from |
String |
Lower bound of the range |
|||
to |
String |
Upper bound of the range |
|||
intOnly |
Boolean |
Whether only integer values are allowed within the range |
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 |
DomainValuesDto
Describes the domain values and their behaviour
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
allowNewValue |
Boolean |
Whether new values are allowed beyond the predefined domain values |
|||
sortDirection |
String |
Sort direction for the domain values |
|||
sortLanguageId |
Long |
Language by which sorting is applied |
int64 |
||
domainValues |
List of ValueCollectionDto |
List of predefined domain values |
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 |
I18NValueDto
Internationalized value items of an attribute value
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
items |
List of ValueItemDto |
List of value items for this locale |
|||
locale |
String |
Locale identifier for the internationalized values |
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 |
MultiValuedDto
Shows whether an attribute is multivalued
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
value |
Boolean |
Whether the attribute allows multiple values |
|||
cardinality |
Integer |
Maximum number of values allowed |
int32 |
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 |
NodesQueryRequestDto
Object to fetch ids of nodes that match a parameter. Query only for one group. [Find by product] Query only by one parameter from the group. [Find by attribute] Query only by one parameter from the group.
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
productTid |
String |
[Find by product] Product tid to find related node |
|||
productId |
Long |
[Find by product] Product id to find related node |
int64 |
||
attributeDefinitionTid |
String |
[Find by attribute] attribute definition tid to find related nodes |
|||
attributeDefinitionId |
Long |
[Find by attribute] attribute definition id to find related nodes |
int64 |
||
attributeId |
Long |
[Find by attribute] attribute id to find related node |
int64 |
NodesRequestDto
Allows to retrieve node by path with depth level, or nodes by ids: Use Classification identifier to get a root node, Use 'path' and 'level' to get children of the node, Use 'ids' to get specified nodes
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
path |
String |
Node path |
|||
level |
Integer |
Depth level to get more children nodes |
int32 |
||
classificationId |
Long |
Classification identity to retrieve a root node of the classification |
int64 |
||
classificationTid |
String |
Classification identifier to retrieve a root node of the classification |
|||
ids |
List of [long] |
Nodes identities to retrieve |
int64 |
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 |
ProductQueryDto
Query object for product filtering with modification dates, node paths, and search strategy
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
modifiedFrom |
String |
Filter parameter, lower bound of the modification interval (ISO 8601 date-time). Combined with modifiedUntil using a logical AND. The interval is matched against the modificationDate of the product object and against its valueModificationDate (last change of an attribute value) using a logical OR: a product is returned if either timestamp lies within the interval. |
|||
modifiedUntil |
String |
Filter parameter, upper bound of the modification interval (ISO 8601 date-time). Combined with modifiedFrom using a logical AND and matched against both modificationDate and valueModificationDate with a logical OR, see modifiedFrom. |
|||
nodePaths |
List of [string] |
Filter parameter, paths of the classification nodes (separator /). Restricts the result to products that are linked directly to one of these nodes. Only products are linked to classification nodes, so articles and variants are never part of the result when this filter is set; a query that filters by modification date alone can also return articles and variants. |
|||
searchStrategy |
String |
Bean name of the search strategy. defaultSearchStrategy is the only implementation shipped with OMN and is used when the parameter is empty. |
ProductRequestDto
Request object for retrieving product information
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
tids |
List of [string] |
Filter parameter, data item TIDs, identifying unique objects. The value of this parameter will be preferred over ids. |
|||
ids |
List of [long] |
Filter parameter, data item IDs, identifying unique objects. The value of this parameter will be preferred over nodePaths. |
int64 |
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 |
TagDto
Tag object with technical identifier
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
tID |
String |
Technical ID, identifying unique object. It's unique over all software systems around OMN. |
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 |
ValidationDto
Describes limitations of an attribute
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
type |
String |
Validation type |
|||
minLength |
Integer |
Minimum length constraint |
int32 |
||
maxLength |
Integer |
Maximum length constraint |
int32 |
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 |
ValueCollectionDto
Describes the concrete identified collection of values
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
tID |
String |
Technical ID, identifying unique object. It's unique over all software systems around OMN. |
|||
items |
List of ValueItemDto |
List of value items in the collection |
ValueItemDto
The value of an attribute itself with additional meta properties
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
value |
String |
The actual value content |
|||
position |
Long |
Position of the item in a sequence |
int64 |
||
key |
String |
Key identifier for the value |
|||
locale |
String |
Locale identifier for the value |
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 |