Channel Operations - Bloomreach Experience - Headless Digital Experience Platform

Channel Operations

GET ​/channels

Get all the channels in the brX instance.

Parameters

None

Responses

Code Description
200

OK

Media type: application/json

Schema: [Channel]

Example:

{
  {
    "id": "brxsaas-vIUy9",
    "name": "BrX SaaS",
    "branch": "vIUy9",
    "branchOf": "brxsaas",
    "contentRootPath": "/content/documents/brxsaas",
    "locale": null,
    "devices": [],
    "defaultDevice": null,
    "responseHeaders": null,
    "linkurlPrefix": null,
    "cdnHost": null,
    "parameters": {
      "graphql_baseurl": "${public.brx.graphql.baseurl}",
      "smDomainKey": "",
      "smAccountId": "${public.brx.smAccountId}",
      "smEndpoint": "${public.brx.smEndpoint}",
      "spaUrl": "https://brxm-react-spa.herokuapp.com/"
    }
  }
]
403

Forbidden

GET​ /channels​/{channel_id}

Get a channel by id.

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

Example:

{
  "id": "brxsaas-vIUy9",
  "name": "BrX SaaS",
  "branch": "vIUy9",
  "branchOf": "brxsaas",
  "contentRootPath": "/content/documents/brxsaas",
  "locale": null,
  "devices": [],
  "defaultDevice": null,
  "responseHeaders": null,
  "linkurlPrefix": null,
  "cdnHost": null,
  "parameters": {
    "graphql_baseurl": "${public.brx.graphql.baseurl}",
    "smDomainKey": "",
    "smAccountId": "${public.brx.smAccountId}",
    "smEndpoint": "${public.brx.smEndpoint}",
    "spaUrl": "https://brxm-react-spa.herokuapp.com/"
  }
}

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}

Update an existing channel (branch).

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

Request body

application/json

Schema: Channel

Example:

{
  "id": "brxsaas-vIUy9",
  "name": "BrX SaaS",
  "branch": "vIUy9",
  "branchOf": "brxsaas",
  "contentRootPath": "/content/documents/brxsaas",
  "locale": null,
  "devices": [],
  "defaultDevice": null,
  "responseHeaders": null,
  "linkurlPrefix": null,
  "cdnHost": null,
  "parameters": {
    "graphql_baseurl": "${public.brx.graphql.baseurl}",
    "smDomainKey": "",
    "smAccountId": "${public.brx.smAccountId}",
    "smEndpoint": "${public.brx.smEndpoint}",
    "spaUrl": "https://brxm-react-spa.herokuapp.com/"
  }
}

Responses

Code Description
201

OK

Media type: application/json

Schema: Channel

Example:

{
  "id": "brxsaas-vIUy9",
  "name": "BrX SaaS",
  "branch": "vIUy9",
  "branchOf": "brxsaas",
  "contentRootPath": "/content/documents/brxsaas",
  "locale": null,
  "devices": [],
  "defaultDevice": null,
  "responseHeaders": null,
  "linkurlPrefix": null,
  "cdnHost": null,
  "parameters": {
    "graphql_baseurl": "${public.brx.graphql.baseurl}",
    "smDomainKey": "",
    "smAccountId": "${public.brx.smAccountId}",
    "smEndpoint": "${public.brx.smEndpoint}",
    "spaUrl": "https://brxm-react-spa.herokuapp.com/"
  }
}

Headers:

Name Description Type
X-Resource-Version

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

string
403

Forbidden

GET​ /channels​/{channel_id}​/fieldgroups

Get the meta-data for all available field groups.

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

Example:

[
  {
    "name": "group-key",
    "parameters": [
      "smAccountId"
    ]
  }
]
403

Forbidden

GET ​/channels​/{channel_id}​/fieldgroups​/{fieldgroup_name}

Get the meta-data for a specific field group.

Parameters

Name Description

channel_id *

string

(path)

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

Example : brxsaas-vIUy9

fieldgroup_name *

string

(path)

Name of the fieldgroup

Example : group-key

Responses

Code Description
200

OK

Media type: application/json

Schema: FieldGroup

Example:

{
  "name": "group-key",
  "parameters": [
    "smAccountId"
  ]
}

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}​/fieldgroups​/{fieldgroup_name}

Add or update the meta-data for a specific field 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

fieldgroup_name *

string

(path)

Name of the fieldgroup

Example : group-key

Request body

application/json

Schema: FieldGroup

Example:

{
  "name": "group-key",
  "parameters": [
    "smAccountId"
  ]
}

Responses

