contentGroup (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 - contentGroup

Elements		Fields/attributes	Type	Required	Sample data	Description	ION	MDS
`cmsData`
	`contentGroup`		BaseResourceType	Optional		Defines a `contentGroup` to create/update.	Not used	`series`
		`providerResourceId`	string	Mandatory	`32330896`	Unique resource identification of a specific content provider	Mandatory
		`name`	string	Mandatory	`Pianotine`	Working name of the resource (used usually to identify a resource in the operator UI)	Mandatory	`title`
		`providerId`	string	Mandatory	`plurimedia`	Unique identification of the content provider	Mandatory	`providerId`
		`type`	string	Mandatory	`series`	Provides type of the `contentGroup`. Allowed values: `series`, `season`, `movieGroup`, `collection`, and `channel`. When this is set to `season`, the `contentGroup seasonNumber` must have a value. If an `editorialContent` belongs to this `contentGroup`, its `seasonNumber` must also have a value. When this is set to `channel`, the content group can only be linked to a product of type `subscription`.	Mandatory

cmsData - contentGroup - period

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

cmsData - contentGroup - metadataSet

Elements				Fields/attributes	Type	Required	Sample data	Description	ION	MDS
`cmsData`
	`contentGroup`
		`metadataSet`			MetadataSetType	Optional		Metadata editorial. The different metadata allowed and their definition must be defined outside of the scheme.	Mandatory	`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	Mandatory	`EpgElement`
				`key="Title"`	string	Optional		Title	Mandatory	`privateMetadata`
				key="`SeasonNumber"`	string	Optional		Season number. Mandatory if the `contentGroup type` is set to `season`.	Mandatory	`privateMetadata`

cmsData - contentGroup - parentRef

Elements			Fields/attributes	Type	Required	Sample data	Description	ION	MDS
`cmsData`
	`contentGroup`
		`parentRef`		BaseResourceType	Optional		Reference to the parent content group	Mandatory	`privateMetadata`
			`providerId`	string	Mandatory	`plurimedia`	Unique identification of a parent content group	Mandatory	`privateMetadata`
			`providerResourceId`	string	Mandatory	`32330896`	Unique resource identification of a parent content group	Mandatory	`privateMetadata`

cmsData - contentGroup - images

Elements						Fields/attributes	Type	Required	Sample data	Description	ION	IHS
`cmsData`
	`contentGroup`
		`images`					ImageSetType	Optional		Representing 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.	Mandatory	`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.	Mandatory	`locale`
					`title`		string	Optional		Locale-specific name of 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 - contentGroup - preferenceSet

Elements			Type	Required	Description	ION
`cmsData`
	`contentGroup`
	`contentGroup`	`preferenceSet`	preferenceSetType	Optional	Reference of the editorialContents and contentGroups	Mandatory

cmsData - contentGroup - orderingFields

Elements			Type	Required	Description	ION
`cmsData`
	`contentGroup`
	`contentGroup`	`orderingFields`	orderingFieldsType	Optional	When set, specifies the return order of the contentGroup's items	Mandatory

cmsData - contentGroup - seasonRef

Elements			Fields/attributes	Type	Required	Description	ION	MDS
`cmsData`
	`contentGroup`
		`seasonRef`		BaseResourceType	Optional	Reference to a season	Mandatory	`privateMetadata`
			`providerId`	string	Mandatory	Unique identification of the season provider	Mandatory	`privateMetadata`
			`providerResourceId`	string	Mandatory	Unique resource identification of the season	Mandatory	`privateMetadata`

cmsData - contentGroup - subType

Elements			Type	Required	Description	ION
`cmsData`
	`contentGroup`
	`contentGroup`	`subType`	String	Optional	Specific categorisation of the content group	Mandatory

cmsData - contentGroup - contentLinkId

Elements			Type	Required	Description
`cmsData`
	`contentGroup`
	`contentGroup`	`contentLinkId`	String	Optional	For deep linking, this specifies the ID of the same content group from a different content provider.