VOD VodItem data model
Name | Type | Description | Localised | Always available |
---|---|---|---|---|
_id | String | Internal identifier for the object. | No | Yes |
contentRef | String | The CMS ID of the technical content that has been scheduled. | No | Yes |
DisplayPriority | JSON object (see below) | The priority index for this item, which determines its display order in each catalogue node in which it appears. | No | No |
DisplayPriority.<CMS‑id> | Number | The priority index for this item, which determines its display order when it appears in the catalogue with ID <CMS‑id>. | No | No |
id | String | The CMS's identifier for this VodItem . | No | Yes |
nodeRefs | Array of strings | The IDs of the catalogues that this item belongs to. | No | No |
period | JSON object (see below) | The time period this item will appear in the catalogue. | No | No |
period.duration | Number | The length of time this item will appear in the catalogue, in seconds. | No | No |
period.end | String: a date and time in ISO 8601 format | The date and time this item will stop appearing in the catalogue. | No | Yes |
period.start | String: a date and time in ISO 8601 format | The date and time this item will start appearing in the catalogue. | No | Yes |
previewDate | Date | The date from which this entity can be viewed as "test data". The preview period is between | No | No |
PrivateMetadata | String | Generic field used to pass directly data from the customer to the end-user device without any CMS/SDP processing. One possible use it to pass a list of keyword/value pairs, separated by semi-colons. | No | No |
providerId | String | Unique metadata provider identifier. | No | Yes |
RecommendedVodItemIds | Array of strings | A list of
| No | No |
title | String | Technical identification of the VodItem . | No | No |
type | String | The type of this
| No | No |
xml | String | The type of the object. Always VodItem . | No | Yes |