Channel Layout Operations - Bloomreach Experience - The Headless Digital Experience Platform Built for Commerce

Channel Layout Operations

GET​ /channels​/{channel_id}​/layouts

Get the channel layouts.

Parameters

Name Description

channel_id *

string

(path)

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

Example : brxsaas-vIUy9

Responses

Code Description
200

OK

Media type: application/json

Schema: [Layout]

Example:

[
  {
    "name": "content",
    "label": null,
    "description": null,
    "parameters": {},
    "type": "page",
    "extends": "base",
    "components": [
      {
        "name": "main",
        "label": null,
        "description": null,
        "parameters": {},
        "xtype": null,
        "definition": null,
        "components": [
          {
            "name": "container",
            "label": null,
            "description": null,
            "parameters": {},
            "xtype": "hst.nomarkup",
            "type": "managed"
          }
        ],
        "type": "static"
      },
      {
        "name": "right",
        "label": null,
        "description": null,
        "parameters": {},
        "xtype": null,
        "definition": null,
        "components": [
          {
            "name": "container",
            "label": null,
            "description": null,
            "parameters": {},
            "xtype": "hst.nomarkup",
            "type": "managed"
          }
        ],
        "type": "static"
      }
    ]
  }
]
403

Forbidden

GET ​/channels​/{channel_id}​/layouts​/{layout_name}

Get a channel layout.

Parameters

Name Description

channel_id *

string

(path)

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

Example : brxsaas-vIUy9

layout_name *

string

(path)

Name of layout

Example : content

resolved

boolean

(query)

Default value : false

--truefalse

Responses

Code Description
200

OK

Media type: application/json

Schema: Layout

Example:

{
  "name": "content",
  "label": null,
  "description": null,
  "parameters": {},
  "type": "page",
  "extends": "base",
  "components": [
    {
      "name": "main",
      "label": null,
      "description": null,
      "parameters": {},
      "xtype": null,
      "definition": null,
      "components": [
        {
          "name": "container",
          "label": null,
          "description": null,
          "parameters": {},
          "xtype": "hst.nomarkup",
          "type": "managed"
        }
      ],
      "type": "static"
    },
    {
      "name": "right",
      "label": null,
      "description": null,
      "parameters": {},
      "xtype": null,
      "definition": null,
      "components": [
        {
          "name": "container",
          "label": null,
          "description": null,
          "parameters": {},
          "xtype": "hst.nomarkup",
          "type": "managed"
        }
      ],
      "type": "static"
    }
  ]
}

Headers:

Name Description Type
X-Resource-Version

Resource's version. Must be used in any subsequent update requests of this resource

string
403

Forbidden

404

Not Found

PUT​ /channels​/{channel_id}​/layouts​/{layout_name}

Create or update a channel layout.

Parameters

Name Description

X-Resource-Version

string

(header)

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

Example : 433cc90445d29c2356e385b9efe548b19ed86739f27eb7958a81847b9d8517c2

channel_id *

string

(path)

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

Example : brxsaas-vIUy9

layout_name *

string

(path)

Name of layout

Example : content

Request body

application/json

Schema: Layout

Example:

{
  "name": "content",
  "label": null,
  "description": null,
  "parameters": {},
  "type": "page",
  "extends": "base",
  "components": [
    {
      "name": "main",
      "label": null,
      "description": null,
      "parameters": {},
      "xtype": null,
      "definition": null,
      "components": [
        {
          "name": "container",
          "label": null,
          "description": null,
          "parameters": {},
          "xtype": "hst.nomarkup",
          "type": "managed"
        }
      ],
      "type": "static"
    },
    {
      "name": "right",
      "label": null,
      "description": null,
      "parameters": {},
      "xtype": null,
      "definition": null,
      "components": [
        {
          "name": "container",
          "label": null,
          "description": null,
          "parameters": {},
          "xtype": "hst.nomarkup",
          "type": "managed"
        }
      ],
      "type": "static"
    }
  ]
}

Responses

Code Description
200

OK

Media type: application/json

Schema: Layout

Example:

{
  "name": "content",
  "label": null,
  "description": null,
  "parameters": {},
  "type": "page",
  "extends": "base",
  "components": [
    {
      "name": "main",
      "label": null,
      "description": null,
      "parameters": {},
      "xtype": null,
      "definition": null,
      "components": [
        {
          "name": "container",
          "label": null,
          "description": null,
          "parameters": {},
          "xtype": "hst.nomarkup",
          "type": "managed"
        }
      ],
      "type": "static"
    },
    {
      "name": "right",
      "label": null,
      "description": null,
      "parameters": {},
      "xtype": null,
      "definition": null,
      "components": [
        {
          "name": "container",
          "label": null,
          "description": null,
          "parameters": {},
          "xtype": "hst.nomarkup",
          "type": "managed"
        }
      ],
      "type": "static"
    }
  ]
}

Headers:

Name Description Type
X-Resource-Version

Resource's version. Must be used in any subsequent update requests of this resource

string
201

Created

Media type: application/json

Schema: Layout

Example:

{
  "name": "content",
  "label": null,
  "description": null,
  "parameters": {},
  "type": "page",
  "extends": "base",
  "components": [
    {
      "name": "main",
      "label": null,
      "description": null,
      "parameters": {},
      "xtype": null,
      "definition": null,
      "components": [
        {
          "name": "container",
          "label": null,
          "description": null,
          "parameters": {},
          "xtype": "hst.nomarkup",
          "type": "managed"
        }
      ],
      "type": "static"
    },
    {
      "name": "right",
      "label": null,
      "description": null,
      "parameters": {},
      "xtype": null,
      "definition": null,
      "components": [
        {
          "name": "container",
          "label": null,
          "description": null,
          "parameters": {},
          "xtype": "hst.nomarkup",
          "type": "managed"
        }
      ],
      "type": "static"
    }
  ]
}

Headers:

Name Description Type
X-Resource-Version

Resource's version. Must be used in any subsequent update requests of this resource

string
403

Forbidden

DELETE​ /channels​/{channel_id}​/layouts​/{layout_name}

Delete a channel layout.

Parameters

Name Description

channel_id *

string

(path)

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

Example : brxsaas-vIUy9

layout_name *

string

(path)

Name of layout

Example : content

Responses

Code Description
200

OK

204

No Content

403

Forbidden

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?