Creating a channel group

Request

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

https://<host>:<port>/metadata/content/v1/contentGroups

A channel group is a type of content group.

A channel group does not include details of the channels that it includes. To add channels to a channel group, create a content group link to associate the editorial channels with the channel (content) group.
See Creating a content group link.

Headers

Content-Type: application/json

Mandatory arguments

All of the following are in the request body:

Either:
- id – the ID of the channel group, or
- Both providerId and providerResourceId
name – the name of the channel group
type – the content group type, which in this case must be channel.

For content groups of type channel, the content group can only be linked to a product of type subscription.

Other arguments

The following arguments (all in the request body) are all optional.

However, they may be required by ION (if you are using it). These are indicated with an asterisk (*).

start* – the resource start date in ISO 8601 format
end* – the resource end date in ISO 8601 format
subType* – operator-defined sub-category
parentRef – reference to the parent content group. This is either:
- id – the ID of the content group, or
- Both providerId and providerResourceId
preferenceSet* – reference to the editorial contents and/or content groups that should be returned first in queries. This (short) list is curated by the operator. All the items included here should belong to this content group. This element contains one or more blocks, each of which contains either:
- id – the ID of the editorial content/content group, or
- Both providerId and providerResourceId
orderingFields* – the field(s) by which the items in the channel group should be ordered in a query response.
metadataSet* – a set of locale-specific metadata blocks, each of which has:
- locale* – the locale for the metadata element. If locale is set to none, the metadata block that it applies to is the default – it is the one that is used if there is no metadata block for the user's locale.
- metadata* – a block containing one or more key/value pairs in the following form:
```
[{
   "key": "<key_name>",
   "value": "<value>"
}]
```
  You can add whatever keys you require. However, the following values have significance in OpenTV Platform:
  - Title* – the content group title
  - seriesNumber* – description of the event
  - Rating – the rating for the channel group

Example

A POST request with this payload creates a new channel group:

CODE

{
   "providerId": "Operator",
   "providerResourceId": "CG017",
   "name": "Channel group 17",
   "type": "channel"
}

Response

A successful request returns an HTTP 201 status. The response body contains the URI of the new channel group.

A bad request returns an HTTP 400 status.