productLink (technical-based)
The technical model is now deprecated and will be removed from the documentation in the next release.
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 - productLink
| Elements | Fields/attributes | Type | Required | Sample data | Description | ION | |
|---|---|---|---|---|---|---|---|
cmsData | |||||||
productLink | AddProductLinkType | Optional | A product link to create/update | Not used | |||
cmsData - productLink - productRef
| Elements | Fields/attributes | Type | Required | Sample data | Description | ION | MDS | ||
|---|---|---|---|---|---|---|---|---|---|
cmsData | |||||||||
productLink | |||||||||
productRef | BaseResourceType | Mandatory | Reference to the linked product | Not used | productId | ||||
providerId | string | Mandatory | GLOBAL | Unique identification of product | Mandatory | provider | |||
providerResourceId | string | Mandatory | TVOD_LEG_WALLEC2 | Unique resource identification of product | Mandatory | ||||
cmsData - productLink - marketableRef
| Elements | Fields/attributes | Type | Required | Sample data | Description | ION | MDS | ||
|---|---|---|---|---|---|---|---|---|---|
cmsData | |||||||||
productLink | |||||||||
marketableRef | MarketableResourceType | Mandatory | Reference to the linked marketable | Not used | vodItemId | ||||
providerId | string | Mandatory | GLOBAL | Unique identification of technical content | Mandatory | provider | |||
providerResourceId | string | Mandatory | TVOD_LEG_WALLEC2_TRENDING | Unique resource identification of technical content | Mandatory | ||||
type | string | Mandatory | contentPublishingWindow | Allows you to specify the kind of marketable that a product is linked to (allowed values: technicalChannel, node, and contentPublishingWindow) | Mandatory | ||||
cmsData - productLink - validityPeriodSet
| Elements | Fields/attributes | Type | Required | Sample data | Description | ION | MDS | |||
|---|---|---|---|---|---|---|---|---|---|---|
cmsData | ||||||||||
productLink | ||||||||||
| Mandatory | Set of periods during which the marketable sold by the specified product is authorised to be played. If no validity periods are set, the authorisation is based on the validity period of the marketable sold by the specified product. | Not used | |||||||
| PeriodWithOptionalStartEndType | Optional | Period of time during which the marketable sold by the specified product is authorised to be played | Not used | Period | |||||
start | gmtdatetime | Mandatory | 2012-06-19T00:00:00Z | Start date of the validity period | Not used | start | ||||
end | gmtdatetime | Mandatory | 2023-12-19T00:00:00Z | End date of the validity period | Not used | end | ||||