Skip to main content
Skip table of contents

editorialContent (editorial-based)

Legend

ColourMeaning

Mandatory for ingest, optional or not used for ION

Mandatory for ION, optional for ingest

Mandatory for both ingest and ION

Optional for ingest and optional or not used for ION

cmsData - editorialContent

ElementsFields/​attributesTypeRequiredSample dataDescriptionIONMDS
cmsData







editorialContent
EditorialContentTypeOptional

Not used
providerResourceIdstringMandatory45243348Unique resource identification  for editorial contentMandatory
namestringMandatory360°-GEOName of editorial contentMandatorytitle
providerIdstringMandatoryplurimediaUnique identification for editorial contentMandatorycompanyId
contentTypeContentTypeEnumTypeMandatorymovie

The type of editorial content. One of the following (note that the value is case-sensitive):

  • movie
  • trailer
  • tvshow
  • episode
  • match
  • race
  • highlight
  • music
  • podcast
  • news
  • link
  • short-form
  • unknown

Mandatory

For ION, the only valid values are:
movie – a motion picture that is classified by a movie content rating board.
tvshow – content that is not classified as a movie.

contentType
profileIdsstringOptional

References to the IDs of profiles characterising the editorial content. If there are multiple values, they must be semicolon-separated.


Not usedprofileRef

cmsData - editorialContent - metadataSet

ElementsFields/​attributesTypeRequiredSample dataDescriptionIONMDS
cmsData









editorialContent








metadataSet

MetadataSetType

Optional



Metadata editorial. The different metadata allowed and their definition must be defined outside of the scheme.Not usedEpgDescription

localestringMandatory
Language/country code in which the metadata set is written. It must conform to ISO-639 and ISO 3166-1.
If the metadata set is not localised, the locale must be set to "none".
Mandatorylocale
metadata
MetadataTypeOptional

Not used
key="Title"stringOptional
TitleMandatoryprivateMetadata
key="Synopsis"stringOptionalL'étonnante diversité naturelle qu'offre l'Alaska en fait une terre d'aventures qui attire des passionnés et scientifiques venus du monde entier.SynopsisMandatoryprivateMetadata
key="Description"stringOptionalL'étonnante diversité naturelle qu'offre l'Alaska en fait une terre d'aventures qui attire des passionnés et scientifiques venus du monde entier.DescriptionMandatoryprivateMetadata
key="Duration"stringOptional128DurationMandatoryprivateMetadata
key="Aspect"stringOptional16:09Aspect ratioNot used
key="Definition"stringOptionalSDDefinitionNot used
key="AudioMode"stringOptional5.1Audio modeNot used
key="IsRecordable"stringOptional0Whether recording is enabledNot used
key="Year"stringOptional2018YearNot used
key="Countries"stringOptionalUSCountries Not used
key="Categories"stringOptionalAdventure;Science fiction;Comedy;Animated;ChildrenCategoriesMandatoryprivateMetadata
key="Rating"stringOptional
Rating (scoring)Not usedprivateMetadata
key="contentType"stringOptionalNews, ShowKey to represent the content type if it is not a movie or a trailer. If there are multiple values, they should be comma-separatedOptionalprivateMetadata
key="geoFilteringBillAddrCountryList"stringOptionalUSA, INDA list of countries as represented in the ISO standard. It will be used by OpCon to populate the selection list. Values must be comma-separated.OptionalprivateMetadata
key="geoFilteringBillAddrCountryWhiteList"stringOptionaltrueIndicates if the geoFilteringBillAddrCountryList is a whitelist or not.OptionalprivateMetadata
key="countryCodeWhiteList"stringOptionalCH, USA list of countries where playback is allowed. Values must be comma-separated.OptionalprivateMetadata
key="blockVpn"stringMandatoryFALSEA global per-operator value to indicate if VPN blocking is turned on or offOptionalprivateMetadata
key="validateByOnNet"stringOptionaltrueFiltering of content for on/off networkOptional
key="SeasonNumber"stringOptional

(see description)


Defines the season number. This is used in CIM for backward compatibility.

If the editorialContent belongs to a contentGroup that has a type of season, this is mandatory.

MandatoryprivateMetadata
key="EpisodeNumber"stringOptional (see description)

Defines the episode number within a season.

If the editorialContent belongs to a contentGroup that has a type of season or series, this is mandatory.

MandatoryprivateMetadata

cmsData - editorialContent - period

ElementsFields/​attributesTypeRequiredSample dataDescriptionIONMDS
cmsData








editorialContent

EditorialContentTypeOptional

