Schemas

Content Management API schemas

Document

A document is a content item in the Content repository. See Content types and General concepts

Properties

property	required	type	description	details
contentType	Y	string	the content type of the document (eg banner, newsArticle). The value for the contentType may optionally include the namespace prefix; this is only required in case the type is in a namespace other than 'brxsaas', eg mynamespace:content
fields	Y	array[] of DocumentField	fields of this document. A document field represents an attribute of the document, as specified in the document's content type. See Content type fields and General concepts
name	Y	string	identifying name of this document. Only valid characters are lowercase alphanumeric, dash, dot, and underscore. This value appears in URLs. The value must alsomatch the document name(last part of the path) in the document path.	pattern : ^[a-z0-9-._]*
displayName	Y	string	name of this document. Used in labels in the CMS UI and in Delivery API. The displayName can only be set if either is true:a. the document is new, b. the document only exists in the project specified in this operation
locale		string	locale of the document
path	Y	string	absolute path of this document in the content repository
system		System

DocumentField

A document field represents an attribute of the document, as specified in the document's content type. See Content type fields and General concepts

Properties

property	required	type	description	details	example
name	Y	string	identifying name of this field. Value needs to correspond to the name of a field definition in the document's content type	pattern : ^[A-Za-z0-9_]*
value	Y	array[] of FieldValue	value of a field. As fields can be multiple, this attribute is an array of values

EmbeddedResourceFieldValue

See EmbeddedResource

Properties

property	required	type	description
filename	Y	string	the name of the file that is used as default value
binarydata	Y	string	the binary data of the file that is used as default value. This data has to be encoded using base64
mimeType	Y	string	the mimeType of the file to be uploaded

FieldGroupFieldValue

See FieldGroup

Properties

property	required	type	description	details	example
fields	Y	object	fields from FieldGroup or SelectableFieldGroup

FieldValue

Value of a field

SelectableFieldGroupFieldValue

See Selectable FieldGroup

Properties

property	required	type	description	details	example
fields	Y	object	fields from FieldGroup or SelectableFieldGroup
fieldGroupType	Y	string	the name of the fieldgroup type this default value is provided for. Unless the field group type belongs to the default group ('brxsaas'), the name must be prefixed with the group name and the colon character, e.g. 'mygroup:myfieldgrouptype'

System

system properties

Properties

property	required	type	description	details	example
createdBy		string
createdAt		date-time
updatedBy		string
updatedAt		date-time

BaseDocument

The internal data of a document, including content type and fields

Properties

property	required	type	description	details	example
contentType	Y	string	the content type of the document (eg banner, newsArticle). The value for the contentType may optionally include the namespace prefix; this is only required in case the type is in a namespace other than 'brxsaas', eg mynamespace:content
fields	Y	array[] of DocumentField	fields of this document. A document field represents an attribute of the document, as specified in the document's content type. See Content type fields and General concepts

Page

Properties

property	required	type	description	details
name	Y	string	identifying name of this page. Only valid characters are lowercase alphanumeric, dot, dash and underscore. This value appears in URLs	pattern : ^[a-z0-9-._]*
displayName	Y	string	name of this page. Used in labels in the CMS UI and in Delivery API. The displayName can only be set if either is true:a. the page is new, b. the page only exists in the project specified in this operation
locale		string	locale of the document
layout	Y	string	the page template
document	Y	BaseDocument
containers		array[] of PageContainer	array of containers of this page
system		System

PageComponent

array of components used in this container

Properties

property	required	type	description	details	example
componentDefinition		string
componentConfigurations		array[] of PageComponentConfiguration	The list of component configurations for this component

PageComponentConfiguration

A configuration for a PageComponent

Properties

property	type	description
id	string	The id of this configuration. The id of the default variant of a component should be DEFAULT, for the rest of the variants, the variant id is created in the format of campaign_id:campaign_segment_id or segmentation_id:segment_id, See Segmentation & Campaigns
content	BaseDocument
parameters	array[] of StringParameter	The list of component parameters for this configuration

