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.
All PUT and POST calls to CPM are validated by the Validation Service. If there is a problem with the data you are submitting, you will receive one of the following:
-
Error – the data is invalid, so the request fails.
The error message will indicate which data is invalid and why. -
Warning – there is an issue with the data that does not prevent it from being added/updated in CPM, but that you need to be aware of.
For example, if a mandatory field has no value for a non-primary locale (but the same field for the primary locale does have a value), you will get a warning rather than an error.
The warning message will indicate which data is invalid and why.
Note that there are still conditions where a request can pass validation, but fail when it reaches CPM, so you must handle such responses in an appropriate way too.
In addition, all such errors and warnings:
-
Are available as a report in Data Warehouse (errors only).
-
Generate alert emails that are sent to the email addresses that were configured when the system was deployed.
Note: this data only becomes available in the report 60–90 minutes after the error occurs (and the email is sent).
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.
All PUT and POST calls to CPM are validated by the Validation Service. If there is a problem with the data you are submitting, you will receive one of the following:
-
Error – the data is invalid, so the request fails.
The error message will indicate which data is invalid and why. -
Warning – there is an issue with the data that does not prevent it from being added/updated in CPM, but that you need to be aware of.
For example, if a mandatory field has no value for a non-primary locale (but the same field for the primary locale does have a value), you will get a warning rather than an error.
The warning message will indicate which data is invalid and why.
Note that there are still conditions where a request can pass validation, but fail when it reaches CPM, so you must handle such responses in an appropriate way too.
In addition, all such errors and warnings:
-
Are available as a report in Data Warehouse (errors only).
-
Generate alert emails that are sent to the email addresses that were configured when the system was deployed.
Note: this data only becomes available in the report 60–90 minutes after the error occurs (and the email is sent).
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.