VOD Technical data model

Name	Type	Description	Localised	Always available
`_id`	String	Internal identifier for the object.	No	Yes
`Actors`	Array of strings	A list of actors. For example: `"Tom Cruise", "Nicole Kidman"`	No	No
`Aspect`	String	The aspect ratio, for example, `16:9` or `Widescreen`.	No	No
`Audio`	Array of strings	A listof "locale-type" patterns representing the audio streams available for this series. locale: three-letter ISO language code type: `VisualImpaired` or `Standard` For example: `"Eng-Standard", "Eng-VisualImpaired", "Fra-Standard"`	No	No
`AudioMode`	String	The audio mode. For example, `Mono`, `SRS`, `THX`, `5.1`, `Nicam Stereo`, or `Dual Mono`.	No	No
`BestSalesIndex`	Integer	Sales index (position) for use in "Top" lists (for example, Top 10 Best Selling). These are positive numbers, starting at 1. If -1 or not present, this series is not in any "Top n" index.	No	No
`Categories`	String	A list of operator-defined category or genre names for this content.	No	No
`companyId`	String	Provider related identifier.	No	No
`ContentType`	String	Free text. Used for implementation-specific data.	No	No
`CopyProtections`	String	A list of usage rules for controlling certain hardware outputs to prevent unauthorised content copying. For example: `"CGMS-A", "HDCP"` If the value is 0 or not present, there is no restriction.	No	No
`Copyright`	String	A copyright message.	Yes	No
`Countries`	String	A string of two-letter ISO codes representing countries relevant to this content.	No	No
`Definition`	String	The video definition. One of `HD`, `SD`, or `3D`.	No	No
`Description`	String	The description of the content.	Yes	No
`Directors`	String	A list of directors.	No	No
`duration`	Number	The approximate duration of the item, in seconds.	No	Yes
`Episode`	String	Localised text representation of the index of the episode in the series. This field is used to display the episode number. For example: `Season 3, Episode 2`	Yes	No
`episodeNumber`	Integer	The index of the episode in the series. This field is used for sorting episodes.	No	No
`id`	String	The CMS's identifier for the object.	No	Yes
`IsRecordable`	Boolean	Whether the end user is allowed to record this series.	No	No
`Language`	String	The original language of the content (three-letter ISO language code).	No	No
`locale`	String	The locale used for the object's localisable fields.	No	Yes
`mainContentRef`	String	The CMS ID of the associated editorial content.	No	Yes
`media`	JSON object	Details of the media stream providing the asset.	No	Yes
`media.{format}.comment`	String	Operational comments of the media.	No	No
`media.{format}.drmId`	String	The content ID assigned by the DRM components. This ID is used to reference the content in the DRM system. This DRM ID is valid in the context of the DRM instance name.	No	No
`media.{format}.drmInstanceName`	String	Name of the DRM instance assigned to the content.	No	No
`media.{format}.fileName`	String	Name of the file on the video server.	No	Yes
`media.{format}.fileSize`	Integer	The file size in bytes.	No	No
`media.{format}.format`	String	The format of the media. Used to identify its type/format. The CMS supports these values: `AV_ClearTS` `AV_EncryptedTS` `AV_PlaylistName` `Data_PMT` `AV_HarmonicOSPlaylistName`	No	No
`media.{format}.frameDuration`	Integer	The duration of the media in frames.	No	No
`media.{format}.id`	String	The CMS's identifier for the media stream.	No	No
`PrivateMetadata`	String	Generic field used to pass directly data from the operator to the end-user device without any processing. One possible use it to pass a listof keyword/value pairs, separated by semi-colons.	No	No
`Producers`	String	A list of producers.	No	No
`profileRef`	String	The CMS ID of the encoding profile that applies to this asset.	No	No
`ProgramId`	String	The ID of the broadcast event that this item relates to.	No	No
`ProgrammeStartDate`	String: a date and time in ISO 8601 format	If the asset represents a catch-up item, the start date and time of the corresponding event.	No	No
`ProgrammeEndDate`	String: a date and time in ISO 8601 format	If the asset represents a catch-up item, the end date and time of the corresponding event.	No	No
`PromoImages`	String	A list of promo image URLs. This must include URL-safe characters only.	No	No
`promoRefs`	String	The CMS IDs of any assets that are trailers for this asset.	No	No
`providerId`	String	The identifier of the metadata provider, from the ID of the export's `CMSVodData` element.	No	Yes
`Rating.code`	String	Parental rating code (from CMS).	No	Yes
`Rating.precedence`	Integer	Quantitative rating value.	No	Yes
`Rating.name`	String	Localised name for the rating, for example, `Adult` or`Adulto`.		Yes
`Scoring`	Integer	Score of the asset.	No	No
`seriesRef`	String	The CMS ID of the series that this episode belongs to.	No	No
`ServiceLongName`	String	If the asset represents a catch-up item, the long name of the service (channel) the event was broadcast on.	No	No
`ShortTitle`	String	The short name of the content.	Yes	No
`Studio`	String	The content owner.	No	No
`Subtitles`	Array of strings	A listof “locale-type” patterns representing the subtitle streams available for this series. locale: 3-letters ISO language code type: `HearingImpaired` or `Standard` For example: `"Eng-Standard", "Eng-HearingImpaired", "Fra-Standard"`	No	No
`Synopsis`	String	A longer description of the asset.	Yes	No
`title`	String	The name of the asset. This field is not localised. Multi-language clients should use the `Title` field instead.	No	Yes
`Title`	String	The name of the asset. The CMS mandates that this field will be populated for at least one locale-form of the asset.	Yes	No
`TotalDownloads`	Integer	Total number of downloads of the content/episode.	No	No
`ViewingNumber`	Integer	How many times a user can watch the content once purchased. If 0 or not present, there is no limitation.	No	No
`xml`	String	The type of the object. Always `technical`.	No	Yes
`Year`	Integer	The year of production of the content.	No	No