DTO Models

LocaleRequest

Field Name Required Type Description Format

ids

List of integers

Locale ids

tids

List of strings

Locale identifiers. Each identifier consists of a language- and country-code separated by an underscore '_'

mode

X

String

Retrieve mode

Enum: ID, TID, ALL, CONTENT, FRONTEND,

exportConfig

Boolean

Option to retrieve locales with additional information. E.g. custom date formats

LocaleType

Field Name Required Type Description Format

config

ConfigType

Locales configuration information

country

X

String

County code

ISO 3166

language

X

String

Language code

ISO 639

meta

MetaType

Additional locale info

name

X

String

id

Integer

tid

String

LocalesType

Field Name Required Type Description Format

locale

List of LocaleType

mode

String

KeywordRequest

Field Name Required Type Description Format

path

X

String

Keyword path

/rootKwd/kwd1

level

Integer

It defines how many level should be loaded. Default value is 1. -1 means to load all levels. 0 is invalid value

"2"

retrieveLinks

Boolean

It defines whether linked to keyword items should be retrieved or not

true

GlossaryRequest

Field Name Required Type Description Format

names

List

The names of the glossaries to retrieve

["MyGlossary", "DE-EN"]

ids

List

The ids of the glossaries to retrieve

[1331131, 22738178]

retrieveEntries

Boolean

It defines whether the contained entries (terms and sentences) should be included in the response

true

sourceLocales

List

Limits the source languages to the specified list of locales. Default: empty array which means all languages

["de_DE"]

targetLocales

List

Limits the target languages to the specified list of locales. Default: empty array which means all languages

["en_DE", "fr_FR"]

GlossariesType

Field Name Required Type Description Format

glossaries

List of GlossaryType

GlossaryType

Field Name Required Type Description Format

id

Long

ID of glossary.

int64

tid

String

TID of glossary.

"24E654CF-2900-438D-83CF-01E3ABAA9B12"

name

String

Glossary name.

"Default glossary"

meta

MetaType

Additional glossary attributes and information: creation date and username, modification date and username, amount of terms and sentences, amount of all glossary entries.

vals

ValuesType

List of custom glossary attributes.

GlossaryEntriesType

Field Name Required Type Description Format

glossaryEntries

List of GlossaryEntryType

GlossaryEntryType

Field Name Required Type Description Format

id

Long

ID of glossary entry.

int64

tid

String

TID of glossary entry.

"24E654CF-2900-438D-83CF-01E3ABAA9B11"

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

String

Type of the glossary entry: sentence or term.

Enum: sentence, term

loc

X

String

Locale identifier of the glossary entry.

{langCode}_{contryCode}

meta

MetaType

Additional glossary entry attributes: value, last edit date and username, forbidden to usage flag.

links

LinksType

List of linked glossary entries.

HistoryRequest

Field Name Required Type Description Format

tids

List

Filter parameter, asset TIDs (Metatag GUID), identifying unique objects

["24E654CF-2900-438D-83CF-01E3ABAA9B11", "8DA3641A-B939-467F-8E80-177C4992B270"]

ids

List

Filter parameter, asset IDs, identifying unique objects

[1331131, 22738178]

paths

List

Filter parameter, asset paths, identifying unique objects

["/MAM/test/invisible/image1.png", "/MAM/test/simple/image2.png"]

OmnType

The OMN internal term for OmnType is PimType due to legacy reasons (Link to PimType)

PimType

Field Name Required Type Description Format

actions

ActionsType

assetDefs

AssetDefinitionsType

assets

AssetsType

attrDefs

AttributeDefinitionsType

classes

ClassificationsType

deletions

DeletionsType

dirs

DirectoriesType

glossaries

GlossariesType

glossaryEntries

GlossaryEntriesType

kwds

KeywordsType

links

LinksType

locales

LocalesType

meta

MetaType

nodes

ClassificationNodesType

peos

PeosType

productPreviewRefs

ProductPreviewRefsType

products

ProductsType

projectDefs

ProjectDefinitionsType

