Core API – PEO
Core API endpoints of the PEO module.
Endpoints
Peo
GET /api/core/v1/peo/peos/bulk/{id}
Content Type
-
application/xml;charset=UTF-8
-
application/json;charset=UTF-8
-
application/json+compact;charset=UTF-8
POST /api/core/v1/peo/peos/links/persist
Link PEOs to projects
Description
Allows you to create links between Product Extension Objects (PEOs) and projects. This endpoint enables you to associate PEOs with specific projects for organizational and access control purposes.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
PimTypeDto |
PimType with LinksType for creating PEO-to-project links. Specify PEO and project using either IDs (peoId, projectId) or TIDs (peoTid, projectTid). Use consistent identifier types for both entities. 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 linked PEO |
|
400 |
Bad Request: Invalid input provided |
|
401 |
Unauthorized: Not authorized to access the endpoint |
|
404 |
Not Found: PEO or project not found |
|
500 |
Server Error: An unknown internal error occurred |
POST /api/core/v1/peo/peos/links/perform
Perform actions on PEO links
Description
Allows you to execute actions on the links between Product Extension Objects (PEOs) and projects. Currently supports the unlink action, which removes the association between a PEO and a project.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
PimTypeDto |
PimType with ActionsType for unlink operations. Set dataType to 'peoToProjectLink', type to 'unlink', and specify PEO and project identifiers (peoId/projectId or peoTid/projectTid) in the meta section. 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 PEO links |
|
400 |
Bad Request: Invalid input provided |
|
401 |
Unauthorized: Not authorized to access the endpoint |
|
404 |
Not Found: PEO or project not found |
|
500 |
Server Error: An unknown internal error occurred |
POST /api/core/v1/peo/peos/perform
Perform actions on PEOs
Description
Allows you to execute actions on Product Extension Objects (PEOs). Currently supports delete and copy actions with proper error handling for each operation.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
PimTypeDto |
PimType with ActionsType containing action details. Specify PEO by id or tid, set dataType to 'peo', and choose action type ('delete' or 'copy'). For copy actions, include name in meta section. 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 PEOs |
|
400 |
Bad Request: Invalid input provided |
|
401 |
Unauthorized: Not authorized to access the endpoint |
|
404 |
Not Found: PEO not found or access rights error |
|
500 |
Server Error: An unknown internal error occurred |
POST /api/core/v1/peo/peos/persist
Persist PEOs
Description
Allows you to create new Product Extension Objects (PEOs) or update existing ones. You can link PEOs to products and optionally to projects for organizational purposes.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
PimTypeDto |
PimType with PeosType for creating or updating PEOs. For creation, specify productTid, templateId, and name. For updates, provide PEO ID or TID. Optional nodes array can link PEO to projects. 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 PEO |
|
400 |
Bad Request: Invalid input provided |
|
401 |
Unauthorized: Not authorized to access the endpoint |
|
404 |
Not Found: Referenced product or project not found |
|
500 |
Server Error: An unknown internal error occurred |
POST /api/core/v1/peo/peos/query
Query PEO TIDs
Description
Allows you to retrieve a list of PEO (Product Extension Object) technical identifiers (TIDs) based on specific criteria. Filter PEOs by modification date, project TID, product TID, and PEO names.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
PeoQueryDto |
PeoQuery with filtering criteria including modification date range, product TID, project TID, PEO names, and withChildren flag for including child project PEOs. All criteria are combined with AND operator. PeoQueryDto |
X |
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Success: Returns PeoRequest with PEO TIDs that match the specified criteria |
|
400 |
Bad Request: Invalid input provided |
|
401 |
Unauthorized: Not authorized to access the endpoint |
|
404 |
Not Found: No matching PEOs found |
|
500 |
Server Error: An unknown internal error occurred |
POST /api/core/v1/peo/peos/retrieve
Retrieve PEOs
Description
Allows you to fetch detailed information about Product Extension Objects (PEOs). You can retrieve PEOs by their IDs or TIDs (technical identifiers) with optional metadata and performance optimization flags.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
PeoRequestDto |
PeoRequest with ids or tids arrays, withMetadata flag for audit information, and namesOnly flag for performance optimization. If both ids and tids are provided, ids are ignored. PeoRequestDto |
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 PEOs containing detailed information including properties, metadata, and project links |
|
400 |
Bad Request: Invalid input provided |
|
401 |
Unauthorized: Not authorized to access the endpoint |
|
404 |
Not Found: Requested PEOs not found |
|
500 |
Server Error: An unknown internal error occurred |
POST /api/core/v1/peo/peos
Get PEOs (deprecated)
Models
AbbreviationTypeDto
Container for abbreviated name items with technical identifier
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
itm |
List of ItemTypeDto |
List of abbreviated name items |
|||
tid |
String |
Technical identifier |
ActionTypeDto
Action to be performed on objects such as delete, copy, move, checkout, and checkin
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
meta |
parameters container |
||||
dataType |
X |
String |
Item type on which action should be performed |
||
tid |
X |
String |
Technical identifier of the target object |
||
type |
X |
String |
Action type. Check which action types support chosen dataType. |
||
id |
X |
Long |
Target object identity |
int64 |
|
path |
X |
String |
Unique path to the target object |
ActionsTypeDto
Container for multiple action definitions and operations
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
action |
List of ActionTypeDto |
List of individual action definitions |
ArticleTypeDto
Article entity containing product information and variants
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
name |
String |
Article identifier (name) |
|||
meta |
Additional info |
||||
links |
Object relationships and links |
||||
vals |
Attributes values. More info about product attributes values |
||||
variants |
Article's variants products. |
||||
tid |
String |
Technical identifier |
ArticlesTypeDto
Container for a collection of articles
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
article |
List of ArticleTypeDto |
List of articles |
AssetDefinitionTypeDto
Asset definition containing attribute definitions and configuration
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
attrDefs |
Asset attribute definitions |
||||
config |
Asset configuration settings |
||||
tid |
X |
String |
Technical identifier |
||
type |
X |
String |
Asset definition type |
AssetDefinitionsTypeDto
Container for asset definition collections
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
assetDef |
List of AssetDefinitionTypeDto |
List of asset definition objects |
AssetTypeDto
Asset information including metadata, file details, and relationships
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
name |
String |
Asset file name |
|||
meta |
Asset info |
||||
vals |
Asset attributes values. See more in Asset attributes |
||||
keywords |
List of keywords identifiers, linked with the asset. (Deprecated: Use links instead) |
||||
links |
List of linked objects. Currently only contains linked keywords. |
||||
histories |
Asset history |
||||
previews |
List of preview infos |
||||
tid |
X |
String |
Asset technical identifier |
||
id |
Long |
Unique asset identifier |
int64 |
||
type |
X |
String |
File type |
||
parent |
String |
TID of asset parent (directory) |
|||
rnc |
String |
Root node configuration, where asset is stored |
|||
path |
String |
Path to the asset file |
AssetsTypeDto
Container for asset objects
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
meta |
Additional metadata information |
||||
asset |
List of AssetTypeDto |
List of asset objects |
AttrDefinitionTypeDto
Comprehensive attribute definition with metadata, validation, and domain constraints
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
meta |
Attribute definition metadata |
||||
name |
Attribute definition name with localization |
||||
abbr |
Attribute definition abbreviation |
||||
tooltip |
Attribute definition tooltip information |
||||
defaultVal |
Attribute default value definition |
||||
multiValued |
Multi-value capability configuration |
||||
validation |
Attribute validation rules |
||||
domainVals |
Attribute domain value definitions |
||||
domainRange |
Attribute domain range specification |
||||
tags |
Attribute definition tags |
||||
references |
Attribute reference configuration |
||||
noValidateAsRichText |
String |
Rich text validation bypass flag |
|||
id |
Long |
Unique attribute definition identifier |
int64 |
||
tid |
X |
String |
Technical identifier |
||
type |
X |
String |
Attribute type definition |
||
localized |
String |
Whether attribute is language-dependent ("true"/"false") |
|||
required |
String |
Cardinality constraint ("optional", "required", "requiredInAllLanguages") |
|||
domain |
String |
Attribute domain specification |
AttributeDefinitionsTypeDto
Container for attribute definition collections with type classification
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
attrDef |
List of AttrDefinitionTypeDto |
List of attribute definition objects |
|||
type |
String |
Attribute type classification |
AttributeTypeDto
Attribute definition containing metadata, validation rules, and domain constraints
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
defaultVal |
Attribute default value. See more in DefaultValueType |
||||
domainVals |
Attribute domain values. See more in DomainValuesType |
||||
domainRange |
Attribute domain range. See more in DomainRangeType |
||||
key |
String |
Attribute definition identifier |
|||
level |
String |
Attribute belonging to product type |
|||
inheritance |
String |
Inheritance type |
|||
restriction |
Attribute presence indicator |
Enum: optional, required, mandatory, |
|||
localized |
Availability of localization |
Enum: true, false, |
|||
cardinality |
Integer |
Linked elements limit |
int32 |
||
option |
Access rights option |
Enum: READONLY, OVERWRITE, SYNCHRONIZED, |
|||
id |
Long |
Unique attribute identifier |
int64 |
||
nodeId |
Long |
Node identifier |
int64 |
||
nodePath |
String |
Node path in classification |
AttributesTypeDto
Container for attribute definitions and configurations
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
attr |
List of AttributeTypeDto |
List of attribute objects |
ClassificationNodesTypeDto
Container for classification node hierarchies
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
node |
List of NodeTypeDto |
List of classification node objects |
ClassificationTypeDto
Classification entity containing hierarchical structure and metadata
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
name |
Classification name with localization support |
||||
node |
Root classification node |
||||
tid |
String |
Unique identifier |
|||
id |
Long |
Unique classification id |
int64 |
ClassificationsTypeDto
Container for classification hierarchies and taxonomies
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
clazz |
List of ClassificationTypeDto |
List of classification objects |
|||
mode |
String |
Operation mode |
ConfigTypeDto
Configuration container with item collections
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
itms |
List of ItemsTypeDto |
List of configuration item collections |
DefaultValueTypeDto
Default value container for attribute definitions
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
itm |
List of ItemTypeDto |
List of default value items |
|||
tid |
String |
Technical identifier |
DeletionTypeDto
Deletion operation configuration with data type and options
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
dataType |
Type of data being processed |
Enum: product, attrDefinition, assetDefinition, classification, general, unknown, article, project, variant, tagDefinition, classNode, attribute, template, peo, mixed, projectTypes, locale, asset, productPreviewRefs, keyword, dir, glossary, variation, link, |
|||
tid |
String |
Technical identifier of the object to delete |
|||
option |
List of OptionTypeDto |
List of deletion options |
DeletionsTypeDto
Container for deletion operations and records
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
deletion |
List of DeletionTypeDto |
List of individual deletion operations |
DirectoriesTypeDto
Container for directory collections
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
dir |
List of DirectoryTypeDto |
List of directory objects |
DirectoryTypeDto
Directory object containing hierarchical file system information
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
name |
String |
Directory name |
|||
meta |
Directory metadata information |
||||
vals |
Directory attribute values |
||||
tid |
String |
unique directory identifier |
|||
rnc |
String |
Root node configuration identifier |
|||
parent |
String |
Parent directory tid |
DomainRangeTypeDto
Domain range specification for numeric attribute values
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
from |
String |
The initial value of the variable range of values |
|||
to |
String |
The final value of the variable range of values |
|||
intOnly |
Indicates integer or double type of value |
Enum: true, false, |
DomainValueTypeDto
Domain value definition with items and technical identifier
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
itm |
List of ItemTypeDto |
List of domain value items |
|||
tid |
X |
String |
Technical identifier |
DomainValuesTypeDto
Container for domain values with configuration options
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
domainVal |
List of DomainValueTypeDto |
List of allowed domain values |
|||
allowNewValue |
String |
Indicates whether a new value is possible |
true, false |
||
sortDirection |
String |
Ascending or descending arrangement of values |
|||
sortLanguageId |
Long |
Language by which sorting is applied |
int64 |
||
mode |
String |
Operation mode for domain values |
GlossariesTypeDto
Container for glossary definitions with attribute definitions
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
glossary |
List of GlossaryTypeDto |
List of glossary definitions |
|||
attrDefs |
Attribute definitions for glossaries |
GlossaryEntriesTypeDto
Container for multiple glossary entries in a glossary system
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
glossaryEntry |
List of GlossaryEntryTypeDto |
List of glossary entries containing terms and definitions |
GlossaryEntryTypeDto
Glossary entry containing term definitions and related information
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
meta |
Additional glossary entry attributes: value, last edit date and username, forbidden to usage flag. |
||||
vals |
Custom attribute values associated with the glossary entry |
||||
tid |
String |
TID of glossary entry. |
"24E654CF-2900-438D-83CF-01E3ABAA9B11" |
||
links |
List of linked glossary entries. |
||||
id |
Long |
ID of glossary entry. |
int64 |
||
parentId |
X |
Long |
ID of the parent glossary. Either parentId or parenTid must always be present. |
int64 |
|
parentTid |
X |
String |
TID of the parent glossary. Either parentId or parenTid must always be present. |
"24E654CF-2900-438D-83CF-01E3ABAA9B12" |
|
type |
X |
Type of the glossary entry: sentence or term. |
Enum: sentence, term, |
||
loc |
X |
String |
Locale identifier of the glossary entry. |
{langCode}_{contryCode} |
GlossaryTypeDto
Glossary configuration with metadata and values for terminology management
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
name |
String |
Name of the glossary |
|||
meta |
Metadata information for the glossary |
||||
vals |
Values and entries contained in the glossary |
||||
id |
Long |
Unique identifier of the glossary |
int64 |
||
tid |
String |
Transaction ID or type identifier |
HistoriesTypeDto
Container for historical tracking information
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
history |
List of HistoryTypeDto |
List of history records |
HistoryTypeDto
Historical record containing tracking and audit information
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
meta |
Historical metadata information |
||||
id |
Long |
Unique history record identifier |
int64 |
I18NTypeDto
Internationalization container for localized content
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
itm |
List of ItemTypeDto |
List of localized items |
|||
loc |
String |
Locale identifier |
|||
mode |
String |
Operation mode |
ItemTypeDto
Item with a value and position information
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
value |
String |
The value content of the item |
|||
pos |
Long |
Position index of the item |
int64 |
||
key |
String |
Key identifier of the item |
|||
loc |
String |
Locale code |
ISO 639 |
||
order |
String |
Order for sorting |
|||
mode |
String |
Mode of operation |
ItemsTypeDto
Container for item collections with metadata
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
itm |
List of ItemTypeDto |
List of item objects |
|||
itms |
List of ItemsTypeDto |
List of nested items collections |
|||
id |
Long |
Unique identifier |
int64 |
||
tid |
String |
Technical identifier |
|||
loc |
String |
Locale identifier |
|||
type |
String |
Type identifier |
|||
attr |
String |
Attribute identifier |
|||
mode |
String |
Operation mode |
KeywordTypeDto
Keyword definition with hierarchical structure and metadata
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
name |
Name information for the keyword |
||||
meta |
Metadata information for the keyword |
||||
links |
Links related to the keyword |
||||
id |
Long |
Unique identifier of the keyword |
int64 |
||
parentId |
Long |
Parent keyword identifier |
int64 |
||
path |
String |
Full path to the keyword in the hierarchy |
|||
parentPath |
String |
Path to the parent keyword |
KeywordsTypeDto
Container for multiple keyword definitions in a keyword system
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
kwd |
List of KeywordTypeDto |
List of keyword definitions |
LinksTypeDto
Container for object relationships and links
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
itm |
List of ItemTypeDto |
List of link items |
|||
itms |
List of ItemsTypeDto |
List of link item collections |
LocaleTypeDto
Locale information for internationalization and localization
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
meta |
Additional locale info |
||||
config |
Locales configuration information |
||||
id |
Long |
Unique numeric identifier of the locale |
int64 |
||
tid |
String |
Technical identifier of the locale |
|||
language |
X |
String |
Language code |
ISO 639 |
|
country |
X |
String |
County code |
ISO 3166 |
|
name |
X |
String |
Display name of the locale |
LocalesTypeDto
Container for locale definitions with mode configuration
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
locale |
List of LocaleTypeDto |
List of locale definitions |
|||
mode |
String |
Mode configuration for locales |
MetaTypeDto
Metadata container with key-value information
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
itm |
List of ItemTypeDto |
List of metadata items |
MultiValuedTypeDto
Multi-value configuration with cardinality limits
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
value |
Multi-value indicator |
Enum: true, false, |
|||
cardinality |
Integer |
Maximum number of values |
int32 |
NameTypeDto
Container for localized name items
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
itm |
List of ItemTypeDto |
List of ItemType with localized names |
NodeTypeDto
Classification node containing hierarchical structure and attributes
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
name |
Node names, default and localized |
||||
attr |
List of AttributeTypeDto |
Assigned attributes to the node |
|||
node |
List of NodeTypeDto |
Children. If nested tree structure was used for retrieve |
|||
tid |
String |
Technical identity |
|||
id |
Long |
Node id |
int64 |
||
parentId |
Long |
parent node id |
int64 |
||
path |
String |
Path in classification |
/ (forward slash) - as separator |
||
parentPath |
String |
parent path in classification |
/ (forward slash) - as separator |
||
classificationTid |
String |
Classification identifier |
|||
mode |
String |
Operation mode |
OptionTypeDto
Key-value option pair for configuration and selection purposes
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
value |
String |
The display value or label of the option |
|||
key |
String |
The unique key identifier for the option |
ParamTypeDto
Parameter definition with key-value pair for configuration purposes
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
value |
String |
The parameter value |
|||
key |
String |
The parameter key identifier |
ParamsTypeDto
Container for parameters with hierarchical support
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
param |
List of ParamTypeDto |
List of individual parameter objects |
|||
params |
List of ParamsTypeDto |
Nested parameter groups |
|||
key |
String |
Key identifier for this parameter group |
PeoQueryDto
Parameter object for peo query requests
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
modifiedFrom |
String |
Filter parameter, lower bound of change interval. The value of this parameter will be combined with other filter parameters using a logical AND. |
|||
modifiedUntil |
String |
Filter parameter, upper bound of change interval. The value of this parameter will be combined with other filter parameters using a logical AND. |
|||
names |
List of [string] |
The names of the PEOs to retrieve |
|||
tidProject |
String |
Filter parameter, get all peos for a project given by tid. The value of this parameter will be combined with other filter parameters using a logical AND. |
|||
tidProduct |
String |
Filter parameter, get all peos for a product given by tid. The value of this parameter will be combined with other filter parameters using a logical AND. |
|||
withChildren |
Boolean |
when tidProject is set this specifies if the peos linked to child projects should be exported as well, default is true |
|||
considerLinkRelation |
Boolean |
Also consider the relation modification date in case a date is set |
PeoRequestDto
Parameter object for peo requests
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
tids |
List of [string] |
Filter parameter, PEO TIDs, identifying unique objects. |
|||
ids |
List of [long] |
Filter parameter, PEO IDs, identifying unique objects. |
int64 |
||
namesOnly |
Boolean |
If true, only the names of the PEOs are returned. This is advisable if only the names are needed, as it improves performance |
|||
withMetadata |
Boolean |
true if metadata element should be added, default is false |
PeoTypeDto
Product Entity Object (PEO) containing product relationships and template information
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
default |
String |
Default PEO indicator |
|||
meta |
PEO metadata information |
||||
name |
String |
Name of the PEO |
|||
links |
PEO relationships and links |
||||
vals |
PEO attribute values |
||||
tid |
String |
Technical id (identifier) of PEO |
|||
product |
String |
Product reference |
|||
template |
String |
Template reference |
|||
templateId |
Long |
Template identifier |
int64 |
||
templateTid |
String |
Template technical identifier |
|||
productId |
Long |
Product identifier |
int64 |
||
productTid |
String |
Product technical identifier |
PeosTypeDto
Container for Product Entity Object (PEO) collections
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
peo |
List of PeoTypeDto |
List of Product Entity Objects |
PimTypeDto
Product Information Management (PIM) system - provides access to resources of the PIM module. PIM refers to the management of all product-defining information and its provision for use in output channels.
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
meta |
Additional metadata information containing key/value pairs |
||||
locales |
List of supported locales with language and country codes |
||||
links |
Relations between OMN objects such as assets, products, projects, and keywords |
||||
tagDefs |
Tag definitions for object categorization and metadata |
||||
rncs |
Root Node Configurations representing filesystem access configurations |
||||
versions |
Different states of files, with only one active version at a time |
||||
variations |
Related files that are variations of assets, usually with different file names |
||||
variationTypes |
Types of asset variations available in the system |
||||
assets |
Digital assets such as images, videos, documents, and other media files |
||||
dirs |
Directory structure representing folders that can contain sub-directories or assets |
||||
kwds |
Hierarchical keyword structure for categorizing and tagging objects |
||||
glossaries |
Glossaries containing terms and sentences for translation and terminology management |
||||
glossaryEntries |
Individual entries within glossaries, can be terms or sentences |
||||
attrDefs |
Attribute definitions that define product properties, their types, and validation rules |
||||
assetDefs |
Asset definitions that define types and properties of digital assets |
||||
productPreviewRefs |
References to preview representations of products |
||||
classes |
Product classification system for organizing and categorizing products |
||||
products |
Product information including articles and variations with attributes and relationships |
||||
projectDefs |
Project definition templates and configurations |
||||
projects |
Project instances with metadata and associated resources |
||||
templates |
Templates for creating and structuring various types of objects |
||||
peos |
Product Export Objects defining how products are exported to different channels |
||||
deletions |
Records of deleted objects for tracking and audit purposes |
||||
responses |
Status information and results of performed operations with success, error, or warning details |
||||
actions |
Actions to be performed on objects such as delete, copy, move, checkout, and checkin |
||||
nodes |
Classification tree nodes that represent hierarchical categorization structure |
||||
attrs |
Product and node attributes with their values, inheritance, and localization settings |
||||
params |
Configuration parameters and settings |
||||
schemaVersion |
X |
String |
Version of the PIM schema being used |
PreviewInfoTypeDto
Preview information containing metadata and identification details
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
meta |
Metadata information for the preview |
||||
tid |
String |
Technical identifier for the preview |
|||
type |
String |
Type of the preview |
PreviewsInfoTypeDto
Container for preview information objects
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
preview |
List of PreviewInfoTypeDto |
List of preview information for different formats and types |
ProductPreviewRefsTypeDto
Container for product preview references containing item information
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
itm |
List of ItemTypeDto |
List of item references for product previews |
ProductTypeDto
Product information including articles and variations with attributes and relationships
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
name |
String |
Product name |
|||
node |
String |
Node path to product |
/ (forward slash) - as separator |
||
clazz |
String |
classification identifier |
|||
links |
Relations to assets/channels/products |
||||
meta |
Additional info |
||||
vals |
Attributes values. More info about product attribute values |
||||
articles |
List of children articles |
||||
tid |
String |
Technical identifier |
ProductsTypeDto
Container for product collections with metadata
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
meta |
Additional metadata information |
||||
product |
List of ProductTypeDto |
List of product objects |
ProjectDefinitionTypeDto
Project definition containing attribute definitions and configuration
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
attrDefs |
Project attribute definitions |
||||
config |
Project configuration settings |
||||
tid |
X |
String |
Technical identifier |
ProjectDefinitionsTypeDto
Container for project definition collections with operational mode
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
projectDef |
List of ProjectDefinitionTypeDto |
List of project definition objects |
|||
mode |
String |
Operation mode for project definitions |
ProjectTypeDto
Project entity containing hierarchical structure, metadata, and product relationships
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
name |
String |
Project name |
|||
meta |
Project metadata information |
||||
vals |
Project attribute values |
||||
links |
Project relationships and links |
||||
project |
X |
oas_any_type_not_mapped |
|||
peos |
Product entities within project |
||||
peoHierarchy |
Product hierarchy structure |
||||
id |
Long |
Unique project identifier |
int64 |
||
tid |
String |
Technical identifier |
|||
parentId |
Long |
Parent project identifier |
int64 |
||
parentTid |
String |
Parent project technical identifier |
|||
type |
String |
Project type classification |
|||
orderSequence |
Long |
Project ordering sequence |
int64 |
ProjectsTypeDto
Container for project collections with operational mode
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
project |
List of ProjectTypeDto |
List of project objects |
|||
mode |
String |
Operation mode for projects |
ReferenceTypeDto
Reference to another object by technical identifier
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
tid |
String |
Technical identifier of the referenced object |
ReferencesTypeDto
Container for reference objects and relationships
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
reference |
List of ReferenceTypeDto |
List of reference objects |
ResponseTypeDto
Response containing status information about performed operations with success, error, or warning details
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
status |
X |
Operation result status |
Enum: SUCCESS, ERROR, WARNING, |
||
description |
String |
General description of the response |
|||
issues |
List of ItemsTypeDto |
List of issues encountered during operation |
|||
details |
Response details |
||||
dataType |
Type of data being processed |
Enum: product, attrDefinition, assetDefinition, classification, general, unknown, article, project, variant, tagDefinition, classNode, attribute, template, peo, mixed, projectTypes, locale, asset, productPreviewRefs, keyword, dir, glossary, variation, link, |
|||
tid |
String |
Tid of processed object |
|||
id |
Long |
Id of processed object |
int64 |
||
action |
String |
Performed action |
|||
path |
String |
Path of processed object |
|||
key |
String |
Key identifier of the object |
|||
nodePath |
String |
Path to the classification node |
|||
nodeId |
Long |
ID of the classification node |
int64 |
ResponsesTypeDto
Container for multiple response objects with operation status information
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
response |
List of ResponseTypeDto |
List of individual response objects |
RncTypeDto
Root Node Configuration containing filesystem access configuration and metadata
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
meta |
Key/value info of RNC record |
||||
tid |
X |
String |
Technical id (identifier) of RNC |
RncsTypeDto
Container for Root Node Configuration (RNC) collections representing filesystem access configurations
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
rnc |
List of RncTypeDto |
List of Root Node Configuration objects |
TagDefinitionTypeDto
Tag definition containing value and technical identifier
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
value |
String |
Tag definition value |
|||
tid |
String |
Technical identifier of the tag definition |
TagDefinitionsTypeDto
Container for tag definition objects
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
tagDef |
List of TagDefinitionTypeDto |
List of tag definitions |
TagTypeDto
Tag object containing metadata and identification information
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
value |
String |
Tag value content |
|||
tid |
String |
Technical identifier |
TagsTypeDto
Container for tag metadata and labeling information
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
tag |
List of TagTypeDto |
List of tag objects |
TemplateTypeDto
Template definition containing metadata and classification nodes
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
meta |
Template metadata information |
||||
node |
List of NodeTypeDto |
Template classification nodes |
|||
tid |
X |
String |
Technical identifier |
||
clazz |
String |
Template class definition |
TemplatesTypeDto
Container for template collections with operational mode
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
template |
List of TemplateTypeDto |
List of template objects |
|||
mode |
String |
Operation mode for templates |
TooltipTypeDto
Tooltip information with localized content items
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
itm |
List of ItemTypeDto |
List of tooltip items with content |
|||
tid |
String |
Technical identifier of the tooltip |
ValidationTypeDto
Validation rules and constraints for attribute values
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
type |
String |
Regular expression of the form |
|||
minLength |
Integer |
Minimum length |
int32 |
||
maxLength |
Integer |
Maximum length |
int32 |
ValueTypeDto
Value object containing attribute data with localization and metadata
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
itm |
List of ItemTypeDto |
List of item values |
|||
i18N |
List of I18NTypeDto |
List of internationalization objects |
|||
tags |
Tags associated with the value |
||||
attr |
String |
Attribute identifier |
|||
type |
String |
Value type identifier |
|||
origin |
String |
Origin identifier |
|||
inheritance |
String |
Inheritance type |
|||
parent |
String |
Parent identifier |
|||
node |
String |
Node identifier |
|||
dataType |
String |
Data type identifier |
|||
mode |
String |
Operation mode |
ValuesTypeDto
Container for value objects with attributes and localization
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
val |
List of ValueTypeDto |
List of value objects |
VariantTypeDto
Product variant containing detailed information and attributes
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
name |
String |
Variant identifier |
|||
meta |
Addtitional info |
||||
links |
Object relationships and links |
||||
vals |
Attributes values. More info about product attributes values |
||||
tid |
String |
Technical identifier |
VariantsTypeDto
Container for product variants
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
variant |
List of VariantTypeDto |
List of variant objects |
VariationTypeDto
Asset variation definition with metadata and parent-child relationships
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
meta |
Metadata information for the variation |
||||
assetId |
Long |
Asset identifier for the variation |
int64 |
||
assetTid |
String |
Technical identifier of the asset |
|||
parentTid |
String |
Technical identifier of the parent asset |
VariationTypeTypeDto
Variation type definition with technical identifier
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
tid |
String |
Technical identifier for the variation type |
VariationTypesTypeDto
Container for multiple variation type definitions
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
variationType |
List of VariationTypeTypeDto |
List of variation type definitions |
VariationsTypeDto
Container for multiple variation definitions
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
variation |
List of VariationTypeDto |
List of variation definitions |
VersionTypeDto
Asset version information with metadata and identifiers
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
name |
String |
Name of a version |
|||
meta |
Version metadata information |
||||
tid |
String |
Technical id |
|||
assetTid |
String |
Asset technical id |
|||
assetId |
Long |
Asset id |
int64 |
VersionsTypeDto
Container for asset version collections
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
version |
List of VersionTypeDto |
List of version objects |