Playout API
/
Episode scenes
/
Get scene details

Media Jay Playout API (2025-08-04)

The playout API of the Media Jay application provides access to the playout data and orchestrates extended queries.

Authentication

To access the endpoints you require a X-API-Key in the header. Partners, please contact Transfermedia support@transfermedia.de to retrieve one.

Versioning

To use a specific implementation version of this API place it to the request header X-API-Version. If the header is missed the latest implementation version 2025-08-04 is used. The response header X-API-Version returns the implementation version the request was processed with.

Further documentation

For further details please visit the documentation or contact Transfermedia support@transfermedia.de.

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
Development Server

https://docs.jay-metadata.com/_mock/apis/playout/latest/openapi/

Session Tracking

APIs for managing user tracking sessions. These endpoints allow clients to create, retrieve, and delete tracking sessions which are used for analytics and user behavior tracking.

Operations

Formats

Access to formats metadata (aka movie collections or series).

Operations

Episodes

Access to episode metadata and general information.

Operations

Episode items

Information about episode items.

Operations

Episode timeline

Information about timeline events with complete timing information.

Operations

Episode groups

Information about existing groups.

Operations

Episode scenes

Information about the scenes.

Operations

List all scenes in an episode

Request

Retrieves all scenes from an episode's timeline with optional time-based filtering.

Scenes are sequential segments of the episode that may contain interactive elements, products, or other metadata. They provide a time-based structure for the content and can be used for navigation and interaction points.

Scenes form the narrative structure of the content and help viewers understand the context for interactive elements that appear during playback.

The scenes can be filtered by a specific timestamp (in milliseconds or timecode format) to find which scene is active at a particular moment in the playback.

When inline=true is specified, referenced objects within scenes (such as products, characters, or locations) will be expanded with their full data rather than just providing references.

Args:

request: the complete request. playout_id: The playout identifier (aka tenant identifier) for authentication and content selection. episode_id: The specific episode identifier to get scenes from. filter_millis: Optional timestamp in milliseconds to find the active scene. filter_timecode: Optional timecode in hh:mm:ss:ff format to find the active scene. inline_level: The number of levels to expand inner object inline.

Returns:

ResultResponse[List[PlayoutScene]]: Result response contains a list of scenes from the episode, each containing metadata such as title, description, start and end times, and references to other objects.

Raises:

ApiHttpException: When the episode is not found, or when the timeline or descriptions data is unavailable or invalid.

Path
playoutIdstring(playout identifier)required

The playout identifier (aka tenant identifier) addressing the correct content of the streaming platform.

episodeIdstring(episode identifier)required

The episode identifier.

Query
filterTimeinteger(time of interest)

The time in milliseconds to get the scene for.

filterTimecodestring(time code (hh:mm:ss:ff) of interest)^\d\d:\d\d:\d\d:\d\d$

The time code (hh:mm:ss:ff) to get the scene for.

inlineLevelinteger(inline level)[ 0 .. 4 ]

The number of levels to expand inner object inline. The lower this number the faster the response.

Default 0
Example: inlineLevel=1
Headers
X-API-Keystring(X-Api-Key)required

Required. API access key for authorized use of the checkout endpoints. Partners, please contact Transfermedia to retrieve a valid key.

__Secure-jay_trackingstring( Secure-Jay Tracking)

Tracking session header for user tracking and analytics. This is set by the /playouts/tracking/session endpoint.

Example: __Secure-jay_tracking=eyJzZX...
curl -i -X GET \
  'https://docs.jay-metadata.com/_mock/apis/playout/latest/openapi/playouts/{playoutId}/episodes/{episodeId}/scenes?filterTime=0&filterTimecode=string&inlineLevel=1' \
  -H 'X-API-Key: string' \
  -H '__Secure-jay_tracking: __Secure-jay_tracking=eyJzZX...'

Responses

Successfully retrieved list of scenes with timestamps and metadata

Bodyapplication/json
dataArray of objects(The response data)

The response data.