projects

ProjectsType

responses

ResponsesType

rncs

RncsType

schemaVersion

X

String

tagDefs

TagDefinitionsType

templates

TemplatesType

variationTypes

VariationTypesType

variations

VariationsType

versions

VersionsType

ResponseType

Field Name Required Type Description Format

action

String

Performed action

dataType

String

ItemInformationType 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,

description

String

General description of the response

details

ItemsType

Response details

id

Long

Id of processed object

int64

issues

List of ItemsType

path

String

Path of processed object

status

X

String

Enum: SUCCESS, ERROR, WARNING

tid

String

Tid of processed object

ResponsesType

Field Name Required Type Description Format

response

List of ResponseType

Accumulate responses

ItemType

Field Name Required Type Description Format

key

String

loc

String

Locale identifier of the item content.

{langCode}_{contryCode}

order

String

pos

Long

position of the item

int64

value

String

payload

ItemsType

Field Name Required Type Description Format

attr

String

id

Long

int64

itm

List of ItemType

itms

List of ItemsType

loc

String

mode

String

type

String

Message

Field Name Required Type Description Format

tid

String

The technical id of the message which can optionally be set by the client

id

Long

The internal system id of the message

int64

creationDate

Date

The date when the message was persisted.

date-time

subject

X

String

The subject of the message.

body

X

String

The main body text of the message.

severity

String

The severity level of the message.

Enum: INFO, WARN, ERROR,

recipientUser

String

The name of the user this message is sent to.

recipientRole

String

The name of the role this message is sent to.

senderUser

String

The name of the user who sent this message.

senderApplication

X

String

The name of the application who sent this message.

senderPlugin

X

String

The name of the plugin who sent this message.

isRead

Boolean

Indicates if this message is read.

parameters

Map of string

Additional properties of this message.

MessagesPersistRequest

Field Name Required Type Description Format

messages

List of Message

AssetUploadRequest

Field Name Required Type Description Format

path

X

String

Path to a new asset. It must not need to start with a '/'. So '/MAM/…​' and 'MAM/…​' are both valid inputs. The first path element is the RNC identifier. Might contain a new file name with which new asset need be uploaded to the system.

tid

String

Tid to set. This is an optional parameter and if not provided then it will be set by the server automatically.

doPreviewsAsync

Boolean

If it is set to false then the preview generation (the checkin) will be done synchronous/blocking.

doOverwrite

Boolean

If it is set to false an existing file will not be overwritten/updated. Instead a HTTP Status Code 403 (Already exists) is returned.

AssetVersionUploadRequest

Field Name Required Type Description Format

versionComment

String

Version comment for a source asset

tid

X

String

Tid of the asset for which the version is being created

timeoutDate

Date

Date until when version will be stored

date-time ISO8601

protectedAfterDate

Date

Date from when version will be protected

date-time ISO8601

protectedBeforeDate

Date

Date until when version will be protected

date-time ISO8601

AssetVariationUploadRequest

Field Name Required Type Description Format

tid

X

String

Tid of the asset for which the variation is being linked

variationType

X

String

Specific variation type

variationFileName

String

File name of new variation. The parameter is optional. If has not been set then the name will be taken from provided file

MetaType

Field Name Required Type Description Format

itm

List of ItemType

ActionType

Field Name Required Type Description Format

dataType

X

String

Item type on which action should be performed

Enum: ItemInformationType

id

X G1

Long

Target object identity

int64

meta

MetaType

parameters container

path

X G1

String

Unique path to the target object

tid

X G1

String

Technical identifier of the target object

type

X

String

Action type. Check which action types support chosen dataType.

Enum: PerformActionType

ActionsType

Field Name Required Type Description Format

action

List of ActionType

AssetQuery

Field Name Required Type Description Format

modifiedFrom

Date

Filter parameter, lower bound of change interval. The value of this parameter will be combined with other filters using logical AND

date-time

modifiedUntil

Date

Filter parameter, upper bound of change interval. The value of this parameter will be combined with other filters using logical AND.

