Schemas

ComponentDefinition


id*	string identifier of this component definition: {group}/{name}
extends*	string {group}/{name} id of the component definition this definition extends from
hidden	boolean indicator if this component definition is configurable in the ChannelManager UI
system	boolean indicator if this a protected (system) component definition; if true, implies hidden is true
xtype	string frontend layout type
ctype	string frontend component type
contentType	string contentType for cases where the component should also create content: when putting, the contentType must be an existing document compound type, otherwise the request is not executed. 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', e.g. mynamespace:titleandtext.
label	string default display name of this component definition in the ChannelManager UI
icon	string base64 representation of the icon for this component definition in the ChannelManager UI
parameters	custom (residual) or customized (overlaying) parameters for this component definition Parameter (details provided in Table 1 below)
fieldGroups	field groups FieldGroup
	name	string Field Group Name
	parameters	[ Field Group Parameters string Field Group Parameters ]

Table 1

Parameter
name*	string
valueType*	stringEnum: Array [ 5 ]
required	boolean
hidden	boolean
overlay	boolean
defaultValue	{ }
displayName	string
system	boolean System readonly parameter
config	ParameterConfig (details provided in Table 2 below)

Table 2

ParameterConfig
description:	Field Config
type*	string readOnly: true the type of this config field Enum: [ contentpath, dropdown, imagesetpath ]
oneOf ->	ParameterContentPath (details provided in Table A below)
	ParameterDropdown (details provided in Table B below)
	ParameterImageSetPath (details provided in Table C below)

Table A

ParameterContentPath
pickerConfiguration	string
pickerInitialPath	string
pickerRememberLastVisited	boolean
pickerSelectableNodeTypes	[string]
relative	boolean
pickerRootPath	string
enableUpload	boolean

Table B

ParameterDropdown
value*	[string]
valueListProvider*	string
sourceId*	string

Table C

ParameterImageSetPath
pickerConfiguration	string
pickerInitialPath	string
pickerRememberLastVisited	boolean
pickerSelectableNodeTypes	[string]
previewVariant	string
enableUpload	boolean

FieldGroup


name	string Field Group Name
parameters	[ Field Group Parameters string Field Group Parameters ]

ParameterConfig


description:	Field Config
type*	string readOnly: true the type of this config field Enum: Array [ 3 ]
oneOf ->	ParameterContentPath
	pickerConfiguration	string
	pickerInitialPath	string
	pickerRememberLastVisited	boolean
	pickerSelectableNodeTypes	[string]
	relative	boolean
	pickerRootPath	string
	enableUpload	boolean

	ParameterDropdown
	value*	[string]
	valueListProvider*	string
	sourceId*	string

	ParameterImageSetPath
	pickerConfiguration	string
	pickerInitialPath	string
	pickerRememberLastVisited	boolean
	pickerSelectableNodeTypes	[string]
	previewVariant	string
	enableUpload	boolean

ParameterContentPath


description:	Field Config
type*	string readOnly: true the type of this config field Enum: Array [ 3 ]
pickerConfiguration	string
pickerInitialPath	string
pickerRememberLastVisited	boolean
pickerSelectableNodeTypes	[string]
relative	boolean
pickerRootPath	string
enableUpload	boolean

ParameterDropdown


description:	Field Config
type*	string readOnly: true the type of this config field Enum: Array [ 3 ]
value*	[string]
valueListProvider*	string
sourceId*	string

ParameterImageSetPath


description:	Field Config
type*	string readOnly: true the type of this config field Enum: Array [ 3 ]
pickerConfiguration	string
pickerInitialPath	string
pickerRememberLastVisited	boolean
pickerSelectableNodeTypes	[string]
previewVariant	string
enableUpload	boolean

Parameter


name*	string
valueType*	stringEnum: Array [ 5 ]
required	boolean
hidden	boolean
overlay	boolean
defaultValue	{ }
displayName	string
system	boolean System readonly parameter
config	ParameterConfig
	description:	Field Config
	type*	string readOnly: true the type of this config field Enum: Array [ 3 ]
	oneOf ->	ParameterContentPath (details provided in Table A)
		ParameterDropdown (details provided in Table B)
		ParameterImageSetPath (details provided in Table C)

Table A

ParameterContentPath
pickerConfiguration	string
pickerInitialPath	string
pickerRememberLastVisited	boolean
pickerSelectableNodeTypes	[...]
relative	boolean
pickerRootPath	string
enableUpload	boolean

Table B

ParameterDropdown
value*	[string]
valueListProvider*	string
sourceId*	string

Table C

ParameterImageSetPath
pickerConfiguration	string
pickerInitialPath	string
pickerRememberLastVisited	boolean
pickerSelectableNodeTypes	[string]
previewVariant	string
enableUpload	boolean

CatalogGroup


name*	string identifying name of a catalog group for its channel; "base" is a reserved and predefined (system) group name
hidden	boolean default: false indicator if this catalog group (and its resources, e.g. components) will be available in the ChannelManager UI
system	boolean default: false indicator if this catalog group (and its resources, e.g. components) are protected; if true implies hidden is true

Channel