Example: [{"id":"string","kind":"<<enum 'PlayoutKindType'>>","start":0,"end":0,"startTc":"string","endTc":"string","productIds":["item"],"products":[{"id":"string","kind":"<<enum 'PlayoutKindType'>>","type":"string","name":"string","brand":"string","subtitle":"string","description":"string","gender":"string","category":"string","fit":"string","material":"string","color":"string","colorCode":"string","country":"string","images":[{"url":"string","copyright":"string"}],"imagesLogo":"string","imagesLogoCopyright":"string","links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"sku":"string","price":"string","priceFloat":0,"originalPrice":"string","currency":"string","variantsCompact":"string","variants":[{"title":"string","content":"string","sku":"string","price":"string","priceFloat":0,"originalPrice":"string","currency":"string","cartUrl":"string","basketProductId":"string"}],"groupIds":["item"],"groups":[{"id":"string","kind":"<<enum 'PlayoutKindType'>>","mainMenu":true,"name":"string","subtitle":"string","description":"string","images":[{"url":"string","copyright":"string"}],"links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"layout":"string","groupIds":["item"],"groups":["item"],"characterIds":["item"],"characters":["item"],"actorIds":["item"],"actors":["item"],"locationIds":["item"],"locations":["item"],"costumeIds":["item"],"costumes":["item"],"productIds":["item"],"products":["item"],"propIds":["item"],"props":["item"],"ticketIds":["item"],"tickets":["item"],"themeIds":["item"],"themes":["item"],"basicIds":["item"],"basics":["item"],"musicIds":["item"],"musics":["item"]}],"linkedToProductIds":["item"],"linkedToProducts":["item"],"basketProductId":"string"}],"characterIds":["item"],"characters":[{"id":"string","kind":"<<enum 'PlayoutKindType'>>","role":"string","name":"string","gender":"string","salutationTitle":"string","givenName":"string","linkingName":"string","familyName":"string","age":0,"yearOfBirth":"string","placeOfBirth":"string","countryOfBirth":"string","description":"string","images":[{"url":"string","copyright":"string"}],"links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"groupIds":["item"],"groups":[{"id":"string","kind":"<<enum 'PlayoutKindType'>>","mainMenu":true,"name":"string","subtitle":"string","description":"string","images":[{"url":"string","copyright":"string"}],"links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"layout":"string","groupIds":["item"],"groups":["item"],"characterIds":["item"],"characters":["item"],"actorIds":["item"],"actors":["item"],"locationIds":["item"],"locations":["item"],"costumeIds":["item"],"costumes":["item"],"productIds":["item"],"products":["item"],"propIds":["item"],"props":["item"],"ticketIds":["item"],"tickets":["item"],"themeIds":["item"],"themes":["item"],"basicIds":["item"],"basics":["item"],"musicIds":["item"],"musics":["item"]}],"locationIds":["item"],"locations":[{"id":"string","kind":"<<enum 'PlayoutKindType'>>","name":"string","title":"string","subtitle":"string","description":"string","street":"string","addition":"string","postcode":"string","city":"string","country":"string","longitude":"string","latitude":"string","images":[{"url":"string","copyright":"string"}],"links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"groupIds":["item"],"groups":[{"id":"string","kind":"<<enum 'PlayoutKindType'>>","mainMenu":true,"name":"string","subtitle":"string","description":"string","images":[{"url":"string","copyright":"string"}],"links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"layout":"string","groupIds":["item"],"groups":["item"],"characterIds":["item"],"characters":["item"],"actorIds":["item"],"actors":["item"],"locationIds":["item"],"locations":["item"],"costumeIds":["item"],"costumes":["item"],"productIds":["item"],"products":["item"],"propIds":["item"],"props":["item"],"ticketIds":["item"],"tickets":["item"],"themeIds":["item"],"themes":["item"],"basicIds":["item"],"basics":["item"],"musicIds":["item"],"musics":["item"]}]}],"costumeIds":["item"],"costumes":[{"id":"string","kind":"<<enum 'PlayoutKindType'>>","type":"string","name":"string","brand":"string","subtitle":"string","description":"string","gender":"string","category":"string","fit":"string","material":"string","color":"string","colorCode":"string","country":"string","images":[{"url":"string","copyright":"string"}],"imagesLogo":"string","imagesLogoCopyright":"string","links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"sku":"string","price":"string","priceFloat":0,"originalPrice":"string","currency":"string","variantsCompact":"string","variants":[{"title":"string","content":"string","sku":"string","price":"string","priceFloat":0,"originalPrice":"string","currency":"string","cartUrl":"string","basketProductId":"string"}],"groupIds":["item"],"groups":[{"id":"string","kind":"<<enum 'PlayoutKindType'>>","mainMenu":true,"name":"string","subtitle":"string","description":"string","images":[{"url":"string","copyright":"string"}],"links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"layout":"string","groupIds":["item"],"groups":["item"],"characterIds":["item"],"characters":["item"],"actorIds":["item"],"actors":["item"],"locationIds":["item"],"locations":["item"],"costumeIds":["item"],"costumes":["item"],"productIds":["item"],"products":["item"],"propIds":["item"],"props":["item"],"ticketIds":["item"],"tickets":["item"],"themeIds":["item"],"themes":["item"],"basicIds":["item"],"basics":["item"],"musicIds":["item"],"musics":["item"]}],"linkedToProductIds":["item"],"linkedToProducts":["item"],"basketProductId":"string"}],"productIds":["item"],"products":[{"id":"string","kind":"<<enum 'PlayoutKindType'>>","type":"string","name":"string","brand":"string","subtitle":"string","description":"string","gender":"string","category":"string","fit":"string","material":"string","color":"string","colorCode":"string","country":"string","images":[{"url":"string","copyright":"string"}],"imagesLogo":"string","imagesLogoCopyright":"string","links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"sku":"string","price":"string","priceFloat":0,"originalPrice":"string","currency":"string","variantsCompact":"string","variants":[{"title":"string","content":"string","sku":"string","price":"string","priceFloat":0,"originalPrice":"string","currency":"string","cartUrl":"string","basketProductId":"string"}],"groupIds":["item"],"groups":[{"id":"string","kind":"<<enum 'PlayoutKindType'>>","mainMenu":true,"name":"string","subtitle":"string","description":"string","images":[{"url":"string","copyright":"string"}],"links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"layout":"string","groupIds":["item"],"groups":["item"],"characterIds":["item"],"characters":["item"],"actorIds":["item"],"actors":["item"],"locationIds":["item"],"locations":["item"],"costumeIds":["item"],"costumes":["item"],"productIds":["item"],"products":["item"],"propIds":["item"],"props":["item"],"ticketIds":["item"],"tickets":["item"],"themeIds":["item"],"themes":["item"],"basicIds":["item"],"basics":["item"],"musicIds":["item"],"musics":["item"]}],"linkedToProductIds":["item"],"linkedToProducts":["item"],"basketProductId":"string"}],"propIds":["item"],"props":[{"id":"string","kind":"<<enum 'PlayoutKindType'>>","type":"string","name":"string","brand":"string","subtitle":"string","description":"string","gender":"string","category":"string","fit":"string","material":"string","color":"string","colorCode":"string","country":"string","images":[{"url":"string","copyright":"string"}],"imagesLogo":"string","imagesLogoCopyright":"string","links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"sku":"string","price":"string","priceFloat":0,"originalPrice":"string","currency":"string","variantsCompact":"string","variants":[{"title":"string","content":"string","sku":"string","price":"string","priceFloat":0,"originalPrice":"string","currency":"string","cartUrl":"string","basketProductId":"string"}],"groupIds":["item"],"groups":[{"id":"string","kind":"<<enum 'PlayoutKindType'>>","mainMenu":true,"name":"string","subtitle":"string","description":"string","images":[{"url":"string","copyright":"string"}],"links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"layout":"string","groupIds":["item"],"groups":["item"],"characterIds":["item"],"characters":["item"],"actorIds":["item"],"actors":["item"],"locationIds":["item"],"locations":["item"],"costumeIds":["item"],"costumes":["item"],"productIds":["item"],"products":["item"],"propIds":["item"],"props":["item"],"ticketIds":["item"],"tickets":["item"],"themeIds":["item"],"themes":["item"],"basicIds":["item"],"basics":["item"],"musicIds":["item"],"musics":["item"]}],"linkedToProductIds":["item"],"linkedToProducts":["item"],"basketProductId":"string"}]}],"actorIds":["item"],"actors":[{"id":"string","kind":"<<enum 'PlayoutKindType'>>","role":"string","name":"string","gender":"string","salutationTitle":"string","givenName":"string","linkingName":"string","familyName":"string","age":0,"yearOfBirth":"string","placeOfBirth":"string","countryOfBirth":"string","description":"string","images":[{"url":"string","copyright":"string"}],"links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"groupIds":["item"],"groups":[{"id":"string","kind":"<<enum 'PlayoutKindType'>>","mainMenu":true,"name":"string","subtitle":"string","description":"string","images":[{"url":"string","copyright":"string"}],"links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"layout":"string","groupIds":["item"],"groups":["item"],"characterIds":["item"],"characters":["item"],"actorIds":["item"],"actors":["item"],"locationIds":["item"],"locations":["item"],"costumeIds":["item"],"costumes":["item"],"productIds":["item"],"products":["item"],"propIds":["item"],"props":["item"],"ticketIds":["item"],"tickets":["item"],"themeIds":["item"],"themes":["item"],"basicIds":["item"],"basics":["item"],"musicIds":["item"],"musics":["item"]}],"locationIds":["item"],"locations":[{"id":"string","kind":"<<enum 'PlayoutKindType'>>","name":"string","title":"string","subtitle":"string","description":"string","street":"string","addition":"string","postcode":"string","city":"string","country":"string","longitude":"string","latitude":"string","images":[{"url":"string","copyright":"string"}],"links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"groupIds":["item"],"groups":[{"id":"string","kind":"<<enum 'PlayoutKindType'>>","mainMenu":true,"name":"string","subtitle":"string","description":"string","images":[{"url":"string","copyright":"string"}],"links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"layout":"string","groupIds":["item"],"groups":["item"],"characterIds":["item"],"characters":["item"],"actorIds":["item"],"actors":["item"],"locationIds":["item"],"locations":["item"],"costumeIds":["item"],"costumes":["item"],"productIds":["item"],"products":["item"],"propIds":["item"],"props":["item"],"ticketIds":["item"],"tickets":["item"],"themeIds":["item"],"themes":["item"],"basicIds":["item"],"basics":["item"],"musicIds":["item"],"musics":["item"]}]}],"costumeIds":["item"],"costumes":[{"id":"string","kind":"<<enum 'PlayoutKindType'>>","type":"string","name":"string","brand":"string","subtitle":"string","description":"string","gender":"string","category":"string","fit":"string","material":"string","color":"string","colorCode":"string","country":"string","images":[{"url":"string","copyright":"string"}],"imagesLogo":"string","imagesLogoCopyright":"string","links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"sku":"string","price":"string","priceFloat":0,"originalPrice":"string","currency":"string","variantsCompact":"string","variants":[{"title":"string","content":"string","sku":"string","price":"string","priceFloat":0,"originalPrice":"string","currency":"string","cartUrl":"string","basketProductId":"string"}],"groupIds":["item"],"groups":[{"id":"string","kind":"<<enum 'PlayoutKindType'>>","mainMenu":true,"name":"string","subtitle":"string","description":"string","images":[{"url":"string","copyright":"string"}],"links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"layout":"string","groupIds":["item"],"groups":["item"],"characterIds":["item"],"characters":["item"],"actorIds":["item"],"actors":["item"],"locationIds":["item"],"locations":["item"],"costumeIds":["item"],"costumes":["item"],"productIds":["item"],"products":["item"],"propIds":["item"],"props":["item"],"ticketIds":["item"],"tickets":["item"],"themeIds":["item"],"themes":["item"],"basicIds":["item"],"basics":["item"],"musicIds":["item"],"musics":["item"]}],"linkedToProductIds":["item"],"linkedToProducts":["item"],"basketProductId":"string"}],"productIds":["item"],"products":[{"id":"string","kind":"<<enum 'PlayoutKindType'>>","type":"string","name":"string","brand":"string","subtitle":"string","description":"string","gender":"string","category":"string","fit":"string","material":"string","color":"string","colorCode":"string","country":"string","images":[{"url":"string","copyright":"string"}],"imagesLogo":"string","imagesLogoCopyright":"string","links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"sku":"string","price":"string","priceFloat":0,"originalPrice":"string","currency":"string","variantsCompact":"string","variants":[{"title":"string","content":"string","sku":"string","price":"string","priceFloat":0,"originalPrice":"string","currency":"string","cartUrl":"string","basketProductId":"string"}],"groupIds":["item"],"groups":[{"id":"string","kind":"<<enum 'PlayoutKindType'>>","mainMenu":true,"name":"string","subtitle":"string","description":"string","images":[{"url":"string","copyright":"string"}],"links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"layout":"string","groupIds":["item"],"groups":["item"],"characterIds":["item"],"characters":["item"],"actorIds":["item"],"actors":["item"],"locationIds":["item"],"locations":["item"],"costumeIds":["item"],"costumes":["item"],"productIds":["item"],"products":["item"],"propIds":["item"],"props":["item"],"ticketIds":["item"],"tickets":["item"],"themeIds":["item"],"themes":["item"],"basicIds":["item"],"basics":["item"],"musicIds":["item"],"musics":["item"]}],"linkedToProductIds":["item"],"linkedToProducts":["item"],"basketProductId":"string"}],"propIds":["item"],"props":[{"id":"string","kind":"<<enum 'PlayoutKindType'>>","type":"string","name":"string","brand":"string","subtitle":"string","description":"string","gender":"string","category":"string","fit":"string","material":"string","color":"string","colorCode":"string","country":"string","images":[{"url":"string","copyright":"string"}],"imagesLogo":"string","imagesLogoCopyright":"string","links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"sku":"string","price":"string","priceFloat":0,"originalPrice":"string","currency":"string","variantsCompact":"string","variants":[{"title":"string","content":"string","sku":"string","price":"string","priceFloat":0,"originalPrice":"string","currency":"string","cartUrl":"string","basketProductId":"string"}],"groupIds":["item"],"groups":[{"id":"string","kind":"<<enum 'PlayoutKindType'>>","mainMenu":true,"name":"string","subtitle":"string","description":"string","images":[{"url":"string","copyright":"string"}],"links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"layout":"string","groupIds":["item"],"groups":["item"],"characterIds":["item"],"characters":["item"],"actorIds":["item"],"actors":["item"],"locationIds":["item"],"locations":["item"],"costumeIds":["item"],"costumes":["item"],"productIds":["item"],"products":["item"],"propIds":["item"],"props":["item"],"ticketIds":["item"],"tickets":["item"],"themeIds":["item"],"themes":["item"],"basicIds":["item"],"basics":["item"],"musicIds":["item"],"musics":["item"]}],"linkedToProductIds":["item"],"linkedToProducts":["item"],"basketProductId":"string"}]}],"locationIds":["item"],"locations":[{"id":"string","kind":"<<enum 'PlayoutKindType'>>","name":"string","title":"string","subtitle":"string","description":"string","street":"string","addition":"string","postcode":"string","city":"string","country":"string","longitude":"string","latitude":"string","images":[{"url":"string","copyright":"string"}],"links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"groupIds":["item"],"groups":[{"id":"string","kind":"<<enum 'PlayoutKindType'>>","mainMenu":true,"name":"string","subtitle":"string","description":"string","images":[{"url":"string","copyright":"string"}],"links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"layout":"string","groupIds":["item"],"groups":["item"],"characterIds":["item"],"characters":["item"],"actorIds":["item"],"actors":["item"],"locationIds":["item"],"locations":["item"],"costumeIds":["item"],"costumes":["item"],"productIds":["item"],"products":["item"],"propIds":["item"],"props":["item"],"ticketIds":["item"],"tickets":["item"],"themeIds":["item"],"themes":["item"],"basicIds":["item"],"basics":["item"],"musicIds":["item"],"musics":["item"]}]}],"costumeIds":["item"],"costumes":[{"id":"string","kind":"<<enum 'PlayoutKindType'>>","type":"string","name":"string","brand":"string","subtitle":"string","description":"string","gender":"string","category":"string","fit":"string","material":"string","color":"string","colorCode":"string","country":"string","images":[{"url":"string","copyright":"string"}],"imagesLogo":"string","imagesLogoCopyright":"string","links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"sku":"string","price":"string","priceFloat":0,"originalPrice":"string","currency":"string","variantsCompact":"string","variants":[{"title":"string","content":"string","sku":"string","price":"string","priceFloat":0,"originalPrice":"string","currency":"string","cartUrl":"string","basketProductId":"string"}],"groupIds":["item"],"groups":[{"id":"string","kind":"<<enum 'PlayoutKindType'>>","mainMenu":true,"name":"string","subtitle":"string","description":"string","images":[{"url":"string","copyright":"string"}],"links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"layout":"string","groupIds":["item"],"groups":["item"],"characterIds":["item"],"characters":["item"],"actorIds":["item"],"actors":["item"],"locationIds":["item"],"locations":["item"],"costumeIds":["item"],"costumes":["item"],"productIds":["item"],"products":["item"],"propIds":["item"],"props":["item"],"ticketIds":["item"],"tickets":["item"],"themeIds":["item"],"themes":["item"],"basicIds":["item"],"basics":["item"],"musicIds":["item"],"musics":["item"]}],"linkedToProductIds":["item"],"linkedToProducts":["item"],"basketProductId":"string"}],"propIds":["item"],"props":[{"id":"string","kind":"<<enum 'PlayoutKindType'>>","type":"string","name":"string","brand":"string","subtitle":"string","description":"string","gender":"string","category":"string","fit":"string","material":"string","color":"string","colorCode":"string","country":"string","images":[{"url":"string","copyright":"string"}],"imagesLogo":"string","imagesLogoCopyright":"string","links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"sku":"string","price":"string","priceFloat":0,"originalPrice":"string","currency":"string","variantsCompact":"string","variants":[{"title":"string","content":"string","sku":"string","price":"string","priceFloat":0,"originalPrice":"string","currency":"string","cartUrl":"string","basketProductId":"string"}],"groupIds":["item"],"groups":[{"id":"string","kind":"<<enum 'PlayoutKindType'>>","mainMenu":true,"name":"string","subtitle":"string","description":"string","images":[{"url":"string","copyright":"string"}],"links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"layout":"string","groupIds":["item"],"groups":["item"],"characterIds":["item"],"characters":["item"],"actorIds":["item"],"actors":["item"],"locationIds":["item"],"locations":["item"],"costumeIds":["item"],"costumes":["item"],"productIds":["item"],"products":["item"],"propIds":["item"],"props":["item"],"ticketIds":["item"],"tickets":["item"],"themeIds":["item"],"themes":["item"],"basicIds":["item"],"basics":["item"],"musicIds":["item"],"musics":["item"]}],"linkedToProductIds":["item"],"linkedToProducts":["item"],"basketProductId":"string"}],"ticketIds":["item"],"tickets":[{"id":"string","kind":"<<enum 'PlayoutKindType'>>","name":"string","location":"string","description":"string","playtimes":"string","images":[{"url":"string","copyright":"string"}],"links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"groupIds":["item"],"groups":[{"id":"string","kind":"<<enum 'PlayoutKindType'>>","mainMenu":true,"name":"string","subtitle":"string","description":"string","images":[{"url":"string","copyright":"string"}],"links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"layout":"string","groupIds":["item"],"groups":["item"],"characterIds":["item"],"characters":["item"],"actorIds":["item"],"actors":["item"],"locationIds":["item"],"locations":["item"],"costumeIds":["item"],"costumes":["item"],"productIds":["item"],"products":["item"],"propIds":["item"],"props":["item"],"ticketIds":["item"],"tickets":["item"],"themeIds":["item"],"themes":["item"],"basicIds":["item"],"basics":["item"],"musicIds":["item"],"musics":["item"]}],"productIds":["item"],"products":[{"id":"string","kind":"<<enum 'PlayoutKindType'>>","type":"string","name":"string","brand":"string","subtitle":"string","description":"string","gender":"string","category":"string","fit":"string","material":"string","color":"string","colorCode":"string","country":"string","images":[{"url":"string","copyright":"string"}],"imagesLogo":"string","imagesLogoCopyright":"string","links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"sku":"string","price":"string","priceFloat":0,"originalPrice":"string","currency":"string","variantsCompact":"string","variants":[{"title":"string","content":"string","sku":"string","price":"string","priceFloat":0,"originalPrice":"string","currency":"string","cartUrl":"string","basketProductId":"string"}],"groupIds":["item"],"groups":[{"id":"string","kind":"<<enum 'PlayoutKindType'>>","mainMenu":true,"name":"string","subtitle":"string","description":"string","images":[{"url":"string","copyright":"string"}],"links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"layout":"string","groupIds":["item"],"groups":["item"],"characterIds":["item"],"characters":["item"],"actorIds":["item"],"actors":["item"],"locationIds":["item"],"locations":["item"],"costumeIds":["item"],"costumes":["item"],"productIds":["item"],"products":["item"],"propIds":["item"],"props":["item"],"ticketIds":["item"],"tickets":["item"],"themeIds":["item"],"themes":["item"],"basicIds":["item"],"basics":["item"],"musicIds":["item"],"musics":["item"]}],"linkedToProductIds":["item"],"linkedToProducts":["item"],"basketProductId":"string"}]}],"themeIds":["item"],"themes":[{"id":"string","kind":"<<enum 'PlayoutKindType'>>","name":"string","subtitle":"string","author":"string","dateCreated":"string","description":"string","images":[{"url":"string","copyright":"string"}],"links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"groupIds":["item"],"groups":[{"id":"string","kind":"<<enum 'PlayoutKindType'>>","mainMenu":true,"name":"string","subtitle":"string","description":"string","images":[{"url":"string","copyright":"string"}],"links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"layout":"string","groupIds":["item"],"groups":["item"],"characterIds":["item"],"characters":["item"],"actorIds":["item"],"actors":["item"],"locationIds":["item"],"locations":["item"],"costumeIds":["item"],"costumes":["item"],"productIds":["item"],"products":["item"],"propIds":["item"],"props":["item"],"ticketIds":["item"],"tickets":["item"],"themeIds":["item"],"themes":["item"],"basicIds":["item"],"basics":["item"],"musicIds":["item"],"musics":["item"]}],"productIds":["item"],"products":[{"id":"string","kind":"<<enum 'PlayoutKindType'>>","type":"string","name":"string","brand":"string","subtitle":"string","description":"string","gender":"string","category":"string","fit":"string","material":"string","color":"string","colorCode":"string","country":"string","images":[{"url":"string","copyright":"string"}],"imagesLogo":"string","imagesLogoCopyright":"string","links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"sku":"string","price":"string","priceFloat":0,"originalPrice":"string","currency":"string","variantsCompact":"string","variants":[{"title":"string","content":"string","sku":"string","price":"string","priceFloat":0,"originalPrice":"string","currency":"string","cartUrl":"string","basketProductId":"string"}],"groupIds":["item"],"groups":[{"id":"string","kind":"<<enum 'PlayoutKindType'>>","mainMenu":true,"name":"string","subtitle":"string","description":"string","images":[{"url":"string","copyright":"string"}],"links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"layout":"string","groupIds":["item"],"groups":["item"],"characterIds":["item"],"characters":["item"],"actorIds":["item"],"actors":["item"],"locationIds":["item"],"locations":["item"],"costumeIds":["item"],"costumes":["item"],"productIds":["item"],"products":["item"],"propIds":["item"],"props":["item"],"ticketIds":["item"],"tickets":["item"],"themeIds":["item"],"themes":["item"],"basicIds":["item"],"basics":["item"],"musicIds":["item"],"musics":["item"]}],"linkedToProductIds":["item"],"linkedToProducts":["item"],"basketProductId":"string"}]}],"basicIds":["item"],"basics":[{"id":"string","kind":"<<enum 'PlayoutKindType'>>","name":"string","subtitle":"string","description":"string","brand":"string","material":"string","color":"string","colorCode":"string","dimensions":"string","ingredients":"string","images":[{"url":"string","copyright":"string"}],"links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"groupIds":["item"],"groups":[{"id":"string","kind":"<<enum 'PlayoutKindType'>>","mainMenu":true,"name":"string","subtitle":"string","description":"string","images":[{"url":"string","copyright":"string"}],"links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"layout":"string","groupIds":["item"],"groups":["item"],"characterIds":["item"],"characters":["item"],"actorIds":["item"],"actors":["item"],"locationIds":["item"],"locations":["item"],"costumeIds":["item"],"costumes":["item"],"productIds":["item"],"products":["item"],"propIds":["item"],"props":["item"],"ticketIds":["item"],"tickets":["item"],"themeIds":["item"],"themes":["item"],"basicIds":["item"],"basics":["item"],"musicIds":["item"],"musics":["item"]}],"productIds":["item"],"products":[{"id":"string","kind":"<<enum 'PlayoutKindType'>>","type":"string","name":"string","brand":"string","subtitle":"string","description":"string","gender":"string","category":"string","fit":"string","material":"string","color":"string","colorCode":"string","country":"string","images":[{"url":"string","copyright":"string"}],"imagesLogo":"string","imagesLogoCopyright":"string","links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"sku":"string","price":"string","priceFloat":0,"originalPrice":"string","currency":"string","variantsCompact":"string","variants":[{"title":"string","content":"string","sku":"string","price":"string","priceFloat":0,"originalPrice":"string","currency":"string","cartUrl":"string","basketProductId":"string"}],"groupIds":["item"],"groups":[{"id":"string","kind":"<<enum 'PlayoutKindType'>>","mainMenu":true,"name":"string","subtitle":"string","description":"string","images":[{"url":"string","copyright":"string"}],"links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"layout":"string","groupIds":["item"],"groups":["item"],"characterIds":["item"],"characters":["item"],"actorIds":["item"],"actors":["item"],"locationIds":["item"],"locations":["item"],"costumeIds":["item"],"costumes":["item"],"productIds":["item"],"products":["item"],"propIds":["item"],"props":["item"],"ticketIds":["item"],"tickets":["item"],"themeIds":["item"],"themes":["item"],"basicIds":["item"],"basics":["item"],"musicIds":["item"],"musics":["item"]}],"linkedToProductIds":["item"],"linkedToProducts":["item"],"basketProductId":"string"}]}],"musicIds":["item"],"musics":[{"id":"string","kind":"<<enum 'PlayoutKindType'>>","name":"string","subtitle":"string","description":"string","artist":"string","album":"string","duration":"string","images":[{"url":"string","copyright":"string"}],"links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"groupIds":["item"],"groups":[{"id":"string","kind":"<<enum 'PlayoutKindType'>>","mainMenu":true,"name":"string","subtitle":"string","description":"string","images":[{"url":"string","copyright":"string"}],"links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"layout":"string","groupIds":["item"],"groups":["item"],"characterIds":["item"],"characters":["item"],"actorIds":["item"],"actors":["item"],"locationIds":["item"],"locations":["item"],"costumeIds":["item"],"costumes":["item"],"productIds":["item"],"products":["item"],"propIds":["item"],"props":["item"],"ticketIds":["item"],"tickets":["item"],"themeIds":["item"],"themes":["item"],"basicIds":["item"],"basics":["item"],"musicIds":["item"],"musics":["item"]}]}]}]
errorobject(The error response)