date-time

fileTypes

List of string

Filter parameter, a filter on file types, array of discriminators to regard, e.g. IMG. The value of this parameter will be combined with other filters using logical AND.

directory

DirectoryIdentifier

Directory identifier

DirectoryIdentifier

Directory identifier. Tid or id or path with RNC could be provided to describe directory for query

Field Name Required Type Description Format

tid

String

Technical id of directory

id

Long

ID (Primary key in DB) of directory

int64

path

String

Path to directory with RNC

/ (forward slash) - as separator. RNC identifier - as root entry.

AssetRequest

Field Name Required Type Description Format

tids

List of string

Filter parameter, asset TIDs (Metatag GUID), identifying unique objects.

ids

List of long

Filter parameter, asset IDs, identifying unique objects.

int64

formats

List of string

Filter parameter, asset formats, identifying preview format or asset.

Enum: ["original", "previewOriginal", "previewCoarse", "previewThumbnail", "previewCustom", "previewOriginalPixel", "previewOriginalVector", "previewOriginalMultimedia"]

retrieveHistory

Boolean

It defines whether history should be retrieved

retrievePreviews

Boolean

It defines whether previews info should be retrieved

AssetType

Field Name Required Type Description Format

histories

HistoriesType

Asset history

keywords (deprecated)

LinksType

List of keywords identifiers, linked with the asset. (Deprecated: Use links instead)

links

LinksType

List of linked objects. Currently only contains linked keywords.

meta

MetaType

Asset info

name

String

Asset file name

parent

String

TID of asset parent (directory)

previews

PreviewsInfoType

List of preview infos

rnc

String

Root node configuration, where asset is stored

tid

X

String

Asset technical identifier

type

X

String

File type

vals

ValuesType

Asset attributes values. See more in Asset attributes

AssetsType

Field Name Required Type Description Format

asset

List of AssetType

HistoriesType

Field Name Required Type Description Format

history

List of HistoryType

HistoryType

Field Name Required Type Description Format

id

X

Long

history object identity

int64

meta

MetaType

Key/value info of history record

RncsType

Field Name Required Type Description Format

rnc

List of RncType

RncType

Field Name Required Type Description Format

tid

X

String

Technical id (identifier) of RNC

meta

MetaType

Key/value info of RNC record

PreviewInfoType

Field Name Required Type Description Format

meta

X

MetaType

Properties of preview

tid

X

String

X

Technical identifier of preview

type

X

String

Preview type

Enum: THUMBNAIL, COARSE, ORIGINAL, CUSTOM, ORIGINAL_PIXEL, ORIGINAL_VECTOR, ORIGINAL_MULTIMEDIA;

PreviewsInfoType

Field Name Required Type Description Format

preview

List of PreviewInfoType

VariationRequest

Request to get variations for objects. Allow to get asset variations by tids or by ids or by paths

Field Name Required Type Description Format

assetIds

List of long

Unique identities of assets

int64

assetTids

List of string

Unique identifiers of assets (Metatag GUIDs)

assetPaths

List of string

Unique paths to assets

/ (forward slash) - as separator. RNC identifier - as root entry.

VariationType

Field Name Required Type Description Format

assetId

X

Long

Identity of the asset variation.

int64

assetTid

X

String

Technical identifier of the asset variation

meta

MetaType

Contains additional info

Map

parentTid

X

String

Parent asset variation identity

VariationsType

Represents a flat tree structure of assets variations links.

Field Name Required Type Description Format

variation

List of VariationType

PreviewInfoRequest

Field Name Required Type Description Format

assetTids

List of string

Assets TIDs (Metatag GUID), identifying unique objects.

assetIds

List of long

Assets IDs, identifying unique objects.

int64

assetPaths

List of string

Assets paths (Metatag GUID), identifying unique objects.

/ (forward slash) - as separator. RNC identifier - as root entry.

formats

List of string

Asset formats, identifying preview format to be retrieved