id	string identifier for a specific channel branch; constructed as "-"
name*	string identifying name of a channel
branch	string name of the channel branch
branchOf	string name of channel branch this branch is branched from (if branched), currently always 'master'
contentRootPath*	string the (repository) content path (as child of /content) to be used as base content path for this channel; cannot be (only) /
locale	string (content) locale to be used and assumed for this channel
devices	[ names and width of supported delivery tier 'devices' to choose from for the Channel Manager (preview) rendering string names and width of supported delivery tier 'devices' to choose from for the Channel Manager (preview) rendering ]
defaultDevice	string name of the default 'device' to use by default for the Channel Manager (preview) rendering, defaults to "default" if not configured
responseHeaders	description:	optional response headers to provide on a (PMA) response
	< * >:	string optional response headers to provide on a (PMA) response
linkurlPrefix	string The prefix to prepend to links when the Channel PMA is accessed through a reverse proxy
cdnHost	string The CDN to use (where applicable and possible)
remoteHostProtection	boolean Whether remote host protection is enabled
parameters	description:	a map of parameters (names/values) for this Channel
	< * >:	description:	a map of parameters (names/values) for this Channel

AbstractComponent


description:	the components that are defined in the current layout
name*	string readOnly: true identifying name of this component within its page
label	string default display label for this component
description	string description for this component
parameters	description:	a map of string parameters (names/values) for this component
	< * >:	string a map of string parameters (names/values) for this component
xtype	string the layout used for rendering inner containers Enum: Array [ 5 ]
type*	string readOnly: true the type of this component Enum: Array [ 2 ]

Layout


name*	string readOnly: true identifying name of this layout within its channel
label	string default display label for this layout
description	string description for this layout
parameters	description:	a map of string parameters (names/values) for this layout
	< * >:	a map of string parameters (names/values) for this layout
type*	string readOnly: true page type defines the usage. Only abstract pages can be extended. Valid values: abstract, page, xpage Enum: Array [ 3 ]
extends	string the name of the (abstract) page extended by this layout
components	the components that are defined in the current layout AbstractComponent (details provided in Table A)

Table A

AbstractComponent
description:	the components that are defined in the current layout
name*	string readOnly: true identifying name of this component within its page
label	string default display label for this component
description	string description for this component
parameters	description:	a map of string parameters (names/values) for this component
	< * >:	string a map of string parameters (names/values) for this component
xtype	string the layout used for rendering inner containers Enum: Array [ 5 ]
type*	string readOnly: true the type of this component Enum: Array [ 2 ]

ManagedComponent


description:	the components that are defined in the current layout
name*	string readOnly: true identifying name of this component within its page
label	string default display label for this component
description	string description for this component
parameters	description:	a map of string parameters (names/values) for this component
	< * >:	string a map of string parameters (names/values) for this component
xtype	string the layout used for rendering inner containers Enum: Array [ 5 ]
type*	string readOnly: true the type of this component Enum: Array [ 2 ]

StaticComponent


description:	the components that are defined in the current layout
name*	string readOnly: true identifying name of this component within its page
label	string default display label for this component
description	string description for this component
parameters	description:	a map of string parameters (names/values) for this component
	< * >:	string a map of string parameters (names/values) for this component
xtype	string the layout used for rendering inner containers Enum: Array [ 5 ]
type*	string readOnly: true the type of this component Enum: Array [ 2 ]
definition	string the catalog component definition this component is based on
components	the components that are defined in the current page AbstractComponent (details provided in table A)

Table A

AbstractComponent
description:	the components that are defined in the current layout
name*	string readOnly: true identifying name of this component within its page
label	string default display label for this component
description	string description for this component
parameters	description:	a map of string parameters (names/values) for this component
	< * >:	string a map of string parameters (names/values) for this component
xtype	string the layout used for rendering inner containers Enum: Array [ 5 ]
type*	string readOnly: true the type of this component Enum: Array [ 2 ]

Route


name*	string the name (url path element) of the sitemap item. Each sitemap item name must be unique between its siblings.
layout	string the name of the (default) layout definition for rendering a url matching this sitemap item
pageTitle	string default page (header) title
relativeContentPath	string the (base) content path, relative to the channel (base) content path to use for rendering this sitemap item page, or any of its children
referenceId	string the (unique) reference id value can be used instead of the content path to create a direct link to this sitemap item
parameters	description:	a map of string parameters (names/values) for rendering this sitemap item page
	< * >:	string a map of string parameters (names/values) for rendering this sitemap item page
documentRequired	boolean boolean value if the URL should have a (primary) document or folder item. Default false when missing. If the value is true and the URL does not map to a specific content item, the PageModelApi returns a 404 page.
doctypePages	description:	a more specialized page (name) mapping based on the matched document its type
	< * >:	string a more specialized page (name) mapping based on the matched document its type
items	[ a list of child sitemap items. { }]

SitemenuItem


name*	string the name of this menu item
link	string the link of this menu item. It can be either an external url or a reference to an internal route (e.g. 'home')
properties	<*> the properties of this menu item. They will be available on the Experience Manager for Site Editors to view/edit
items	[SitemenuItem] nested site menu items