PageContainer

array of containers of this page

Properties

property	required	type	description	details	example
path	Y	string	path of the container
components		array[] of PageComponent	array of components used in this container

StringParameter

The list of component parameters for this configuration

Properties

property	required	type	description	details	example
name		string	name of this parameter
value		string	value of this parameter

ResouceBundleKey

It defines a key in a resource bundle which is used to retrieve a localized message from the resource bundle

Properties

property	required	type	description	details	example
name	Y	string	identifying the key name that is used to retrieve a localized message from the resource bundle, unique within the resource bundle. Valid characters are only lower/uppercase letters, numbers, and '-' '.' '_'	pattern : ^[a-zA-Z0-9-._]*
description		string	description of this resource bundle key

ResouceBundleMessage

a key-value pair that defines the message for a specific key in a value set.

Properties

property	required	type	description	details	example
key	Y	string	identifying key of the message. The keys that are defined as 'ResouceBundleKey' can be set here. Only valid characters are lower/uppercase letters, numbers, and '-' '.' '_'	pattern : ^[a-zA-Z0-9-._]*
value		string	value of this resource bundle message

ResourceBundle

A resource bundle is a collection of key-message pairs organized by value sets which are mostly locales. It simplify the creation of internationalized applications by allowing you to conveniently store all locale-specific messages in a single place.

Properties

property	required	type	description	details
name	Y	string	identifying name of this resource bundle. Only valid characters are lowercase alphanumeric, dash, dot, and underscore. This value appears in URLs. The value must alsomatch the document name(last part of the path) in the document path.	pattern : ^[a-z0-9-._]*
displayName	Y	string	name of this resource bundle. Used in labels in the CMS UI
id	Y	string	id of the resource bundle which is expected to be unique in content application. The resource bundle is assigned with this unique id.	pattern : ^[a-zA-Z0-9-._]*
path	Y	string	absolute path of this resource bundle in the content repository
keys	Y	array[] of ResouceBundleKey	keys of the resource bundle. The messages in a resource bundle are fetched by key values.
valueSets	Y	array[] of ResourceBundleValueSet	value sets of the resource bundle. Typically, a value set represents all values for a specific locale inside the resource bundle.
system		System

ResourceBundleValueSet

A value set represents all messages for a specific locale(mostly) inside the resource bundle.Default messages are defined in a specific value set named 'DEFAULT'.

Properties

property	required	type	description	details	example
messages		array[] of ResouceBundleMessage	messages in the value set
name	Y	string	name of the message value set. Expects a string value. Default messages are defined in a specific value set named 'DEFAULT'.For locale specicific messages, locale names are defined as value set name such as 'nl' (Dutch) or 'en_US' (American English	pattern : ^[a-zA-Z0-9-._]*

DetailedTranslationSource

Detailed view of the translations of content

Properties

property	type	description	details
path	string	path of the content
type	enum	type of the content	document page folder
translations	array[] of DetailedTranslationTarget	pages with merge or rebase errors

DetailedTranslationTarget

Detailed view of the translation target

Properties

property	type	description	details
path	string	path of the content
locale	string	locale of the content
status	enum	status of the content	linked suggested

SimpleTranslationSource

Simple view of the translation suggestions of content

Properties

property	required	type	description	details	example
path		string	path of the content
translations		array[] of strings	paths of the translation suggestions

TranslationJob

Translation job operation details

Properties

property	type	description	details
operationId	string	generated unique id for the operation
status	enum	status of the operation	COMPLETED STARTING STARTED STOPPING STOPPED FAILED ABANDONED
exitMessage	string	exit message in case of operation failure
readCount	integer	number of records in input payload	format : int32
writeCount	integer	written items	format : int32
skipCount	integer	skipped items	format : int32
startTime	date-time	operation start time
endTime	date-time	operation end time
errorLog	array[] of strings	error logs for failed linking operations