Not used
period
PeriodTypeOptional
This period allows you to specify the start and end date of the editorialContent.Not usedPeriod
startgmtdatetimeMandatory2018-11-20T13:12:27ZStart date of the editorialContentMandatorystart
endgmtdatetimeMandatory2018-11-20T13:12:27ZEnd date of the editorialContentMandatoryend

cmsData - editorialContent - images

ElementsFields/​attributesTypeRequiredSample dataDescriptionIONIHS
cmsData











editorialContent








Not used
images



ImageSetTypeOptional
Represents a set of imagesNot used
image


ImageTypeMandatory
Represents an imageMandatory


idstringMandatory650980Unique identifier of the imageMandatory


uristringOptionalhttp://photos.plurimedia.fr/photos/0dd98140-c38a-47f5-9697-54676591aea5.jpgLocation (URI) of the source image. Only http mode is supported for image retrieval.Not useduri
height

integerOptional272Image heightMandatoryheight
width

integerOptional352Image widthMandatorywidth
aspect

stringOptional
Aspect ratio of the image, for example, 16x9Mandatoryaspect
category

stringOptional
Category of the imageOptionalcategory
primary

booleanOptional
Indicates if the image is primary or notOptionalprimary
preferred

booleanOptional
Indicates whether the image is the preferred images that should be used when there are multiple images that could be used in the same context.

captions

CaptionsTypeOptional
Set of locale-specific image titlesOptionalcaptions

localestringMandatory
Language/country code in which the captions are written. It must conform to ISO-639 and ISO 3166-1.Not usedlocale
title
stringOptional
Locale-specific name of the the imageOptionaltitle
externalId

ExternalIdTypeOptional
Source information of the imageOptionalexternalId
externalSource
ExternalSourceType

Mandatory




OptionalexternalSource
sourceNamestringMandatory
Name of the external source.Optional
resourceIdstringMandatory
Identifier of the resource (person or image) in the external sourceOptionalexternalResourceId
locale

stringOptionalen_EN

The locale that the image applies to.

Multiple locales can be specified for each image.



cmsData - editorialContent - persons

ElementsFields/​attributesTypeRequiredSample dataDescriptionIONMDSCCP
cmsData














editorialContent










Not used

persons





PersonSetTypeOptional
Set of persons for this content and associated metadataNot used
persons
person




PersonTypeMandatory
Defines a person element, i.e., the cast or crew for the editorial contentMandatory
persons




idstringMandatorySTCUEnabled_EditorialLevel_New_person_1Unique identifier of the personMandatory
id




dateOfBirthstringOptional22/04/1990Date of birth of the person in 'YYYY-MM-DD' formatMandatory
dateOfBirth




typestringMandatorycastThe type of person, restricted to cast or personaMandatory
type
names



NamesTypeOptional
Defines the locale-specific name of the personMandatory
names



localestringOptionalen_GBLanguage/country code in which the name is written. It must conform to ISO-639 and ISO 3166-1.Mandatory
locale
name


stringOptionalThomas Sean ConneryLocale-specific name of the personMandatory
name
details



DetailsTypeOptional
Defines the locale-specific bio data of the personMandatory
details



localestringOptionalen_GBLanguage/country code in which the bio data is written. It must conform to ISO-639 and ISO 3166-1.Mandatory
locale
bio


stringOptionalScottish actor with distinctive accentLocale-specific bio data of the personMandatory
bio
roles



stringOptionalactor;directorOne more roles played by the person for this program, semi-colon separated. For example, writer, director, or actor.Mandatory
role
images



ImageSetTypeOptional
Represents a set of imagesNot used

image


ImageTypeMandatory
Represents an imageMandatory



idstringMandatorySTCUEnabled_EditorialLevel_New_Img_person_1Unique identifier of the imageMandatory



uristringOptionalhttp://face.tmsimg.com/assets/assets/Img_person_1.jpgLocation (URI) of the source image. Only http mode is supported for image retrieval.Mandatory

height

integerOptional272Image heightMandatory

width

integerOptional352Image widthMandatory

aspect

stringOptional16x9Aspect ratio of the image, for example, 16x9Mandatory

category

stringOptionalIconicCategory of the imageOptional

primary

booleanOptionaltrueIndicates if the image is primary or notOptional

preferred

booleanOptional
Indicates whether the image is the preferred images that should be used when there are multiple images that could be used in the same context.


captions

CaptionsTypeOptional
Set of locale-specific image titlesOptional


localestringMandatory
Language/country code in which the captions are written. It must conform to ISO-639 and ISO 3166-1.Optional

title
stringOptionalImg_EditorialLevel_priddra1_1Locale-specific name of the imageOptional

externalId

ExternalIdTypeOptional
Source information of the imageNot used