Enum: original, previewOriginal, previewCoarse, previewThumbnail, previewCustom, previewOriginalPixel, previewOriginalVector, previewOriginalMultimedia,

ValuesType

Field Name Required Type Description Format

val

List of ValueType

ValueType

Field Name Required Type Description Format

attr

String

dataType

String

i18N

List of I18NType

inheritance

String

itm

List of ItemType

mode

String

node

String

origin

String

parent

String

tags

TagsType

type

String

I18NType

Field Name Required Type Description Format

itm

List of ItemType

loc

String

DirectoryType

Field Name Required Type Description Format

meta

MetaType

name

String

Directory name

parent

String

Parent directory tid

rnc

String

Root node configuration identifier

tid

String

unique directory identifier

vals

ValuesType

DirectoriesType

Field Name Required Type Description Format

dir

List of DirectoryType

DirectoryRequest

Field Name Required Type Description Format

rncTid

String

A unique identifier of RNC. It is used to get a list of directories of the given RNC

dirTid

String

A unique identity of a directory (Metatag GUID). It is used to get a list of sub-directories of the given directory

dirPath

String

A directory path. It includes RNC identifier and relative path of the given directory

level

Integer

It defines how many level should be loaded. Default value is 1. -1 means to load all levels. 0 is invalid value

int32

NameType

Field Name Required Type Description Format

itm

List of ItemType with localized names

NodeType

Field Name Required Type Description Format

attr

List of AttributeType

Assigned attributes to the node

class

String

Classification identifier

id

Long

Node id

int64

mode

String

name

NameType

Node names, default and localized

node

List of NodeType

Children. If nested tree structure was used for retrieve

parentId

Long

parent node id

int64

parentPath

String

parent path in classification

/ (forward slash) - as separator

path

String

Path in classification

/ (forward slash) - as separator

tid

String

Technical identity

NodesRequest

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 Type Description Format

path

String

Node path

/ (forward slash) - as separator

level

Integer

Depth level to get more children nodes

int32. 0 - invalid value. -1 - get all children.

classificationId

Long

Classification identifier to retrieve a root node of the classification

int64

ids

List of [long]

int64

ClassificationNodesType

Field Name Required Type Description Format

node

List of NodeType

VariationTypeType

Field Name Required Type Description Format

tid

String

Asset variation type unique identifier

VariationTypesType

Field Name Required Type Description Format

variationType

List of VariationTypeType

ClassificationRequest

Field Name Required Type Description Format

tids

X

List of [string]

Filter parameter, classifications TIDs, identifying unique objects.

ids

X

List of [long]

Filter parameter, classifications IDs, identifying unique objects.

int64

withNodes

Boolean

True if node elements should be added, default is false.

ClassificationType

Field Name Required Type Description Format

id

Long

Unique classification id

int64

name

NameType

node

NodeType

Root classification node

tid

String

Unique identifier

ClassificationsType

Field Name Required Type Description Format

class

List of ClassificationType

mode

String

AttributeDefinitionsType

Field Name Required Type Description Format

attrDef

List of AttrDefinitionType

type

String

AttrDefinitionType

Field Name Required Type Description Format

abbr

AbbreviationType

defaultVal

DefaultValueType

domain

String

domainRange

DomainRangeType

domainVals

DomainValuesType

meta

MetaType

multiValued

MultiValuedType

name

NameType

references

ReferencesType

tags

TagsType

tid

X

String

tooltip

TooltipType

type

X

String

validation

ValidationType

AttributeDefinitionsRequest

Field Name Required Type Description Format

tids

X

List of [string]

Filter parameter, attribute definitions TIDs, identifying unique objects.

ids

X

List of [long]

Filter parameter, attribute definitions IDs, identifying unique objects.

int64

all

Boolean

True if all attribute definitions should be exported. Default value false.

AttributesType

Field Name Required Type Description Format

attr

List of AttributeType

AttributeType

Field Name Required Type Description Format

cardinality

Integer

Linked elements limit

int32

defaultVal

DefaultValueType

Attribute default value. See more in DefaultValueType