Represents a data response with a possible error.

Response
application/json
{
  "data": [
    { … }
  ]
}

Get scene details

Request

Get the detailed information about a specific scene in the episode.

This endpoint returns timing information, associated products, characters, and other relevant metadata for a specific scene. Scenes are fundamental narrative units that provide context for interactive elements and help organize the viewing experience.

Args:

request: the complete request. playout_id: The playout identifier (aka tenant identifier). episode_id: The episode identifier scene_id: The data identifier inline_level: The number of levels to expand inner object inline.

Returns:

ResultResponse[PlayoutScene]: Result Response contains the requested scene details.

Raises:

HTTPException: If the episode, descriptions, timeline, or specific scene are not found (404).

Path
playoutIdstring(playout identifier)required

The playout identifier (aka tenant identifier) addressing the correct content of the streaming platform.

episodeIdstring(episode identifier)required

The episode identifier.

sceneIdstring(scene identifier)required

The identifier of the scene

Query
inlineLevelinteger(inline level)[ 0 .. 4 ]

The number of levels to expand inner object inline. The lower this number the faster the response.

Default 0
Example: inlineLevel=1
Headers
X-API-Keystring(X-Api-Key)required

Required. API access key for authorized use of the checkout endpoints. Partners, please contact Transfermedia to retrieve a valid key.