externalSource
ExternalSourceType

Optional




Optional

sourceNamestringMandatorygracenoteName of the external source.Optional

resourceIdstringMandatoryI456Identifier of the resource (person or image) in the external sourceOptional

cmsData - editorialContent - referenceAsset

ElementsFields/​attributesTypeRequiredSample dataDescriptionIONMDSCCPIHS
cmsData












editorialContent



EditorialContentTypeOptional

Not used


referenceAsset


ReferenceAssetTypeOptional
A reference asset of the editorial content. All reference asset types must be unique per editorial content.
If a reference asset with the specified type does not exist, it will be created. Otherwise it will be updated.
Not used




uri

anyURIMandatoryhttp://cdn-nagravision-01.vos360.video/Content/HLS/VOD/def10e7c-47c6-46e9-8a17-54767d9b9829/1b5438f9-e403-58f7-9d4b-a4127e880a4c/index.m3u8An ID using either the schema "id" (e.g., id:de305d54-75b4) or a path relative to the ADL using the schema "relpath" (e.g., relpath://folder/; relpath://folder/mib.m3u8 or relpath:mib.m3u8)Mandatory




typestringMandatoryClear_Asset_SDA generic keyword allowing to identify the type of reference asset (e.g. HD or SD)Mandatory


metadataSet




MetadataSetNoLocaleTypeOptional
Metadata editorial. The different allowed metadata and their definitions must be defined outside of the scheme.Not usedEpgDescription


localestringMandatoryen_GBLanguage/country code in which the metadata set is written. It must conform to ISO-639 and ISO 3166-1.
If the metadata set is not localised, the locale must be set to "none".
Mandatorylocale

metadata
MetadataTypeOptional
Metadata valueNot usedEpgElement

key="CMS4MigratedData"stringOptional

true


CMS4MigratedDataNot used


key="FileSize"stringOptional
File sizeOptional


key="FrameDuration"stringOptional
Frame durationOptional


key="Comment"stringOptional
CommentNot used


cmsData - editorialContent - parentalRatings

ElementsFields/​attributesTypeRequiredSample dataDescriptionIONMDS
cmsData









editorialContent








parentalRatings

ParentalRatingSetTypeOptional
Parental ratings used to decide suitability for certain audiences based on its contentNot used

parentalRating


ParentalRatingTypeMandatory
Parental rating is used to decide suitability for certain audiences based on its content.Mandatory
ratingBodyNamestringMandatoryMotion Picture Association of America (MPAA)The friendly name of the ratings body. This is unique across all ratings bodies in the system.MandatoryratingBody
contentRatingCodestringMandatoryGThe content rating code. This is unique across all content ratings in the system.Mandatorycode
countryCodeTwoCharStringMandatoryUSThe country codeMandatory

cmsData - editorialContent - contentGroupRef

ElementsFields/​attributesTypeRequiredSample dataDescriptionIONMDS
cmsData








editorialContent







contentGroupRef
BaseResourceTypeOptional
Weak reference to an external content group (series or other – this content group does not necessarily exist).Not usedseriesRef
providerIdstringMandatoryplurimediaUnique identification of a parent content groupMandatorycompanyId
providerResourceIdstringMandatory32330896Unique resource identification of a parent content groupMandatory

cmsData - editorialContent - seasonRef

ElementsFields/​attributesTypeRequiredSample dataDescriptionIONMDS
cmsData








editorialContent







seasonRef
BaseResourceTypeOptional
The season content group that the content belongs toNot used

cmsData - editorialContent - seriesRef

ElementsFields/​attributesTypeRequiredSample dataDescriptionIONMDS
cmsData








editorialContent







seriesRef
BaseResourceTypeOptional
The series content group that the content belongs toNot used

cmsData - editorialContent - contentLinkId

ElementsFields/​attributesTypeRequiredSample dataDescriptionIONMDS
cmsData








editorialContent







contentLinkId

String

Optional
For deep linking, this specifies the ID of the same editorial content from a different content provider.

cmsData - editorialContent - clientControls

ElementsFields/​attributesTypeRequiredSample dataDescriptionIONMDS
cmsData








editorialContent







clientControls


ClientControlsMetaDataType

Optional

"clientControls" :[

   {"key" : "FFWD" "value" : true },

   {"key" : "RWD" "value" : true }

]

Specifies the capabilities that are enabled or disabled for the content. (For example, the ability to fast forward or rewind.)

These are expressed as key/value pairs, where:

  • key_name is the name of a capability that has been configured in Platform.

  • value is true or false. true means that the product is enabled for the content. false means it is disabled.


JavaScript errors detected

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

If this problem persists, please contact our support.