domainRange

DomainRangeType

Attribute domain range. See more in DomainRangeType

domainVals

DomainValuesType

Attribute domain values. See more in DomainValuesType

inheritance

String

Inheritance type

key

String

Attribute definition identifier

level

String

Attribute belonging to product type

Product, Article, Variation

localized

String

Availability of localization

true, false

option

String

Access rights option

READONLY, OVERWRITE, SYNCHRONIZED

restriction

String

Attribute presence indicator

optional, required, mandatory

DefaultValueType

Field Name Required Type Description Format

itm

List of ItemType

tid

String

Technical identifier

DomainRangeType

Field Name Required Type Description Format

from

String

The initial value of the variable range of values

intOnly

String

Indicates integer or double type of value

true, false

to

String

The final value of the variable range of values

DomainValuesType

Field Name Required Type Description Format

allowNewValue

String

Indicates whether a new value is possible

true, false

domainVal

List of DomainValueType

mode

String

sortDirection

String

Ascending or descending arrangement of values

DomainValueType

Field Name Required Type Description Format

itm

List of ItemType

tid

X

String

Technical identifier

ProductRequest

Field Name Required 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.

int64

ProductType

Field Name Required Type Description Format

articles

ArticlesType

List of children articles

class

String

classification identifier

links

LinksType

Relations to assets/channels/products

meta

MetaType

Additional info

name

String

Product name

node

String

Node path to product

/ (forward slash) - as separator

tid

X

String

Technical identifier

vals

ValuesType

Attributes values. More info about product attribute values

ProductQuery

Field Name Required Type Description Format

modifiedFrom

Date

Filter parameter, lower bound of change interval. The value of this parameter will be combined with other filters using logical AND

date-time

modifiedUntil

Date

Filter parameter, upper bound of change interval. The value of this parameter will be combined with other filters using logical AND.

date-time

nodePaths

List of string

Filter parameter, classification nodes to export.

searchStrategy

String

The bean name of search strategy. If this parameter will be empty - default strategy will be used for search.

ProductsType

Field Name Required Type Description Format

product

List of ProductType

ArticleType

Field Name Required Type Description Format

meta

MetaType

Additional info

name

String

Article identifier (name)

tid

X

String

vals

ValuesType

Attributes values. More info about product attributes values

variants

VariantsType

Article’s variants products.

ArticlesType

Field Name Required Type Description Format

article

List of ArticleType

VariantType

Field Name Required Type Description Format

meta

MetaType

Addtitional info

name

String

Variant identifier

tid

X

String

vals

ValuesType

Attributes values. More info about product attributes values

VariantsType

Field Name Required Type Description Format

variant

List of VariantType

NodesType

Field Name Required Type Description Format

node

X

List of [string]

ConfigType

Field Name Required Type Description Format

itms

List of ItemsType

ChannelQueryDto

Field Name Required Type Description Format

root

Boolean

Filter parameter, only return root level channels without a parent. When this parameter is true, all other parameters are ignored.

tid

String

Filter parameter, channel TID, identifying unique channel. The value of this parameter will be preferred over id.

This tid will also be part of the response

id

Integer

Filter parameter, channel ID, identifying unique channel. The value of this parameter will be disregarded if tid is set.

The tid of this channel will also be part of the response

withChildren (deprecated)

Boolean

export child channel as well, default is true. When this is false, the level parameter is ignored (Deprecated: Use level instead)

level

Integer

How deep in the hierarchy child projects should be returned. 0 will return only the requested project without children. 1 will return the project itself and first grade immediate child projects. And so on.

Default is 100 for legacy compatibility of 'withChildren', so make sure to set this to a more appropriate value

int32

ChannelBriefingRequestDto

Field Name Required Type Description Format

tids

List of [string]

Filter parameter, channel TIDs, identifying unique channel. The value of this parameter will be preferred over id. Only one TID is supported for channel briefings

ids

List of [integer]

Filter parameter, channel ID, identifying unique channel. The value of this parameter will be disregarded if tid is set. Only one ID is supported for channel briefings

