Site Management API schemas
CatalogGroup
Â
Properties
property | required | type | description | details | example |
---|---|---|---|---|---|
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 | details | example |
---|---|---|---|---|---|
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 | required | type | description | details | example |
---|---|---|---|---|---|
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 | example |
---|---|---|---|---|---|
name | Y | string | Â | Â | Â |
valueType | Y | enum | Â |
| Â |
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 |
| Â |
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 | example |
---|---|---|---|---|---|
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 |
| Â |
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 | example |
---|---|---|---|---|---|
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 |
| Â |
ParameterImageSetPath
This config type is used when an image picker is needed in the CMS UI
Properties
property | required | type | description | details | example |
---|---|---|---|---|---|
pickerConfiguration | Â | string | Â | Â | Â |
pickerInitialPath | Â | string | Â | Â | Â |
pickerRememberLastVisited | Â | boolean | Â | Â | Â |
pickerSelectableNodeTypes | Â | array[] of strings | Â | Â | Â |
previewVariant | Â | string | Â | Â | Â |
enableUpload | Â | boolean | Â | Â | Â |
type | Y | enum | the type of this config field |
| Â |
Channel
Â
Properties
property | required | type | description | details | example |
---|---|---|---|---|---|
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 | example |
---|---|---|---|---|---|
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 |
| Â |
type | Y | enum | the type of this component |
| Â |
Layout
Â
Properties
property | required | type | description | details | example |
---|---|---|---|---|---|
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 |
| Â |
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 | details | example |
---|---|---|---|---|---|
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 | details | example |
---|---|---|---|---|---|
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 | Â | Â |