VOD Node data model
Name | Type | Description | Localised | Always available |
---|---|---|---|---|
_id | String | Internal identifier for the object. | No | Yes |
ancestors | Array of strings | A list of the IDs of all the nodes above the current one, in order, starting from the highest-level one. | No | Yes |
BarkerChannelRef | String | The URI of the barker channel promoting this node. | No | No |
children | Array of strings | A list of IDs of the node's children. | No | Yes |
companyId | String | The ID of the broadcaster company that is offering the catalogue node. | No | No |
descendants | Array of strings | A list of IDs of all the nodes below the current one in the tree. | No | Yes |
id | String | The CMS's identifier for the object. | No | Yes |
isRoot | Boolean | True if the node is a top-level/root node. | No | Yes |
locale | String | The locale used for the object's localisable fields. | No | Yes |
nls.Title | String | Native language support for the title field to allow proper sorting on these fields, rather than utf-8 order. | No | No |
nodeOrder | Integer | The index of the node, used for explicit ordering of nodes in a parent node or group. Since MDS 1.1STD4. | No | No |
parent | String | The ID of the node's parent. | No | Yes |
PrivateMetadata | String | Used to pass data directly from the operator to the end-user device without any CMS/SDP processing. One possible use is to pass a list of keyword/value pairs, separated by semi-colons. | No | No |
PromoImages | String | A list of promo image URLs. The Metadata Server does not validate the format of this field’s value, and does not attempt to access the URLs to verify the existence of the image files. | No | No |
provider | 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 the CMS). | No | Yes |
Rating.name | String | Localized name for the rating, for example, Adult or Adulto . | Yes | Yes |
Rating.precedence | Integer | Quantitative rating value. | No | Yes |
regions | Array of strings | The region identifiers targeted by the catalogue node. | No | No |
title | String | The name of the catalogue node. This field is not localized. Multi-language clients should use the | No | Yes |
Title | String | The name of the catalogue node. | Yes | Yes |
xml | String | The type of object. This is always Node . | No | Yes |