briefingInfo

X

BriefingInfo

Info about BriefingModule Plugin Configuration and Language

BriefingInfo

Field Name Required Type Description Format

locale

X

[string]

OMN locale in which to retrieve the briefing information

briefingModuleCfgTid

X

[string]

TID of the BriefingModule Plugin Configuration (the plugin configuration identifier)

ChannelRequestDto

Field Name Required Type Description Format

tids

List of [string]

Filter parameter, channel TIDs, identifying unique channel. The value of this parameter will be preferred over id.

ids

List of [integer]

Filter parameter, channel ID, identifying unique channel. The value of this parameter will be disregarded if tid is set.

PeoQuery

Parameter object for peo query requests

Field Name Required 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.

UTC date in ISO format

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.

UTC date in ISO format

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

PeoRequest

Parameter object for peo requests

Field Name Required 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

withMetadata

Boolean

true if metadata element should be added, default is false

namesOnly

Boolean

true if only names of PEOs should be returned, default is false

ChannelRequest

Field Name Required Type Description Format

tids

List of [string]

Filter parameter, Project TIDs, identifying unique project. The value of this parameter will be preferred over id.

ids

List of [long]

Filter parameter, Project ID, identifying unique project. The value of this parameter will be disregarded if tid is set.

int64

AttributesQueryRequest

Object to fetch ids of attributes that match a parameters. Use 'productId' to query product attributes by product id Use 'productTid' to query product attributes by product tid Use 'nodeId' to query node attributes by node id Use 'nodePath' to query node attributes by node path

Field Name Required 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

AttributesRequest

Field Name Required Type Description Format

ids

X

List of [long]

Filter parameter, attribute IDs, identifying unique objects.

int64

AttributesRetrieveRequest

Field Name Required Type Description Format

ids

X

List of [long]

Filter parameter, attribute IDs, identifying unique objects.

int64

productIds

X

List of [long]

Filter parameter, product IDs, identifying unique objects.

int64

productTids

X

List of [string]

Filter parameter, product TIDs, identifying unique objects.

nodeIds

X

List of [long]

Filter parameter, node IDs.

int64

nodePaths

X

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

True if attributes should be retrieved with DomainRange and DomainVals values

withDefaultValues

Boolean

True if attributes should be retrieved with DefaultVal value

AttributeDefinitionsQueryRequest

Object to fetch ids of attributeDefinitions that match a parameter. Query only for one group.

Find by types

Field Name Required Type Description Format

types

List of [string]

Filter parameter, a filter on types, array of discriminators to regard, e.g text.

LinksType

Field Name Required Type Description Format

itm

List of ItemType

itms

List of ItemsType

NodesQueryRequest

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 Type Description Format

productTid

String

[Find by product] Product tid to find related node

productId

Long

[Find by product] Product tid 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

PeosType

Field Name Required Type Description Format

peo

List of PeoType

PeoType

Field Name Required Type Description Format

default

String

Indicates whether peo is default

meta

MetaType

Peo metadata

name

X

String

Peo name

nodes

NodesType

List of NodeType which contains project tid or id

product

X

String

Product tid

template

X

String

Template id

tid

X

String

Technical peo identifier

vals

ValuesType

ProjectsType

Field Name Required Type Description Format

project

List of ProjectType

ProjectType

Field Name Required Type Description Format

meta

MetaType

Channel metadata

id

Long

ID of channel. Either id or tid must always be present when updating an existent channel.

int64

tid

String

TID of channel. Either id or tid must always be present when updating an existent channel. Tid must be present when creating a new channel.

parentId

Long

ID of the parent channel. Either parentId or parenTid must always be present when creating a new channel.

int64

parentTid

String

TID of the parent channel. Either parentId or parenTid must always be present when creating a new channel.

name

X

String

Channel name

vals

ValuesType

links

LinksType

All links e.g. assets.

peos

PeosType

All peos

Welcome to the AI Chat!

Write a prompt to get started...