v1

latestOpenAPI 3.1.02026-07-2683111282.3 KB
Channel Layout Operations

Create or update a channel layout

put/channels/{channel_id}/layouts/{layout_name}

Path parameters

channel_idstring required

Channel id. Optionally includes the project id, separated by a dash: mychannel-branchId

layout_namestring required

Name of layout

Headers

X-Resource-Versionstring

Resource's version. Must be used in any subsequent update requests of this resource. Can be obtained when GETting the resource

Request body

namestring required

identifying name of this layout within its channel

labelstring

default display label for this layout

descriptionstring

description for this layout

parametersobject

a map of string parameters (names/values) for this layout

type'abstract' | 'page' | 'xpage' required

page type defines the usage. Only abstract pages can be extended. Valid values: abstract, page, xpage

extendsstring

the name of the (abstract) page extended by this layout

Response

OK

namestring required

identifying name of this layout within its channel

labelstring

default display label for this layout

descriptionstring

description for this layout

parametersobject

a map of string parameters (names/values) for this layout

type'abstract' | 'page' | 'xpage' required

page type defines the usage. Only abstract pages can be extended. Valid values: abstract, page, xpage

extendsstring

the name of the (abstract) page extended by this layout