Code Description
200

OK

Media type: application/json

Schema: FieldGroup

Example:

{
  "name": "group-key",
  "parameters": [
    "smAccountId"
  ]
}

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

Example:

{
  "name": "group-key",
  "parameters": [
    "smAccountId"
  ]
}

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}​/fieldgroups​/{fieldgroup_name}

Delete a field group.

Parameters

Name Description

channel_id *

string

(path)

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

Example : brxsaas-vIUy9

fieldgroup_name *

string

(path)

Name of the fieldgroup

Example : group-key

Responses

Code Description
200

OK

204

No Content

403

Forbidden

GET​/channels​/{channel_id}​/parameters

Get the meta-data for all available channel parameters.

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

Example:

"[\n  {\n    \"name\": \"smAccountId\",\n    \"valueType\": \"string\",\n    \"required\": true,\n    \"hidden\": false,\n    \"overlay\": false,\n    \"defaultValue\": \"\",\n    \"displayName\": \"brSM Account ID\",\n    \"system\": false,\n  },\n  {\n    \"name\": \"smDomainKey\",\n    \"valueType\": \"string\",\n    \"required\": false,\n    \"hidden\": false,\n    \"overlay\": false,\n    \"defaultValue\": \"\",\n    \"displayName\": \"brSM Domain Key\",\n    \"system\": false,\n  },\n  {\n    \"name\": \"smEndpoint\",\n    \"valueType\": \"string\",\n    \"required\": false,\n    \"hidden\": false,\n    \"overlay\": false,\n    \"defaultValue\": \"\",\n    \"displayName\": \"brSM API Endpoint\",\n    \"system\": false,\n  },\n  {\n    \"name\": \"spaUrl\",\n    \"valueType\": \"string\",\n    \"required\": true,\n    \"hidden\": false,\n    \"overlay\": false,\n    \"defaultValue\": \"\",\n    \"displayName\": \"spaUrl\",\n    \"system\": false,\n  },\n  {\n    \"name\": \"graphql_baseurl\",\n    \"valueType\": \"string\",\n    \"required\": false,\n    \"hidden\": false,\n    \"overlay\": false,\n    \"defaultValue\": \"\",\n    \"displayName\": \"GraphQL Base URL\",\n    \"system\": false,\n  }\n]"
403

Forbidden

GET /channels​/{channel_id}​/parameters​/{parameter_name}

Get the meta-data for a specific channel parameter.

Parameters

Name Description

channel_id *

string

(path)

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

Example : brxsaas-vIUy9

parameter_name *

string

(path)

Name of the parameter

Example : smAccountId

Responses

Code Description
200

OK

Media type: application/json

Schema: ParameterType

Example:

{
  "name": "smAccountId",
  "valueType": "string",
  "required": true,
  "hidden": false,
  "overlay": false,
  "defaultValue": "",
  "displayName": "brSM Account ID",
  "system": false,
  "config": null
}

Headers:

Name Description Type
X-Resource-Version

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

string
403

Forbidden

PUT​ /channels​/{channel_id}​/parameters​/{parameter_name}

Add or update the meta-data for a specific channel parameter.

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

parameter_name *

string

(path)

Name of the parameter

Example : smAccountId

Request body

application/json

Schema: ParameterType

Example:

{
  "name": "smAccountId",
  "valueType": "string",
  "required": true,
  "hidden": false,
  "overlay": false,
  "defaultValue": "",
  "displayName": "brSM Account ID",
  "system": false,
  "config": null
}

Responses

Code Description
200

OK

Media type: application/json

Schema: ParameterType

Example:

{
  "name": "smAccountId",
  "valueType": "string",
  "required": true,
  "hidden": false,
  "overlay": false,
  "defaultValue": "",
  "displayName": "brSM Account ID",
  "system": false,
  "config": null
}

Headers:

Name Description Type
X-Resource-Version

Must be used in any subsequent update requests of this entity

string
201

Created

Media type: application/json

Schema: ParameterType

Example:

{
  "name": "smAccountId",
  "valueType": "string",
  "required": true,
  "hidden": false,
  "overlay": false,
  "defaultValue": "",
  "displayName": "brSM Account ID",
  "system": false,
  "config": null
}

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}​/parameters​/{parameter_name}

Delete the meta-data info for a custom channel parameter, or (only) reset a builtin channel parameter.

Parameters

Name Description

channel_id *

string

(path)

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

Example : brxsaas-vIUy9

parameter_name *

string

(path)

Name of the parameter

Example : smAccountId

Responses

Code Description
200

OK

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?