Channel Component Operations - Bloomreach Experience - Headless Digital Experience Platform

Channel Component Operations

GET ​/channels​/{channel_id}​/component_groups

Get the component groups for a channel

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: [CatalogGroup]

Example:

[
  {
    "name": "sample-group",
    "hidden": false,
    "system": false
  }
]
403

Forbidden

404

Not Found

GET​ /channels​/{channel_id}​/component_groups​/{group_name}

Get a channel component group

Parameters

Name Description

channel_id *

string

(path)

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

Example : brxsaas-vIUy9

group_name *

string

(path)

Name of group

Example : sample-group

Responses

Code Description
200

OK

Media type: application/json

Schema: CatalogGroup

Example:

{
  "name": "sample-group",
  "hidden": false,
  "system": false
}

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}​/component_groups​/{group_name}

Create or update a channel component group.

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

group_name *

string

(path)

Name of group

Example : sample-group

Request body

application/json

Schema: CatalogGroup

Example:

{
  "name": "sample-group",
  "hidden": false,
  "system": false
}

Responses

Code Description
200

OK

Media type: application/json

Schema: CatalogGroup

Example:

{
  "name": "sample-group",
  "hidden": false,
  "system": false
}

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: CatalogGroup

Example:

{
  "name": "sample-group",
  "hidden": false,
  "system": false
}

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}​/component_groups​/{group_name}

Delete an empty channel component group.

Parameters

Name Description

channel_id *

string

(path)

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

Example : brxsaas-vIUy9

group_name *

string

(path)

Name of group

Example : sample-group

Responses

Code Description
200

OK

204

No Content

403

Forbidden

GET​/channels​/{channel_id}​/component_groups​/{group_name}​/components

Get the channel components for a component group.

Parameters

Name Description

channel_id *

string

(path)

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

Example : brxsaas-vIUy9

group_name *

string

(path)

Name of group

Example : sample-group

Responses

Code Description
200

OK

Media type: application/json

Schema: [ComponentDefinition]

Example:

[
  {
    "id": "sample-group/video",
    "extends": "base/component",
    "hidden": false,
    "system": false,
    "xtype": null,
    "ctype": "Video",
    "label": "Video",
    "icon": "data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGhlaWdodD0iNzYiIHZpZXdCb3g9IjAgMCAyNCAyNCIgd2lkdGg9Ijc2Ij48cGF0aCBkPSJNMCAwaDI0djI0SDBWMHoiIGZpbGw9Im5vbmUiLz48cGF0aCBkPSJNMjEgM0gzYy0xLjExIDAtMiAuODktMiAydjEyYzAgMS4xLjg5IDIgMiAyaDV2Mmg4di0yaDVjMS4xIDAgMS45OS0uOSAxLjk5LTJMMjMgNWMwLTEuMTEtLjktMi0yLTJ6bTAgMTRIM1Y1aDE4djEyem0tNS02bC03IDRWN3oiIGZpbGw9IiMwMDI4NDAiLz48L3N2Zz4=",
    "parameters": [
      {
        "name": "url",
        "valueType": "string",
        "required": true,
        "hidden": false,
        "overlay": false,
        "defaultValue": "",
        "displayName": null,
        "system": false,
        "config": null
      }
    ],
    "fieldGroups": []
  }
]
403

Forbidden

404

Not Found

GET​/channels​/{channel_id}​/component_groups​/{group_name}​/components​/{component_name}

Get a channel component within a component group.

Parameters

Name Description

channel_id *

string

(path)

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

Example : brxsaas-vIUy9

group_name *

string

(path)

Name of group

Example : sample-group

component_name *

string

(path)

Name of component

Example : video

inherited

boolean

(query)

Whether to include inherited types

Default value : false

--truefalse

Responses

Code Description
200

OK

Media type: application/json

Schema: ComponentDefinition

Example:

{
  "id": "sample-group/video",
  "extends": "base/component",
  "hidden": false,
  "system": false,
  "xtype": null,
  "ctype": "Video",
  "label": "Video",
  "icon": "data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGhlaWdodD0iNzYiIHZpZXdCb3g9IjAgMCAyNCAyNCIgd2lkdGg9Ijc2Ij48cGF0aCBkPSJNMCAwaDI0djI0SDBWMHoiIGZpbGw9Im5vbmUiLz48cGF0aCBkPSJNMjEgM0gzYy0xLjExIDAtMiAuODktMiAydjEyYzAgMS4xLjg5IDIgMiAyaDV2Mmg4di0yaDVjMS4xIDAgMS45OS0uOSAxLjk5LTJMMjMgNWMwLTEuMTEtLjktMi0yLTJ6bTAgMTRIM1Y1aDE4djEyem0tNS02bC03IDRWN3oiIGZpbGw9IiMwMDI4NDAiLz48L3N2Zz4=",
  "parameters": [
    {
      "name": "url",
      "valueType": "string",
      "required": true,
      "hidden": false,
      "overlay": false,
      "defaultValue": "",
      "displayName": null,
      "system": false,
      "config": null
    }
  ],
  "fieldGroups": []
}

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}​/component_groups​/{group_name}​/components​/{component_name}

