Schemas

Site Management API schemas

CatalogGroup

Properties

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

ComponentDefinition

Properties

property	required	type	description
id	Y	string	identifier of this component definition: {group}/{name}
extends	Y	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', eg 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		array[] of Parameter	custom (residual) or customized (overlaying) parameters for this component definition. Parameters with config type 'imagesetpath' are not allowed
fieldGroups		array[] of FieldGroup	field groups

FieldGroup

Properties

property	type	description
name	string	Field Group Name
displayName	string	Field Group Display Name
parameters	array[] of strings	Field Group Parameters

KeyLabel

Expects an array of key-label values.

Properties

property	required	type	description	details	example
key	Y	string	key validation of the field. Expects a string value
label	Y	string	label validation of the field. Expects a string value

Parameter

Properties

property	required	type	description	details
name	Y	string
valueType	Y	enum		string calendar boolean integer number
required		boolean
hidden		boolean
overlay		boolean
defaultValue		object
displayName		string
system		boolean	System readonly parameter
config		ParameterConfig

ParameterConfig

Field Config, or null if this parameter is neither of the types below. The config type 'imagesetpath' cannot be used with component parameters but only with channel parameters

Properties

property	required	type	description	details	example
type	Y	enum	the type of this config field	contentpath dropdown imagesetpath

ParameterContentPath

This config type is used when a document picker is needed in the CMS UI. See Define Configuration Parameters for Components

Properties

property	required	type	description	details
pickerConfiguration		string
pickerInitialPath		string
pickerRememberLastVisited		boolean
pickerSelectableNodeTypes		array[] of strings
relative		boolean
pickerRootPath		string
enableUpload		boolean
type	Y	enum	the type of this config field	contentpath dropdown imagesetpath

ParameterDropdown

This config type is used when a dropdown list is needed in the CMS UI. See Define Configuration Parameters for Components

Properties

property	required	type	description	details
value	Y	array[] of strings
structuredValues		array[] of KeyLabel	Expects an array of key-label values.
valueListProvider		string
sourceId	Y	string
type	Y	enum	the type of this config field	contentpath dropdown imagesetpath

ParameterImageSetPath

This config type is used when an image picker is needed in the CMS UI

Properties

property	required	type	description	details
pickerConfiguration		string
pickerInitialPath		string
pickerRememberLastVisited		boolean
pickerSelectableNodeTypes		array[] of strings
previewVariant		string
enableUpload		boolean
type	Y	enum	the type of this config field	contentpath dropdown imagesetpath

Channel

Properties

property	required	type	description
id		string	identifier for a specific channel branch; constructed as "-"
name	Y	string	identifying name of a channel
projectName	Y	string	channel's project name
branch		string	name of the channel branch
branchOf		string	name of channel branch this branch is branched from (if branched)
externalPreviewEnabled		boolean	External preview flag
externalPreviewToken		string	External preview token
updateComponentContentOnPageSync		boolean	The default value of updateContentOnPageSync property on page specific component instances in pages, which identifies if the content of the component instance as a target page will be overwritten with the content from the soure page in page synchronization.
contentRootPath	Y	string	the (repository) content path (as child of /content) to be used as base content path for this channel; cannot be (only) /
icon		string	the icon used to identify the channel, stored as a Data URL (data:[][;base64],)
locale		string	(content) locale to be used and assumed for this channel
devices		array[] of strings	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		object	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		object	a map of parameters (names/values) for this Channel

ChannelBranch

Properties

property	required	type	description	details	example
branchOf	Y	string	name of the channel
branch	Y	string	name of the channel branch (project id)

AbstractComponent

the components that are defined in the current layout

Properties

property	required	type	description	details
name	Y	string	identifying name of this component within its page
label		string	default display label for this component
description		string	description for this component
parameters		object	a map of string parameters (names/values) for this component
xtype		enum	the layout used for rendering inner containers	hst.vbox hst.unorderedlist hst.orderedlist hst.span hst.nomarkup
type	Y	enum	the type of this component	static managed

Layout

Properties

property	required	type	description	details
name	Y	string	identifying name of this layout within its channel
label		string	default display label for this layout
description		string	description for this layout
parameters		object	a map of string parameters (names/values) for this layout
type	Y	enum	page type defines the usage. Only abstract pages can be extended. Valid values: abstract, page, xpage	abstract page xpage
extends		string	the name of the (abstract) page extended by this layout
components		array[] of AbstractComponent	the components that are defined in the current layout

ManagedComponent

StaticComponent

Properties

property	required	type	description	details	example
definition		string	the catalog component definition this component is based on
components		array[] of AbstractComponent	the components that are defined in the current page

Route

Properties

property	required	type	description
name	Y	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		object	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		object	a more specialized page (name) mapping based on the matched document its type
items		array[] of Route	a list of child sitemap items.

SitemenuItem

Properties

property	required	type	description
name	Y	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		object	the properties of this menu item. They will be available on the Experience Manager for Site Editors to view/edit
items		array[] of SitemenuItem	nested site menu items