Schemas

Site Management API schemas

CatalogGroup

 

Properties

propertyrequiredtypedescriptiondetailsexample
nameYstringidentifying name of a catalog group for its channel; "base" is a reserved and predefined (system) group name  
hidden booleanindicator if this catalog group (and its resources, e.g. components) will be available in the ChannelManager UI  
system booleanindicator if this catalog group (and its resources, e.g. components) are protected; if true implies hidden is true  

ComponentDefinition

 

Properties

propertyrequiredtypedescriptiondetailsexample
idYstringidentifier of this component definition: {group}/{name}  
extendsYstring{group}/{name} id of the component definition this definition extends from  
hidden booleanindicator if this component definition is configurable in the ChannelManager UI  
system booleanindicator if this a protected (system) component definition; if true, implies hidden is true  
xtype stringfrontend layout type  
ctype stringfrontend component type  
contentType stringcontentType 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 stringdefault display name of this component definition in the ChannelManager UI  
icon stringbase64 representation of the icon for this component definition in the ChannelManager UI  
parameters array[] of Parametercustom (residual) or customized (overlaying) parameters for this component definition. Parameters with config type 'imagesetpath' are not allowed  
fieldGroups array[] of FieldGroupfield groups  

FieldGroup

 

Properties

propertyrequiredtypedescriptiondetailsexample
name stringField Group Name  
displayName stringField Group Display Name  
parameters array[] of stringsField Group Parameters  

KeyLabel

Expects an array of key-label values.

Properties

propertyrequiredtypedescriptiondetailsexample
keyYstringkey validation of the field. Expects a string value  
labelYstringlabel validation of the field. Expects a string value  

Parameter

 

Properties

propertyrequiredtypedescriptiondetailsexample
nameYstring   
valueTypeYenum 
  • string
  • calendar
  • boolean
  • integer
  • number
 
required boolean   
hidden boolean   
overlay boolean   
defaultValue object   
displayName string   
system booleanSystem 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

propertyrequiredtypedescriptiondetailsexample
typeYenumthe 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

propertyrequiredtypedescriptiondetailsexample
pickerConfiguration string   
pickerInitialPath string   
pickerRememberLastVisited boolean   
pickerSelectableNodeTypes array[] of strings   
relative boolean   
pickerRootPath string   
enableUpload boolean   
typeYenumthe 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

propertyrequiredtypedescriptiondetailsexample
valueYarray[] of strings   
structuredValues array[] of KeyLabelExpects an array of key-label values.  
valueListProvider string   
sourceIdYstring   
typeYenumthe 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

propertyrequiredtypedescriptiondetailsexample
pickerConfiguration string   
pickerInitialPath string   
pickerRememberLastVisited boolean   
pickerSelectableNodeTypes array[] of strings   
previewVariant string   
enableUpload boolean   
typeYenumthe type of this config field
  • contentpath
  • dropdown
  • imagesetpath
 

Channel

 

Properties

propertyrequiredtypedescriptiondetailsexample
id stringidentifier for a specific channel branch; constructed as "-"  
nameYstringidentifying name of a channel  
projectNameYstringchannel's project name  
branch stringname of the channel branch  
branchOf stringname of channel branch this branch is branched from (if branched)  
externalPreviewEnabled booleanExternal preview flag  
externalPreviewToken stringExternal preview token  
updateComponentContentOnPageSync booleanThe 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.  
contentRootPathYstringthe (repository) content path (as child of /content) to be used as base content path for this channel; cannot be (only) /  
icon stringthe 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 stringsnames and width of supported delivery tier 'devices' to choose from for the Channel Manager (preview) rendering  
defaultDevice stringname of the default 'device' to use by default for the Channel Manager (preview) rendering, defaults to "default" if not configured  
responseHeaders objectoptional response headers to provide on a (PMA) response  
linkurlPrefix stringThe prefix to prepend to links when the Channel PMA is accessed through a reverse proxy  
cdnHost stringThe CDN to use (where applicable and possible)  
remoteHostProtection booleanWhether remote host protection is enabled  
parameters objecta map of parameters (names/values) for this Channel  

ChannelBranch

 

Properties

propertyrequiredtypedescriptiondetailsexample
branchOfYstringname of the channel  
branchYstringname of the channel branch (project id)  

AbstractComponent

the components that are defined in the current layout

Properties

propertyrequiredtypedescriptiondetailsexample
nameYstringidentifying name of this component within its page  
label stringdefault display label for this component  
description stringdescription for this component  
parameters objecta map of string parameters (names/values) for this component  
xtype enumthe layout used for rendering inner containers
  • hst.vbox
  • hst.unorderedlist
  • hst.orderedlist
  • hst.span
  • hst.nomarkup
 
typeYenumthe type of this component
  • static
  • managed
 

Layout

 

Properties

propertyrequiredtypedescriptiondetailsexample
nameYstringidentifying name of this layout within its channel  
label stringdefault display label for this layout  
description stringdescription for this layout  
parameters objecta map of string parameters (names/values) for this layout  
typeYenumpage type defines the usage. Only abstract pages can be extended. Valid values: abstract, page, xpage
  • abstract
  • page
  • xpage
 
extends stringthe name of the (abstract) page extended by this layout  
components array[] of AbstractComponentthe components that are defined in the current layout  

ManagedComponent

 

StaticComponent

 

Properties

propertyrequiredtypedescriptiondetailsexample
definition stringthe catalog component definition this component is based on  
components array[] of AbstractComponentthe components that are defined in the current page  

Route

 

Properties

propertyrequiredtypedescriptiondetailsexample
nameYstringthe name (url path element) of the sitemap item. Each sitemap item name must be unique between its siblings.  
layout stringthe name of the (default) layout definition for rendering a url matching this sitemap item  
pageTitle stringdefault page (header) title  
relativeContentPath stringthe (base) content path, relative to the channel (base) content path to use for rendering this sitemap item page, or any of its children  
referenceId stringthe (unique) reference id value can be used instead of the content path to create a direct link to this sitemap item  
parameters objecta map of string parameters (names/values) for rendering this sitemap item page  
documentRequired booleanboolean 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 objecta more specialized page (name) mapping based on the matched document its type  
items array[] of Routea list of child sitemap items.  

SitemenuItem

 

Properties

propertyrequiredtypedescriptiondetailsexample
nameYstringthe name of this menu item  
link stringthe link of this menu item. It can be either an external url or a reference to an internal route (e.g. 'home')  
properties objectthe properties of this menu item. They will be available on the Experience Manager for Site Editors to view/edit  
items array[] of SitemenuItemnested site menu items Â