Create or update a channel component within a component group.

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

group_name *

string

(path)

Name of group

Example : sample-group

component_name *

string

(path)

Name of component

Example : video

Request body

application/json

Schema: ComponentDefinition

Example:

{
  "id": "sample-group/video",
  "extends": "base/component",
  "hidden": false,
  "system": false,
  "xtype": null,
  "ctype": "Video",
  "label": "Video",
  "icon": "data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGhlaWdodD0iNzYiIHZpZXdCb3g9IjAgMCAyNCAyNCIgd2lkdGg9Ijc2Ij48cGF0aCBkPSJNMCAwaDI0djI0SDBWMHoiIGZpbGw9Im5vbmUiLz48cGF0aCBkPSJNMjEgM0gzYy0xLjExIDAtMiAuODktMiAydjEyYzAgMS4xLjg5IDIgMiAyaDV2Mmg4di0yaDVjMS4xIDAgMS45OS0uOSAxLjk5LTJMMjMgNWMwLTEuMTEtLjktMi0yLTJ6bTAgMTRIM1Y1aDE4djEyem0tNS02bC03IDRWN3oiIGZpbGw9IiMwMDI4NDAiLz48L3N2Zz4=",
  "parameters": [
    {
      "name": "url",
      "valueType": "string",
      "required": true,
      "hidden": false,
      "overlay": false,
      "defaultValue": "",
      "displayName": null,
      "system": false,
      "config": null
    }
  ],
  "fieldGroups": []
}

Responses

Code Description
200

OK

Media type: application/json

Schema: ComponentDefinition

Example:

{
  "id": "sample-group/video",
  "extends": "base/component",
  "hidden": false,
  "system": false,
  "xtype": null,
  "ctype": "Video",
  "label": "Video",
  "icon": "data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGhlaWdodD0iNzYiIHZpZXdCb3g9IjAgMCAyNCAyNCIgd2lkdGg9Ijc2Ij48cGF0aCBkPSJNMCAwaDI0djI0SDBWMHoiIGZpbGw9Im5vbmUiLz48cGF0aCBkPSJNMjEgM0gzYy0xLjExIDAtMiAuODktMiAydjEyYzAgMS4xLjg5IDIgMiAyaDV2Mmg4di0yaDVjMS4xIDAgMS45OS0uOSAxLjk5LTJMMjMgNWMwLTEuMTEtLjktMi0yLTJ6bTAgMTRIM1Y1aDE4djEyem0tNS02bC03IDRWN3oiIGZpbGw9IiMwMDI4NDAiLz48L3N2Zz4=",
  "parameters": [
    {
      "name": "url",
      "valueType": "string",
      "required": true,
      "hidden": false,
      "overlay": false,
      "defaultValue": "",
      "displayName": null,
      "system": false,
      "config": null
    }
  ],
  "fieldGroups": []
}

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: ComponentDefinition

Example:

{
  "id": "sample-group/video",
  "extends": "base/component",
  "hidden": false,
  "system": false,
  "xtype": null,
  "ctype": "Video",
  "label": "Video",
  "icon": "data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGhlaWdodD0iNzYiIHZpZXdCb3g9IjAgMCAyNCAyNCIgd2lkdGg9Ijc2Ij48cGF0aCBkPSJNMCAwaDI0djI0SDBWMHoiIGZpbGw9Im5vbmUiLz48cGF0aCBkPSJNMjEgM0gzYy0xLjExIDAtMiAuODktMiAydjEyYzAgMS4xLjg5IDIgMiAyaDV2Mmg4di0yaDVjMS4xIDAgMS45OS0uOSAxLjk5LTJMMjMgNWMwLTEuMTEtLjktMi0yLTJ6bTAgMTRIM1Y1aDE4djEyem0tNS02bC03IDRWN3oiIGZpbGw9IiMwMDI4NDAiLz48L3N2Zz4=",
  "parameters": [
    {
      "name": "url",
      "valueType": "string",
      "required": true,
      "hidden": false,
      "overlay": false,
      "defaultValue": "",
      "displayName": null,
      "system": false,
      "config": null
    }
  ],
  "fieldGroups": []
}

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}​/component_groups​/{group_name}​/components​/{component_name}

Delete an unreferenced channel component within a component group.

Parameters

Name Description

channel_id *

string

(path)

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

Example : brxsaas-vIUy9

group_name *

string

(path)

Name of group

Example : sample-group

component_name *

string

(path)

Name of component

Example : video

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?