Site Management API Schemas - Bloomreach Experience - Headless Digital Experience Platform

Site Management API 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

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

ParameterType{
name* string
valueType* stringEnum:
Array [ 5 ]
required boolean
hidden boolean
overlay boolean
defaultValue {
}
displayName string
system boolean

System readonly parameter

config ParameterConfigType{
description:

Field Config

type* string
readOnly: true

the type of this config field

Enum:
Array [ 3 ]
oneOf -> ParameterContentPathType{
pickerConfiguration string
pickerInitialPath string
pickerRememberLastVisited boolean
pickerSelectableNodeTypes [string]
relative boolean
pickerRootPath string
}ParameterDropdownType{
value* [string]
valueListProvider* string
sourceId* string
}ParameterImageSetPathType{
pickerConfiguration string
pickerInitialPath string
pickerRememberLastVisited boolean
pickerSelectableNodeTypes [string]
previewVariant string
}
}
}]
fieldGroups [

field groups

FieldGroup{
name string

Field Group Name

parameters [

Field Group Parameters

string

Field Group Parameters

]
}]

}

FieldGroup

{

name string

Field Group Name

parameters [

Field Group Parameters

string

Field Group Parameters

]

}

ParameterConfigType

{

description:

Field Config

type* string
readOnly: true

the type of this config field

Enum:
Array [ 3 ]
oneOf -> ParameterContentPathType{
pickerConfiguration string
pickerInitialPath string
pickerRememberLastVisited boolean
pickerSelectableNodeTypes [string]
relative boolean
pickerRootPath string
}ParameterDropdownType{
value* [string]
valueListProvider* string
sourceId* string
}ParameterImageSetPathType{
pickerConfiguration string
pickerInitialPath string
pickerRememberLastVisited boolean
pickerSelectableNodeTypes [string]
previewVariant string
}

}

ParameterContentPathType

{

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
oneOf -> {
}ParameterDropdownType{
value* [string]
valueListProvider* string
sourceId* string
}ParameterImageSetPathType{
pickerConfiguration string
pickerInitialPath string
pickerRememberLastVisited boolean
pickerSelectableNodeTypes [string]
previewVariant string
}

}

ParameterDropdownType

{

description:

Field Config

type* string
readOnly: true

the type of this config field

Enum:
Array [ 3 ]
value* [string]
valueListProvider* string
sourceId* string
oneOf -> ParameterContentPathType{
pickerConfiguration string
pickerInitialPath string
pickerRememberLastVisited boolean
pickerSelectableNodeTypes [string]
relative boolean
pickerRootPath string
}{
}ParameterImageSetPathType{
pickerConfiguration string
pickerInitialPath string
pickerRememberLastVisited boolean
pickerSelectableNodeTypes [string]
previewVariant string
}

}

ParameterImageSetPathType

{

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
oneOf -> ParameterContentPathType{
pickerConfiguration string
pickerInitialPath string
pickerRememberLastVisited boolean
pickerSelectableNodeTypes [string]
relative boolean
pickerRootPath string
}ParameterDropdownType{
value* [string]
valueListProvider* string
sourceId* string
}{
}

}

ParameterType

{

name* string
valueType* stringEnum:
Array [ 5 ]
required boolean
hidden boolean
overlay boolean
defaultValue {
}
displayName string
system boolean

System readonly parameter

config ParameterConfigType{
description:

Field Config

type* string
readOnly: true

the type of this config field

Enum:
Array [ 3 ]
oneOf -> ParameterContentPathType{
pickerConfiguration string
pickerInitialPath string
pickerRememberLastVisited boolean
pickerSelectableNodeTypes [...]
relative boolean
pickerRootPath string
}ParameterDropdownType{
value* [string]
valueListProvider* string
sourceId* string
}ParameterImageSetPathType{
pickerConfiguration string
pickerInitialPath string
pickerRememberLastVisited boolean
pickerSelectableNodeTypes [string]
previewVariant string
}
}

}

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)

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

< * >: string

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{
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{
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 ]
}]

}

SitemapItem

{

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

}
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.

{
}]

}

Did you find this page helpful?
How could this documentation serve you better?
On this page
    Did you find this page helpful?
    How could this documentation serve you better?