editorialContent (editorial-based)

Legend

Colour	Meaning
	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

Elements		Fields/attributes	Type	Required	Sample data	Description	ION	MDS
`cmsData`
	`editorialContent`		EditorialContentType	Optional			Not used
		`providerResourceId`	string	Mandatory	`45243348`	Unique resource identification for editorial content	Mandatory
		`name`	string	Mandatory	`360°-GEO`	Name of editorial content	Mandatory	`title`
		`providerId`	string	Mandatory	`plurimedia`	Unique identification for editorial content	Mandatory	`companyId`
		`contentType`	ContentTypeEnumType	Mandatory	`movie`	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`
		`profileIds`	string	Optional		References to the IDs of profiles characterising the editorial content. If there are multiple values, they must be semicolon-separated.	Not used	`profileRef`

cmsData - editorialContent - metadataSet

Elements				Fields/attributes	Type	Required	Sample data	Description	ION	MDS
`cmsData`
	`editorialContent`
		`metadataSet`			MetadataSetType	Optional		Metadata editorial. The different metadata allowed and their definition must be defined outside of the scheme.	Not used	`EpgDescription`
				`locale`	string	Mandatory		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"`.	Mandatory	`locale`
			`metadata`		MetadataType	Optional			Not used
				key="`Title"`	string	Optional		Title	Mandatory	`privateMetadata`
				key="`Synopsis"`	string	Optional	`L'étonnante diversité naturelle qu'offre l'Alaska en fait une terre d'aventures qui attire des passionnés et scientifiques venus du monde entier.`	Synopsis	Mandatory	`privateMetadata`
				key="`Description"`	string	Optional	`L'étonnante diversité naturelle qu'offre l'Alaska en fait une terre d'aventures qui attire des passionnés et scientifiques venus du monde entier.`	Description	Mandatory	`privateMetadata`
				key="`Duration"`	string	Optional	`128`	Duration	Mandatory	`privateMetadata`
				`key="Aspect"`	string	Optional	16:09	Aspect ratio	Not used
				`key="Definition"`	string	Optional	SD	Definition	Not used
				`key="AudioMode"`	string	Optional	5.1	Audio mode	Not used
				`key="IsRecordable"`	string	Optional	0	Whether recording is enabled	Not used
				`key="Year"`	string	Optional	2018	Year	Not used
				`key="Countries"`	string	Optional	US	Countries	Not used
				key="`Categories"`	string	Optional	`Adventure;Science fiction;Comedy;Animated;Children`	Categories	Mandatory	`privateMetadata`
				`key="Rating"`	string	Optional		Rating (scoring)	Not used	`privateMetadata`
				`key="contentType"`	string	Optional	News, Show	Key to represent the content type if it is not a movie or a trailer. If there are multiple values, they should be comma-separated	Optional	`privateMetadata`
				`key="geoFilteringBillAddrCountryList"`	string	Optional	USA, IND	A 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.	Optional	`privateMetadata`
				`key="geoFilteringBillAddrCountryWhiteList"`	string	Optional	`true`	Indicates if the `geoFilteringBillAddrCountryList` is a whitelist or not.	Optional	`privateMetadata`
				`key="countryCodeWhiteList"`	string	Optional	CH, US	A list of countries where playback is allowed. Values must be comma-separated.	Optional	`privateMetadata`
				`key="blockVpn"`	string	Mandatory	FALSE	A global per-operator value to indicate if VPN blocking is turned on or off	Optional	`privateMetadata`
				`key="validateByOnNet"`	string	Optional	`true`	Filtering of content for on/off network	Optional
				`key="SeasonNumber"`	string	Optional (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.	Mandatory	`privateMetadata`
				`key="EpisodeNumber"`	string	Optional (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.	Mandatory	`privateMetadata`
				`key="recommendable"`	string	Optional	`true`	Specifies whether the content should be included in recommendations from the recommendation engine. Default: `true`. Must be in the `"locale": "none"` block.

cmsData - editorialContent - period

Elements			Fields/attributes	Type	Required	Sample data	Description	ION	MDS
`cmsData`
	`editorialContent`			EditorialContentType	Optional			Not used
		`period`		PeriodType	Optional		This period allows you to specify the start and end date of the editorialContent.	Not used	`Period`
			`start`	gmtdatetime	Mandatory	`2018-11-20T13:12:27Z`	Start date of the editorialContent	Mandatory	`start`
			`end`	gmtdatetime	Mandatory	`2018-11-20T13:12:27Z`	End date of the editorialContent	Mandatory	`end`

cmsData - editorialContent - images

Elements						Fields/attributes	Type	Required	Sample data	Description	ION	IHS
`cmsData`
	`editorialContent`										Not used
		`images`					ImageSetType	Optional		Represents a set of images	Not used
			`image`				ImageType	Mandatory		Represents an image	Mandatory
						`id`	string	Mandatory	`650980`	Unique identifier of the image	Mandatory
						`uri`	string	Optional	`http://photos.plurimedia.fr/photos/0dd98140-c38a-47f5-9697-54676591aea5.jpg`	Location (URI) of the source image. Only http mode is supported for image retrieval.	Not used	`uri`
				`height`			integer	Optional	`272`	Image height	Mandatory	`height`
				`width`			integer	Optional	`352`	Image width	Mandatory	`width`
				`aspect`			string	Optional		Aspect ratio of the image, for example, `16x9`	Mandatory	`aspect`
				`category`			string	Optional		Category of the image	Optional	`category`
				`primary`			boolean	Optional		Indicates if the image is primary or not	Optional	`primary`
				`preferred`			boolean	Optional		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`			CaptionsType	Optional		Set of locale-specific image titles	Optional	`captions`
						`locale`	string	Mandatory		Language/country code in which the captions are written. It must conform to ISO-639 and ISO 3166-1.	Not used	locale
					`title`		string	Optional		Locale-specific name of the the image	Optional	`title`
				`externalId`			ExternalIdType	Optional		Source information of the image	Optional	`externalId`
					`externalSource`		ExternalSourceType	Mandatory			Optional	`externalSource`
						`sourceName`	string	Mandatory		Name of the external source.	Optional
						`resourceId`	string	Mandatory		Identifier of the resource (person or image) in the external source	Optional	`externalResourceId`
				`locale`			string	Optional	`en_EN`	The locale that the image applies to. Multiple locales can be specified for each image.

cmsData - editorialContent - persons

Elements								Fields/attributes	Type	Required	Sample data	Description	ION	CCP
`cmsData`
	`editorialContent`												Not used
		`persons`							PersonSetType	Optional		Set of persons for this content and associated metadata	Not used	`persons`
			`person`						PersonType	Mandatory		Defines a person element, i.e., the cast or crew for the editorial content	Mandatory	`persons`
								`id`	string	Mandatory	`STCUEnabled_EditorialLevel_New_person_1`	Unique identifier of the person	Mandatory	`id`
								`dateOfBirth`	string	Optional	`22/04/1990`	Date of birth of the person in 'YYYY-MM-DD' format	Mandatory	`dateOfBirth`
								`type`	string	Mandatory	`cast`	The type of person, restricted to `cast` or `persona`	Mandatory	`type`
				`names`					NamesType	Optional		Defines the locale-specific name of the person	Mandatory	`names`
								`locale`	string	Optional	`en_GB`	Language/country code in which the name is written. It must conform to ISO-639 and ISO 3166-1.	Mandatory	`locale`
					`name`				string	Optional	`Thomas Sean Connery`	Locale-specific name of the person	Mandatory	`name`
				`details`					DetailsType	Optional		Defines the locale-specific bio data of the person	Mandatory	`details`
								`locale`	string	Optional	`en_GB`	Language/country code in which the bio data is written. It must conform to ISO-639 and ISO 3166-1.	Mandatory	`locale`
					`bio`				string	Optional	`Scottish actor with distinctive accent`	Locale-specific bio data of the person	Mandatory	`bio`
				`roles`					string	Optional	`actor;director`	One more roles played by the person for this program, semi-colon separated. For example, `writer`, `director`, or `actor`.	Mandatory	`role`
				images					ImageSetType	Optional		Represents a set of images	Not used
					`image`				ImageType	Mandatory		Represents an image	Mandatory
								`id`	string	Mandatory	`STCUEnabled_EditorialLevel_New_Img_person_1`	Unique identifier of the image	Mandatory
								`uri`	string	Optional	`http://face.tmsimg.com/assets/assets/Img_person_1.jpg`	Location (URI) of the source image. Only http mode is supported for image retrieval.	Mandatory
						`height`			integer	Optional	`272`	Image height	Mandatory
						`width`			integer	Optional	`352`	Image width	Mandatory
						`aspect`			string	Optional	`16x9`	Aspect ratio of the image, for example, `16x9`	Mandatory
						`category`			string	Optional	`Iconic`	Category of the image	Optional
						`primary`			boolean	Optional	`true`	Indicates if the image is primary or not	Optional
						`preferred`			boolean	Optional		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`			CaptionsType	Optional		Set of locale-specific image titles	Optional
								`locale`	string	Mandatory		Language/country code in which the captions are written. It must conform to ISO-639 and ISO 3166-1.	Optional
							`title`		string	Optional	`Img_EditorialLevel_priddra1_1`	Locale-specific name of the image	Optional
						`externalId`			ExternalIdType	Optional		Source information of the image	Not used
							`externalSource`		ExternalSourceType	Optional			Optional
								`sourceName`	string	Mandatory	`gracenote`	Name of the external source.	Optional
								`resourceId`	string	Mandatory	`I456`	Identifier of the resource (person or image) in the external source	Optional

cmsData - editorialContent - referenceAsset

Elements					Fields/attributes	Type	Required	Sample data	Description	ION	MDS
`cmsData`
	`editorialContent`					EditorialContentType	Optional			Not used
		`referenceAsset`				ReferenceAssetType	Optional		A reference asset of the editorial content. Multiple `referenceAsset` elements are allowed. 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. If you need to specify different reference assets for different technicals, you can specify a different reference asset for each technical. See technicalContent (technical-based).	Not used
					`uri`	anyURI	Mandatory	`http://cdn-nagravision-01.vos360.video/Content/HLS/VOD/def10e7c-47c6-46e9-8a17-54767d9b9829/1b5438f9-e403-58f7-9d4b-a4127e880a4c/index.m3u8`	An 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
					`type`	string	Mandatory	`Clear_Asset_SD`	A generic keyword allowing to identify the type of reference asset (e.g. HD or SD)	Mandatory
			`assetDeviceLocation`			AssetDeviceLocationType	Optional		Also called ADL, this is a set of data describing the asset location on a specific storage device. ADL type must be unique per asset. If an ADL with the specified type does not exist, it will be created. Otherwise it will be updated.	Not used
					`relativePath`	string	Mandatory	`files/`	Relative path (e.g., `folder/` or `./folder1/folder2/`) against the storage device accesspoint. It can be empty.	Not used
					`storageDeviceId`	string	Mandatory	`CIS`	ID of the storage device where the asset is located. This storage device will be accessed through one of its access points.	Not used
					`type`	ADLenumType	Mandatory	`source`	The storage device type. Must be one of: `source` `destination` `archive` `other`	Not used
			`metadataSet`			MetadataSetNoLocaleType	Optional		Metadata editorial. The different allowed metadata and their definitions must be defined outside of the scheme.	Not used	`EpgDescription`
					`locale`	string	Mandatory	`en_GB`	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"`.	Mandatory	`locale`
				`metadata`		MetadataType	Optional		Metadata value	Not used	`EpgElement`
					`key="CMS4MigratedData"`	string	Optional	true	CMS4MigratedData	Not used
					key="`FileSize"`	string	Optional		File size	Optional
					key="`FrameDuration"`	string	Optional		Frame duration	Optional
					key="`Comment"`	string	Optional		Comment	Not used

cmsData - editorialContent - parentalRatings

Elements				Fields/attributes	Type	Required	Sample data	Description	ION	MDS
`cmsData`
	`editorialContent`
		`parentalRatings`			ParentalRatingSetType	Optional		Parental ratings used to decide suitability for certain audiences based on its content	Not used
			`parentalRating`		ParentalRatingType	Mandatory		Parental rating is used to decide suitability for certain audiences based on its content.	Mandatory
				`ratingBodyName`	string	Mandatory	`Motion Picture Association of America (MPAA)`	The friendly name of the ratings body. This is unique across all ratings bodies in the system.	Mandatory	`ratingBody`
				`contentRatingCode`	string	Mandatory	`G`	The content rating code. This is unique across all content ratings in the system.	Mandatory	`code`
				`countryCode`	TwoCharString	Mandatory	`US`	The country code	Mandatory

cmsData - editorialContent - contentGroupRef

Elements			Fields/attributes	Type	Required	Sample data	Description	ION	MDS
`cmsData`
	`editorialContent`
		`contentGroupRef`		`BaseResourceType`	Optional		Weak reference to an external content group (series or other – this content group does not necessarily exist).	Not used	`seriesRef`
			`providerId`	string	Mandatory	`plurimedia`	Unique identification of a parent content group	Mandatory	`companyId`
			`providerResourceId`	string	Mandatory	`32330896`	Unique resource identification of a parent content group	Mandatory

cmsData - editorialContent - seasonRef

Elements			Type	Required	Description	ION
`cmsData`
	`editorialContent`
	`editorialContent`	`seasonRef`	`BaseResourceType`	Optional	The season content group that the content belongs to	Not used

cmsData - editorialContent - seriesRef

Elements			Type	Required	Description	ION
`cmsData`
	`editorialContent`
	`editorialContent`	`seriesRef`	`BaseResourceType`	Optional	The series content group that the content belongs to	Not used

cmsData - editorialContent - contentLinkId

Elements Fields/attributes Type Required Sample data Description ION MDS

cmsData

editorialContent

contentLinkId

String

Optional

In deployments that use the one-to-one event / editorial content model (see Selecting an event-to-editorial-content mapping model), contentLinkId provides the link between the event and the editorial content that it corresponds to. When an editorial content is created from an event (for catch-up or recording), this value is copied to the editorial content’s contentLinkId field.

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

cmsData - editorialContent - clientControls

Elements Fields/attributes Type Required Sample data Description ION MDS

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.