Skip to main content
Skip table of contents

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

ElementsFields/​attributesTypeRequiredSample dataDescriptionIONMDS
cmsData







contentGroup
BaseResourceTypeOptional
Defines a contentGroup to create/update.Not usedseries
providerResourceIdstringMandatory32330896Unique resource identification of a specific content providerMandatory
namestringMandatoryPianotineWorking name of the resource (used usually to identify a resource in the operator UI)Mandatorytitle
providerIdstringMandatoryplurimediaUnique identification of the content providerMandatoryproviderId
typestringMandatoryseries

Provides type of the contentGroup

Allowed values: series, season, and movieGroup.

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.

Mandatory

cmsData - contentGroup - period

ElementsFields/​attributesTypeRequiredSample dataDescriptionION
cmsData






contentGroup






period
PeriodWithOptionalStartEndTypeOptional
This period allows you to specify the start and end date of the contentGroup.Not used
startgmtdatetimeMandatory2018-11-20T13:12:27ZStart date of the Content GroupMandatory
endgmtdatetimeMandatory2018-11-20T13:12:27ZEnd date of the Content GroupMandatory

cmsData - contentGroup - metadataSet

ElementsFields/​attributesTypeRequiredSample dataDescriptionIONMDS
cmsData







contentGroup







metadataSet

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

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 valueMandatoryEpgElement
key="Title"stringOptional
TitleMandatoryprivateMetadata
key="SeasonNumber"stringOptional
Season number. Mandatory if the contentGroup type is set to season.MandatoryprivateMetadata

cmsData - contentGroup - parentRef

ElementsFields/​attributesTypeRequiredSample dataDescriptionIONMDS
cmsData







contentGroup







parentRef
BaseResourceTypeOptional
Reference to the parent content groupMandatoryprivateMetadata
providerIdstringMandatoryplurimediaUnique identification of a parent content groupMandatoryprivateMetadata
providerResourceIdstringMandatory32330896Unique resource identification of a parent content groupMandatoryprivateMetadata

cmsData - contentGroup - images

ElementsFields/​attributesTypeRequiredSample dataDescriptionIONIHS
cmsData







contentGroup







images

ImageSetTypeOptional
Representing 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.Mandatoryuri
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.Mandatorylocale
title
stringOptional
Locale-specific name of the imageOptionaltitle
externalId

ExternalIdTypeOptional
Source information of the imageOptionalexternalId
externalSource
ExternalSourceTypeMandatory

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

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

If this problem persists, please contact our support.