Use the products utility API

For integration and testing purposes, it is useful to be able to create dummy editorial and technical channels. The products utility API allows you to do this.

Overview

A channel consists of two parts:

• An editorial channel, which includes all the metadata about the channel
• One or more associated technical channels, each of which is a specific version of the channel (for example, there may be SD, HD, and 4K technical channels for one editorial channel)

You must create an editorial channel first before you can create its technical channels.

Editorial channel

Request

To create an editorial channel, send a POST request to:

http://<server>:<port>/cpm/content/v1/editorialChannels

Headers

• Content-Type: application/json

Mandatory fields

• name
• providerId
• providerResourceId

Example

A request with this payload creates an editorial channel:

{
    "name": "CNNEC",
    "providerId": "echp01",
    "providerResourceId": "echpr01"
}

Response

A successful request returns an HTTP 201 status and a link to the newly created channel.

A bad request returns an HTTP 400 status.

Example

A successful request returns a payload that looks like this:

{
    "self": "/content/v1/editorialChannels/echp01_echpr01"
}

See also

For full details of this API, see Content and Product Manager (CPM) API documentation: content v1.

Technical channel

Request

To create a technical channel, send a POST request to:

http://<server>:<port>/cpm/content/v1/technicalChannels

Headers

• Content-Type: application/json

Mandatory fields

• name
• providerId
• providerResourceId
• editorialChannelRef
  • providerId
  • providerResourceId

Example

A request with this payload creates a technical channel that refers to the editorial channel created above:

{
    "name": "CNNTC",
    "providerId": "tchp01",
    "providerResourceId": "tchpr01",
    "editorialChannelRef": {
        "providerId": "echp01",
        "providerResourceId": "echpr01"
    }
}

Response

A successful request returns an HTTP 201 status and a link to the newly created channel.

A bad request returns an HTTP 400 status.

Example

A successful request returns a payload that looks like this:

{
    "self": "/content/v1/technicalChannels/tchp01_tchpr01"
}

See also

For full details of this API, see Content and Product Manager (CPM) API documentation: content v1.