Skip to main content
Skip table of contents

VOD VodItem data model

NameTypeDescriptionLocalisedAlways available
_idStringInternal identifier for the object.NoYes
contentRefStringThe CMS ID of the technical content that has been scheduled.NoYes
DisplayPriorityJSON object (see below)The priority index for this item, which determines its display order in each catalogue node in which it appears.NoNo
DisplayPriority.<CMS‑id>NumberThe priority index for this item, which determines its display order when it appears in the catalogue with ID <CMS‑id>.NoNo
idStringThe CMS's identifier for this VodItem.NoYes
nodeRefsArray of stringsThe IDs of the catalogues that this item belongs to.NoNo
periodJSON object (see below)The time period this item will appear in the catalogue.NoNo
period.durationNumberThe length of time this item will appear in the catalogue, in seconds.NoNo
period.endString: a date and time in ISO 8601 formatThe date and time this item will stop appearing in the catalogue.NoYes
period.startString: a date and time in ISO 8601 formatThe date and time this item will start appearing in the catalogue.NoYes
previewDateDateThe date from which this entity can be viewed as "test data".

The preview period is between previewDate and period.start (when the item becomes available to the general public).

NoNo
PrivateMetadataString

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.

NoNo
providerIdStringUnique metadata provider identifier.NoYes
RecommendedVodItemIdsArray of strings

A list of VodItem IDs recommended for this item (information taken from a recommendation engine or from the customer) with rank (a positive integer, where a higher number means a stronger recommendation) using the following pattern:

<ProgrammeId>/<Rank>
NoNo
titleStringTechnical identification of the VodItem.NoNo
typeString

The type of this VodItem. One of:

  • catchup
  • truevod 
  • pushvod
  • pullvod
NoNo
xmlStringThe type of the object. Always VodItem.NoYes
JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.