__Secure-jay_trackingstring( Secure-Jay Tracking)

Tracking session header for user tracking and analytics. This is set by the /playouts/tracking/session endpoint.

Example: __Secure-jay_tracking=eyJzZX...
curl -i -X GET \
  'https://docs.jay-metadata.com/_mock/apis/playout/latest/openapi/playouts/{playoutId}/episodes/{episodeId}/scenes/{sceneId}?inlineLevel=1' \
  -H 'X-API-Key: string' \
  -H '__Secure-jay_tracking: __Secure-jay_tracking=eyJzZX...'

Responses

Successfully retrieved scene details

Bodyapplication/json
dataobject(The response data)

Represents a single timeline entry

Example: {"id":"string","kind":"<<enum 'PlayoutKindType'>>","start":0,"end":0,"startTc":"string","endTc":"string","productIds":["item"],"products":[{"id":"string","kind":"<<enum 'PlayoutKindType'>>","type":"string","name":"string","brand":"string","subtitle":"string","description":"string","gender":"string","category":"string","fit":"string","material":"string","color":"string","colorCode":"string","country":"string","images":[{"url":"string","copyright":"string"}],"imagesLogo":"string","imagesLogoCopyright":"string","links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"sku":"string","price":"string","priceFloat":0,"originalPrice":"string","currency":"string","variantsCompact":"string","variants":[{"title":"string","content":"string","sku":"string","price":"string","priceFloat":0,"originalPrice":"string","currency":"string","cartUrl":"string","basketProductId":"string"}],"groupIds":["item"],"groups":[{"id":"string","kind":"<<enum 'PlayoutKindType'>>","mainMenu":true,"name":"string","subtitle":"string","description":"string","images":[{"url":"string","copyright":"string"}],"links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"layout":"string","groupIds":["item"],"groups":["item"],"characterIds":["item"],"characters":["item"],"actorIds":["item"],"actors":["item"],"locationIds":["item"],"locations":["item"],"costumeIds":["item"],"costumes":["item"],"productIds":["item"],"products":["item"],"propIds":["item"],"props":["item"],"ticketIds":["item"],"tickets":["item"],"themeIds":["item"],"themes":["item"],"basicIds":["item"],"basics":["item"],"musicIds":["item"],"musics":["item"]}],"linkedToProductIds":["item"],"linkedToProducts":["item"],"basketProductId":"string"}],"characterIds":["item"],"characters":[{"id":"string","kind":"<<enum 'PlayoutKindType'>>","role":"string","name":"string","gender":"string","salutationTitle":"string","givenName":"string","linkingName":"string","familyName":"string","age":0,"yearOfBirth":"string","placeOfBirth":"string","countryOfBirth":"string","description":"string","images":[{"url":"string","copyright":"string"}],"links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"groupIds":["item"],"groups":[{"id":"string","kind":"<<enum 'PlayoutKindType'>>","mainMenu":true,"name":"string","subtitle":"string","description":"string","images":[{"url":"string","copyright":"string"}],"links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"layout":"string","groupIds":["item"],"groups":["item"],"characterIds":["item"],"characters":["item"],"actorIds":["item"],"actors":["item"],"locationIds":["item"],"locations":["item"],"costumeIds":["item"],"costumes":["item"],"productIds":["item"],"products":["item"],"propIds":["item"],"props":["item"],"ticketIds":["item"],"tickets":["item"],"themeIds":["item"],"themes":["item"],"basicIds":["item"],"basics":["item"],"musicIds":["item"],"musics":["item"]}],"locationIds":["item"],"locations":[{"id":"string","kind":"<<enum 'PlayoutKindType'>>","name":"string","title":"string","subtitle":"string","description":"string","street":"string","addition":"string","postcode":"string","city":"string","country":"string","longitude":"string","latitude":"string","images":[{"url":"string","copyright":"string"}],"links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"groupIds":["item"],"groups":[{"id":"string","kind":"<<enum 'PlayoutKindType'>>","mainMenu":true,"name":"string","subtitle":"string","description":"string","images":[{"url":"string","copyright":"string"}],"links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"layout":"string","groupIds":["item"],"groups":["item"],"characterIds":["item"],"characters":["item"],"actorIds":["item"],"actors":["item"],"locationIds":["item"],"locations":["item"],"costumeIds":["item"],"costumes":["item"],"productIds":["item"],"products":["item"],"propIds":["item"],"props":["item"],"ticketIds":["item"],"tickets":["item"],"themeIds":["item"],"themes":["item"],"basicIds":["item"],"basics":["item"],"musicIds":["item"],"musics":["item"]}]}],"costumeIds":["item"],"costumes":[{"id":"string","kind":"<<enum 'PlayoutKindType'>>","type":"string","name":"string","brand":"string","subtitle":"string","description":"string","gender":"string","category":"string","fit":"string","material":"string","color":"string","colorCode":"string","country":"string","images":[{"url":"string","copyright":"string"}],"imagesLogo":"string","imagesLogoCopyright":"string","links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"sku":"string","price":"string","priceFloat":0,"originalPrice":"string","currency":"string","variantsCompact":"string","variants":[{"title":"string","content":"string","sku":"string","price":"string","priceFloat":0,"originalPrice":"string","currency":"string","cartUrl":"string","basketProductId":"string"}],"groupIds":["item"],"groups":[{"id":"string","kind":"<<enum 'PlayoutKindType'>>","mainMenu":true,"name":"string","subtitle":"string","description":"string","images":[{"url":"string","copyright":"string"}],"links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"layout":"string","groupIds":["item"],"groups":["item"],"characterIds":["item"],"characters":["item"],"actorIds":["item"],"actors":["item"],"locationIds":["item"],"locations":["item"],"costumeIds":["item"],"costumes":["item"],"productIds":["item"],"products":["item"],"propIds":["item"],"props":["item"],"ticketIds":["item"],"tickets":["item"],"themeIds":["item"],"themes":["item"],"basicIds":["item"],"basics":["item"],"musicIds":["item"],"musics":["item"]}],"linkedToProductIds":["item"],"linkedToProducts":["item"],"basketProductId":"string"}],"productIds":["item"],"products":[{"id":"string","kind":"<<enum 'PlayoutKindType'>>","type":"string","name":"string","brand":"string","subtitle":"string","description":"string","gender":"string","category":"string","fit":"string","material":"string","color":"string","colorCode":"string","country":"string","images":[{"url":"string","copyright":"string"}],"imagesLogo":"string","imagesLogoCopyright":"string","links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"sku":"string","price":"string","priceFloat":0,"originalPrice":"string","currency":"string","variantsCompact":"string","variants":[{"title":"string","content":"string","sku":"string","price":"string","priceFloat":0,"originalPrice":"string","currency":"string","cartUrl":"string","basketProductId":"string"}],"groupIds":["item"],"groups":[{"id":"string","kind":"<<enum 'PlayoutKindType'>>","mainMenu":true,"name":"string","subtitle":"string","description":"string","images":[{"url":"string","copyright":"string"}],"links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"layout":"string","groupIds":["item"],"groups":["item"],"characterIds":["item"],"characters":["item"],"actorIds":["item"],"actors":["item"],"locationIds":["item"],"locations":["item"],"costumeIds":["item"],"costumes":["item"],"productIds":["item"],"products":["item"],"propIds":["item"],"props":["item"],"ticketIds":["item"],"tickets":["item"],"themeIds":["item"],"themes":["item"],"basicIds":["item"],"basics":["item"],"musicIds":["item"],"musics":["item"]}],"linkedToProductIds":["item"],"linkedToProducts":["item"],"basketProductId":"string"}],"propIds":["item"],"props":[{"id":"string","kind":"<<enum 'PlayoutKindType'>>","type":"string","name":"string","brand":"string","subtitle":"string","description":"string","gender":"string","category":"string","fit":"string","material":"string","color":"string","colorCode":"string","country":"string","images":[{"url":"string","copyright":"string"}],"imagesLogo":"string","imagesLogoCopyright":"string","links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"sku":"string","price":"string","priceFloat":0,"originalPrice":"string","currency":"string","variantsCompact":"string","variants":[{"title":"string","content":"string","sku":"string","price":"string","priceFloat":0,"originalPrice":"string","currency":"string","cartUrl":"string","basketProductId":"string"}],"groupIds":["item"],"groups":[{"id":"string","kind":"<<enum 'PlayoutKindType'>>","mainMenu":true,"name":"string","subtitle":"string","description":"string","images":[{"url":"string","copyright":"string"}],"links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"layout":"string","groupIds":["item"],"groups":["item"],"characterIds":["item"],"characters":["item"],"actorIds":["item"],"actors":["item"],"locationIds":["item"],"locations":["item"],"costumeIds":["item"],"costumes":["item"],"productIds":["item"],"products":["item"],"propIds":["item"],"props":["item"],"ticketIds":["item"],"tickets":["item"],"themeIds":["item"],"themes":["item"],"basicIds":["item"],"basics":["item"],"musicIds":["item"],"musics":["item"]}],"linkedToProductIds":["item"],"linkedToProducts":["item"],"basketProductId":"string"}]}],"actorIds":["item"],"actors":[{"id":"string","kind":"<<enum 'PlayoutKindType'>>","role":"string","name":"string","gender":"string","salutationTitle":"string","givenName":"string","linkingName":"string","familyName":"string","age":0,"yearOfBirth":"string","placeOfBirth":"string","countryOfBirth":"string","description":"string","images":[{"url":"string","copyright":"string"}],"links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"groupIds":["item"],"groups":[{"id":"string","kind":"<<enum 'PlayoutKindType'>>","mainMenu":true,"name":"string","subtitle":"string","description":"string","images":[{"url":"string","copyright":"string"}],"links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"layout":"string","groupIds":["item"],"groups":["item"],"characterIds":["item"],"characters":["item"],"actorIds":["item"],"actors":["item"],"locationIds":["item"],"locations":["item"],"costumeIds":["item"],"costumes":["item"],"productIds":["item"],"products":["item"],"propIds":["item"],"props":["item"],"ticketIds":["item"],"tickets":["item"],"themeIds":["item"],"themes":["item"],"basicIds":["item"],"basics":["item"],"musicIds":["item"],"musics":["item"]}],"locationIds":["item"],"locations":[{"id":"string","kind":"<<enum 'PlayoutKindType'>>","name":"string","title":"string","subtitle":"string","description":"string","street":"string","addition":"string","postcode":"string","city":"string","country":"string","longitude":"string","latitude":"string","images":[{"url":"string","copyright":"string"}],"links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"groupIds":["item"],"groups":[{"id":"string","kind":"<<enum 'PlayoutKindType'>>","mainMenu":true,"name":"string","subtitle":"string","description":"string","images":[{"url":"string","copyright":"string"}],"links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"layout":"string","groupIds":["item"],"groups":["item"],"characterIds":["item"],"characters":["item"],"actorIds":["item"],"actors":["item"],"locationIds":["item"],"locations":["item"],"costumeIds":["item"],"costumes":["item"],"productIds":["item"],"products":["item"],"propIds":["item"],"props":["item"],"ticketIds":["item"],"tickets":["item"],"themeIds":["item"],"themes":["item"],"basicIds":["item"],"basics":["item"],"musicIds":["item"],"musics":["item"]}]}],"costumeIds":["item"],"costumes":[{"id":"string","kind":"<<enum 'PlayoutKindType'>>","type":"string","name":"string","brand":"string","subtitle":"string","description":"string","gender":"string","category":"string","fit":"string","material":"string","color":"string","colorCode":"string","country":"string","images":[{"url":"string","copyright":"string"}],"imagesLogo":"string","imagesLogoCopyright":"string","links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"sku":"string","price":"string","priceFloat":0,"originalPrice":"string","currency":"string","variantsCompact":"string","variants":[{"title":"string","content":"string","sku":"string","price":"string","priceFloat":0,"originalPrice":"string","currency":"string","cartUrl":"string","basketProductId":"string"}],"groupIds":["item"],"groups":[{"id":"string","kind":"<<enum 'PlayoutKindType'>>","mainMenu":true,"name":"string","subtitle":"string","description":"string","images":[{"url":"string","copyright":"string"}],"links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"layout":"string","groupIds":["item"],"groups":["item"],"characterIds":["item"],"characters":["item"],"actorIds":["item"],"actors":["item"],"locationIds":["item"],"locations":["item"],"costumeIds":["item"],"costumes":["item"],"productIds":["item"],"products":["item"],"propIds":["item"],"props":["item"],"ticketIds":["item"],"tickets":["item"],"themeIds":["item"],"themes":["item"],"basicIds":["item"],"basics":["item"],"musicIds":["item"],"musics":["item"]}],"linkedToProductIds":["item"],"linkedToProducts":["item"],"basketProductId":"string"}],"productIds":["item"],"products":[{"id":"string","kind":"<<enum 'PlayoutKindType'>>","type":"string","name":"string","brand":"string","subtitle":"string","description":"string","gender":"string","category":"string","fit":"string","material":"string","color":"string","colorCode":"string","country":"string","images":[{"url":"string","copyright":"string"}],"imagesLogo":"string","imagesLogoCopyright":"string","links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"sku":"string","price":"string","priceFloat":0,"originalPrice":"string","currency":"string","variantsCompact":"string","variants":[{"title":"string","content":"string","sku":"string","price":"string","priceFloat":0,"originalPrice":"string","currency":"string","cartUrl":"string","basketProductId":"string"}],"groupIds":["item"],"groups":[{"id":"string","kind":"<<enum 'PlayoutKindType'>>","mainMenu":true,"name":"string","subtitle":"string","description":"string","images":[{"url":"string","copyright":"string"}],"links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"layout":"string","groupIds":["item"],"groups":["item"],"characterIds":["item"],"characters":["item"],"actorIds":["item"],"actors":["item"],"locationIds":["item"],"locations":["item"],"costumeIds":["item"],"costumes":["item"],"productIds":["item"],"products":["item"],"propIds":["item"],"props":["item"],"ticketIds":["item"],"tickets":["item"],"themeIds":["item"],"themes":["item"],"basicIds":["item"],"basics":["item"],"musicIds":["item"],"musics":["item"]}],"linkedToProductIds":["item"],"linkedToProducts":["item"],"basketProductId":"string"}],"propIds":["item"],"props":[{"id":"string","kind":"<<enum 'PlayoutKindType'>>","type":"string","name":"string","brand":"string","subtitle":"string","description":"string","gender":"string","category":"string","fit":"string","material":"string","color":"string","colorCode":"string","country":"string","images":[{"url":"string","copyright":"string"}],"imagesLogo":"string","imagesLogoCopyright":"string","links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"sku":"string","price":"string","priceFloat":0,"originalPrice":"string","currency":"string","variantsCompact":"string","variants":[{"title":"string","content":"string","sku":"string","price":"string","priceFloat":0,"originalPrice":"string","currency":"string","cartUrl":"string","basketProductId":"string"}],"groupIds":["item"],"groups":[{"id":"string","kind":"<<enum 'PlayoutKindType'>>","mainMenu":true,"name":"string","subtitle":"string","description":"string","images":[{"url":"string","copyright":"string"}],"links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"layout":"string","groupIds":["item"],"groups":["item"],"characterIds":["item"],"characters":["item"],"actorIds":["item"],"actors":["item"],"locationIds":["item"],"locations":["item"],"costumeIds":["item"],"costumes":["item"],"productIds":["item"],"products":["item"],"propIds":["item"],"props":["item"],"ticketIds":["item"],"tickets":["item"],"themeIds":["item"],"themes":["item"],"basicIds":["item"],"basics":["item"],"musicIds":["item"],"musics":["item"]}],"linkedToProductIds":["item"],"linkedToProducts":["item"],"basketProductId":"string"}]}],"locationIds":["item"],"locations":[{"id":"string","kind":"<<enum 'PlayoutKindType'>>","name":"string","title":"string","subtitle":"string","description":"string","street":"string","addition":"string","postcode":"string","city":"string","country":"string","longitude":"string","latitude":"string","images":[{"url":"string","copyright":"string"}],"links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"groupIds":["item"],"groups":[{"id":"string","kind":"<<enum 'PlayoutKindType'>>","mainMenu":true,"name":"string","subtitle":"string","description":"string","images":[{"url":"string","copyright":"string"}],"links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"layout":"string","groupIds":["item"],"groups":["item"],"characterIds":["item"],"characters":["item"],"actorIds":["item"],"actors":["item"],"locationIds":["item"],"locations":["item"],"costumeIds":["item"],"costumes":["item"],"productIds":["item"],"products":["item"],"propIds":["item"],"props":["item"],"ticketIds":["item"],"tickets":["item"],"themeIds":["item"],"themes":["item"],"basicIds":["item"],"basics":["item"],"musicIds":["item"],"musics":["item"]}]}],"costumeIds":["item"],"costumes":[{"id":"string","kind":"<<enum 'PlayoutKindType'>>","type":"string","name":"string","brand":"string","subtitle":"string","description":"string","gender":"string","category":"string","fit":"string","material":"string","color":"string","colorCode":"string","country":"string","images":[{"url":"string","copyright":"string"}],"imagesLogo":"string","imagesLogoCopyright":"string","links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"sku":"string","price":"string","priceFloat":0,"originalPrice":"string","currency":"string","variantsCompact":"string","variants":[{"title":"string","content":"string","sku":"string","price":"string","priceFloat":0,"originalPrice":"string","currency":"string","cartUrl":"string","basketProductId":"string"}],"groupIds":["item"],"groups":[{"id":"string","kind":"<<enum 'PlayoutKindType'>>","mainMenu":true,"name":"string","subtitle":"string","description":"string","images":[{"url":"string","copyright":"string"}],"links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"layout":"string","groupIds":["item"],"groups":["item"],"characterIds":["item"],"characters":["item"],"actorIds":["item"],"actors":["item"],"locationIds":["item"],"locations":["item"],"costumeIds":["item"],"costumes":["item"],"productIds":["item"],"products":["item"],"propIds":["item"],"props":["item"],"ticketIds":["item"],"tickets":["item"],"themeIds":["item"],"themes":["item"],"basicIds":["item"],"basics":["item"],"musicIds":["item"],"musics":["item"]}],"linkedToProductIds":["item"],"linkedToProducts":["item"],"basketProductId":"string"}],"propIds":["item"],"props":[{"id":"string","kind":"<<enum 'PlayoutKindType'>>","type":"string","name":"string","brand":"string","subtitle":"string","description":"string","gender":"string","category":"string","fit":"string","material":"string","color":"string","colorCode":"string","country":"string","images":[{"url":"string","copyright":"string"}],"imagesLogo":"string","imagesLogoCopyright":"string","links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"sku":"string","price":"string","priceFloat":0,"originalPrice":"string","currency":"string","variantsCompact":"string","variants":[{"title":"string","content":"string","sku":"string","price":"string","priceFloat":0,"originalPrice":"string","currency":"string","cartUrl":"string","basketProductId":"string"}],"groupIds":["item"],"groups":[{"id":"string","kind":"<<enum 'PlayoutKindType'>>","mainMenu":true,"name":"string","subtitle":"string","description":"string","images":[{"url":"string","copyright":"string"}],"links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"layout":"string","groupIds":["item"],"groups":["item"],"characterIds":["item"],"characters":["item"],"actorIds":["item"],"actors":["item"],"locationIds":["item"],"locations":["item"],"costumeIds":["item"],"costumes":["item"],"productIds":["item"],"products":["item"],"propIds":["item"],"props":["item"],"ticketIds":["item"],"tickets":["item"],"themeIds":["item"],"themes":["item"],"basicIds":["item"],"basics":["item"],"musicIds":["item"],"musics":["item"]}],"linkedToProductIds":["item"],"linkedToProducts":["item"],"basketProductId":"string"}],"ticketIds":["item"],"tickets":[{"id":"string","kind":"<<enum 'PlayoutKindType'>>","name":"string","location":"string","description":"string","playtimes":"string","images":[{"url":"string","copyright":"string"}],"links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"groupIds":["item"],"groups":[{"id":"string","kind":"<<enum 'PlayoutKindType'>>","mainMenu":true,"name":"string","subtitle":"string","description":"string","images":[{"url":"string","copyright":"string"}],"links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"layout":"string","groupIds":["item"],"groups":["item"],"characterIds":["item"],"characters":["item"],"actorIds":["item"],"actors":["item"],"locationIds":["item"],"locations":["item"],"costumeIds":["item"],"costumes":["item"],"productIds":["item"],"products":["item"],"propIds":["item"],"props":["item"],"ticketIds":["item"],"tickets":["item"],"themeIds":["item"],"themes":["item"],"basicIds":["item"],"basics":["item"],"musicIds":["item"],"musics":["item"]}],"productIds":["item"],"products":[{"id":"string","kind":"<<enum 'PlayoutKindType'>>","type":"string","name":"string","brand":"string","subtitle":"string","description":"string","gender":"string","category":"string","fit":"string","material":"string","color":"string","colorCode":"string","country":"string","images":[{"url":"string","copyright":"string"}],"imagesLogo":"string","imagesLogoCopyright":"string","links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"sku":"string","price":"string","priceFloat":0,"originalPrice":"string","currency":"string","variantsCompact":"string","variants":[{"title":"string","content":"string","sku":"string","price":"string","priceFloat":0,"originalPrice":"string","currency":"string","cartUrl":"string","basketProductId":"string"}],"groupIds":["item"],"groups":[{"id":"string","kind":"<<enum 'PlayoutKindType'>>","mainMenu":true,"name":"string","subtitle":"string","description":"string","images":[{"url":"string","copyright":"string"}],"links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"layout":"string","groupIds":["item"],"groups":["item"],"characterIds":["item"],"characters":["item"],"actorIds":["item"],"actors":["item"],"locationIds":["item"],"locations":["item"],"costumeIds":["item"],"costumes":["item"],"productIds":["item"],"products":["item"],"propIds":["item"],"props":["item"],"ticketIds":["item"],"tickets":["item"],"themeIds":["item"],"themes":["item"],"basicIds":["item"],"basics":["item"],"musicIds":["item"],"musics":["item"]}],"linkedToProductIds":["item"],"linkedToProducts":["item"],"basketProductId":"string"}]}],"themeIds":["item"],"themes":[{"id":"string","kind":"<<enum 'PlayoutKindType'>>","name":"string","subtitle":"string","author":"string","dateCreated":"string","description":"string","images":[{"url":"string","copyright":"string"}],"links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"groupIds":["item"],"groups":[{"id":"string","kind":"<<enum 'PlayoutKindType'>>","mainMenu":true,"name":"string","subtitle":"string","description":"string","images":[{"url":"string","copyright":"string"}],"links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"layout":"string","groupIds":["item"],"groups":["item"],"characterIds":["item"],"characters":["item"],"actorIds":["item"],"actors":["item"],"locationIds":["item"],"locations":["item"],"costumeIds":["item"],"costumes":["item"],"productIds":["item"],"products":["item"],"propIds":["item"],"props":["item"],"ticketIds":["item"],"tickets":["item"],"themeIds":["item"],"themes":["item"],"basicIds":["item"],"basics":["item"],"musicIds":["item"],"musics":["item"]}],"productIds":["item"],"products":[{"id":"string","kind":"<<enum 'PlayoutKindType'>>","type":"string","name":"string","brand":"string","subtitle":"string","description":"string","gender":"string","category":"string","fit":"string","material":"string","color":"string","colorCode":"string","country":"string","images":[{"url":"string","copyright":"string"}],"imagesLogo":"string","imagesLogoCopyright":"string","links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"sku":"string","price":"string","priceFloat":0,"originalPrice":"string","currency":"string","variantsCompact":"string","variants":[{"title":"string","content":"string","sku":"string","price":"string","priceFloat":0,"originalPrice":"string","currency":"string","cartUrl":"string","basketProductId":"string"}],"groupIds":["item"],"groups":[{"id":"string","kind":"<<enum 'PlayoutKindType'>>","mainMenu":true,"name":"string","subtitle":"string","description":"string","images":[{"url":"string","copyright":"string"}],"links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"layout":"string","groupIds":["item"],"groups":["item"],"characterIds":["item"],"characters":["item"],"actorIds":["item"],"actors":["item"],"locationIds":["item"],"locations":["item"],"costumeIds":["item"],"costumes":["item"],"productIds":["item"],"products":["item"],"propIds":["item"],"props":["item"],"ticketIds":["item"],"tickets":["item"],"themeIds":["item"],"themes":["item"],"basicIds":["item"],"basics":["item"],"musicIds":["item"],"musics":["item"]}],"linkedToProductIds":["item"],"linkedToProducts":["item"],"basketProductId":"string"}]}],"basicIds":["item"],"basics":[{"id":"string","kind":"<<enum 'PlayoutKindType'>>","name":"string","subtitle":"string","description":"string","brand":"string","material":"string","color":"string","colorCode":"string","dimensions":"string","ingredients":"string","images":[{"url":"string","copyright":"string"}],"links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"groupIds":["item"],"groups":[{"id":"string","kind":"<<enum 'PlayoutKindType'>>","mainMenu":true,"name":"string","subtitle":"string","description":"string","images":[{"url":"string","copyright":"string"}],"links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"layout":"string","groupIds":["item"],"groups":["item"],"characterIds":["item"],"characters":["item"],"actorIds":["item"],"actors":["item"],"locationIds":["item"],"locations":["item"],"costumeIds":["item"],"costumes":["item"],"productIds":["item"],"products":["item"],"propIds":["item"],"props":["item"],"ticketIds":["item"],"tickets":["item"],"themeIds":["item"],"themes":["item"],"basicIds":["item"],"basics":["item"],"musicIds":["item"],"musics":["item"]}],"productIds":["item"],"products":[{"id":"string","kind":"<<enum 'PlayoutKindType'>>","type":"string","name":"string","brand":"string","subtitle":"string","description":"string","gender":"string","category":"string","fit":"string","material":"string","color":"string","colorCode":"string","country":"string","images":[{"url":"string","copyright":"string"}],"imagesLogo":"string","imagesLogoCopyright":"string","links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"sku":"string","price":"string","priceFloat":0,"originalPrice":"string","currency":"string","variantsCompact":"string","variants":[{"title":"string","content":"string","sku":"string","price":"string","priceFloat":0,"originalPrice":"string","currency":"string","cartUrl":"string","basketProductId":"string"}],"groupIds":["item"],"groups":[{"id":"string","kind":"<<enum 'PlayoutKindType'>>","mainMenu":true,"name":"string","subtitle":"string","description":"string","images":[{"url":"string","copyright":"string"}],"links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"layout":"string","groupIds":["item"],"groups":["item"],"characterIds":["item"],"characters":["item"],"actorIds":["item"],"actors":["item"],"locationIds":["item"],"locations":["item"],"costumeIds":["item"],"costumes":["item"],"productIds":["item"],"products":["item"],"propIds":["item"],"props":["item"],"ticketIds":["item"],"tickets":["item"],"themeIds":["item"],"themes":["item"],"basicIds":["item"],"basics":["item"],"musicIds":["item"],"musics":["item"]}],"linkedToProductIds":["item"],"linkedToProducts":["item"],"basketProductId":"string"}]}],"musicIds":["item"],"musics":[{"id":"string","kind":"<<enum 'PlayoutKindType'>>","name":"string","subtitle":"string","description":"string","artist":"string","album":"string","duration":"string","images":[{"url":"string","copyright":"string"}],"links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"groupIds":["item"],"groups":[{"id":"string","kind":"<<enum 'PlayoutKindType'>>","mainMenu":true,"name":"string","subtitle":"string","description":"string","images":[{"url":"string","copyright":"string"}],"links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"layout":"string","groupIds":["item"],"groups":["item"],"characterIds":["item"],"characters":["item"],"actorIds":["item"],"actors":["item"],"locationIds":["item"],"locations":["item"],"costumeIds":["item"],"costumes":["item"],"productIds":["item"],"products":["item"],"propIds":["item"],"props":["item"],"ticketIds":["item"],"tickets":["item"],"themeIds":["item"],"themes":["item"],"basicIds":["item"],"basics":["item"],"musicIds":["item"],"musics":["item"]}]}]}
errorobject(The error response)

Represents a data response with a possible error.

Response
application/json
{
  "data": {
    "id": "string",
    "kind": "<<enum 'PlayoutKindType'>>",
    "start": 0,
    "end": 0,
    "startTc": "string",
    "endTc": "string",
    "productIds": [ … ],
    "products": [ … ],
    "characterIds": [ … ],
    "characters": [ … ],
    "actorIds": [ … ],
    "actors": [ … ],
    "locationIds": [ … ],
    "locations": [ … ],
    "costumeIds": [ … ],
    "costumes": [ … ],
    "propIds": [ … ],
    "props": [ … ],
    "ticketIds": [ … ],
    "tickets": [ … ],
    "themeIds": [ … ],
    "themes": [ … ],
    "basicIds": [ … ],
    "basics": [ … ],
    "musicIds": [ … ],
    "musics": [ … ]
  }
}

Episode companies involved

Information about the involved companies.

Operations

API information

Operations