logo
API docs by Redocly

Channel

Download OpenAPI specification:Download

URL: https://veset.tv/ Terms of Service

Services

Ingest - Library - Channel - Schedule - Playout - Audit - Accounts - Reporting - Monitoring - Configuration - Metrics

Flyway

Flyway

Get all flyway migrations

Returns all flyway

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Delete flyway migration

Delete flyway

path Parameters
rank
required
integer <int32>

Responses

Response samples

Content type
application/json
{ }

Jobs

Jobs

Get jobs

Returns queued jobs

query Parameters
organization
Array of strings
providerId
string
userId
string
status
Array of strings
Items Enum: "PENDING" "PROCESSING" "SUCCEEDED" "FAILED" "CANCELED"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get job

Returns queued job

path Parameters
jobId
required
integer <int64>

Job id

query Parameters
organization
Array of strings

Organization Id

providerId
string

Provider Id

Responses

Response samples

Content type
application/json
{
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateFinished": "2019-08-24T14:15:22Z",
  • "entityId": "string",
  • "fileName": "string",
  • "id": "string",
  • "jobType": "string",
  • "messages": [
    ],
  • "organization": "string",
  • "resourceExtension": "string",
  • "resourceLink": "string",
  • "serviceProviderId": "string",
  • "status": "PENDING",
  • "uniqueId": "string",
  • "userId": "string"
}

Channels

Channels API

Get channels

Returns channels

query Parameters
organization
Array of strings

Organization Id

providerId
string

Service Provider Id

exclude
Array of strings

List of fields to exclude. Currently only [playouts] and [timelineStatus] exclusion is supported

playouts
string

Search by playout ids.

emergencyPlaylist
string

Search by emergencyPlaylist asset name.

graphicsProject
string

Search by assigned graphics project name.

graphicsProjectV2
string

Search by assigned graphics project name.

emergencyTemplate
string

Search by assigned emergency template name.

multimediaPackage
string

Search by assigned multimedia package name.

hasPlayouts
boolean

Search channels only if it has playouts

emergencyPlaylistId
Long

Search channels assigned Emergency Playlist or Placeholder Playlist

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create new channel

Creates new channel

query Parameters
organization
string

Organization Id

Request Body schema: application/json
required
audioFallbackLanguage
string
audioLoudness
number <float>
audioLoudnessNormalizationEnabled
boolean
breakMax
integer <int64>
breakMin
integer <int64>
broadcastId
integer <int64>
dateCreated
string <date-time>
dateUpdated
string <date-time>
description
string
emergencyPlaylistId
integer <int64>
emergencyTemplate
string
object (EventThresholdsDTO)
fps
number <float>
gpiDelay
integer <int64>
gpiHardwareId
string
graphicsProject
string
graphicsProjectV2
string
id
integer <int64>
ingestLookaheadEnabled
boolean
key
string <uuid>
object (LiveSettingsDTO)

Live settings object

lockOwnerUserName
string
lockType
string
Enum: "APPLY_SCHEDULE" "SKIP_TAKE" "EDIT_MODE"
Array of objects (ChannelSecondaryEvent)
multimediaPackage
string
name
string
object (PendingChangesDTO)
Array of objects (PlaceholderPlaylistDTO)
playlistStartTime
string <date-time>
object (PlayoutSettingsDTO)
Array of objects (PlayoutDTO)
recordingFileNamePattern
string
skipTakeDelay
integer <int32>
startOfDay
integer <int64>
stationId
integer <int64>
timeZone
string
timelineEditable
boolean
timelineLooped
boolean
object (TimelineStatusDTO)
object (TwitchSettingsDTO)
unlockable
boolean
version
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "audioFallbackLanguage": "string",
  • "audioLoudness": 0.1,
  • "audioLoudnessNormalizationEnabled": true,
  • "breakMax": 0,
  • "breakMin": 0,
  • "broadcastId": 0,
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "emergencyPlaylistId": 0,
  • "emergencyTemplate": "string",
  • "eventThresholds": {
    },
  • "fps": 0.1,
  • "gpiDelay": 0,
  • "gpiHardwareId": "string",
  • "graphicsProject": "string",
  • "graphicsProjectV2": "string",
  • "id": 0,
  • "ingestLookaheadEnabled": true,
  • "key": "4adfe27e-63d3-45b9-8238-62b6ed6fdb5e",
  • "liveSettings": {
    },
  • "lockOwnerUserName": "string",
  • "lockType": "APPLY_SCHEDULE",
  • "manualSecondaryEvents": [
    ],
  • "multimediaPackage": "string",
  • "name": "string",
  • "pendingChanges": {
    },
  • "placeholderPlaylists": [
    ],
  • "playlistStartTime": "2019-08-24T14:15:22Z",
  • "playoutSettings": {
    },
  • "playouts": [
    ],
  • "recordingFileNamePattern": "string",
  • "skipTakeDelay": 0,
  • "startOfDay": 0,
  • "stationId": 0,
  • "timeZone": "string",
  • "timelineEditable": true,
  • "timelineLooped": true,
  • "timelineStatus": {
    },
  • "twitchSettings": {
    },
  • "unlockable": true,
  • "version": 0
}

Response samples

Content type
application/json
{
  • "content": {
    },
  • "messages": [
    ]
}

Fetch channels by related assetId

Fetch channels by related assetId

query Parameters
organization
required
string

Organization Id

Request Body schema: application/json
Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

Content type
application/json
{
  • "property1": [
    ],
  • "property2": [
    ]
}

Returns assets in use

Returns list of assets in use for given organization and date

query Parameters
dateScheduledFrom
required
string <date-time>

Responses

Response samples

Content type
application/json
[
  • "string"
]

Fetch channels by related blockId

Fetch channels by related blockId

path Parameters
blockId
required
integer <int64>

Block id

query Parameters
organization
required
string

Organization Id

Responses

Response samples

Content type
application/json
[
  • {
    }
]

devLogOff

Responses

Response samples

Content type
"string"

devLogOn

Responses

Response samples

Content type
"string"

Download exported asset report file

Returns CSV file containing missing assets report

path Parameters
fileName
required
string

File name

query Parameters
providerId
string

Service Provider Id

organization
string

Organization Id

Responses

Response samples

Content type
{ }

Download exported asset report file

Returns CSV file containing missing assets report

path Parameters
fileName
required
string
query Parameters
providerId
string

Service Provider Id

Responses

Response samples

Content type
{ }

Generate EPG report

path Parameters
key
required
string <uuid>
query Parameters
timezone
string

Time zone

scriptId
string

Transformation script id

Responses

Response samples

Content type
{ }

Perfrom channel migration to different service proivider

Request Body schema: application/json
required
string

Responses

Request samples

Content type
application/json
"string"

Response samples

Content type
application/json
{ }

Find missing assets

Returns list of missing assets for given organization

query Parameters
organization
required
string

Responses

Response samples

Content type
application/json
[
  • "string"
]

Generate missing assets report across all channels for given organization or service provider

query Parameters
providerId
string

Service Provider Id

format
string
Default: "CSV"

format, possible values: CSV, JSON

organization
string

Organization Id

Responses

Response samples

Content type
application/json
{
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateFinished": "2019-08-24T14:15:22Z",
  • "entityId": "string",
  • "fileName": "string",
  • "id": "string",
  • "jobType": "string",
  • "messages": [
    ],
  • "organization": "string",
  • "resourceExtension": "string",
  • "resourceLink": "string",
  • "serviceProviderId": "string",
  • "status": "PENDING",
  • "uniqueId": "string",
  • "userId": "string"
}

Change block event

Update block on channel.

path Parameters
blockId
required
integer <int64>

Block id

query Parameters
organization
string

Organization Id

Request Body schema: application/json
required
dateCreated
string <date-time>
dateUpdated
string <date-time>
Array of objects (BlockEventDTO)
fps
number <float>
id
integer <int64>
name
string
version
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "events": [
    ],
  • "fps": 0.1,
  • "id": 0,
  • "name": "string",
  • "version": 0
}

Response samples

Content type
application/json
{
  • "cause": {
    },
  • "code": 0,
  • "incomplete": [
    ],
  • "localizedMessage": "string",
  • "message": "string",
  • "messages": [
    ],
  • "missing": [
    ],
  • "stackTrace": [
    ],
  • "suppressed": [
    ],
  • "unsuccessfulQC": [
    ]
}

Change playlist event

Update emergency / placeholder playlists on channel.

query Parameters
organization
string

Organization Id

Request Body schema: application/json
required
integer <int64>

Playlist id

Responses

Request samples

Content type
application/json
0
0

Response samples

Content type
application/json
{
  • "cause": {
    },
  • "code": 0,
  • "incomplete": [
    ],
  • "localizedMessage": "string",
  • "message": "string",
  • "messages": [
    ],
  • "missing": [
    ],
  • "stackTrace": [
    ],
  • "suppressed": [
    ],
  • "unsuccessfulQC": [
    ]
}

Get assigned playout id list

Returns list of playout ids assigned to channels

query Parameters
organization
string

Organization Id

Responses

Response samples

Content type
application/json
[
  • "string"
]

Get assigned playout summary

Returns assigned playout summary

query Parameters
organization
string

Organization Id

Responses

Response samples

Content type
application/json
{
  • "property1": 0,
  • "property2": 0
}

Unassign backup playout from channel

Unassings backup playout from channel by id

query Parameters
playoutId
required
string
organization
required
string

Responses

Response samples

Content type
application/json
{ }

Skip manually locked event

query Parameters
hardwareId
required
string

Hardware id

timestamp
string <date-time>
organization
string

Organization Id

Responses

Response samples

Content type
application/json
{
  • "content": "string",
  • "messages": [
    ]
}

Check if timeline events exist

Checks if there are any timeline events starting from provided date

query Parameters
playoutId
required
string
dateFrom
required
string <date-time>

Responses

Response samples

Content type
application/json
true

Get ingest priority time for given media id and organization

query Parameters
mediaId
required
string
organization
required
string

Responses

Response samples

Content type
application/json
{
  • "priorityTime": "2019-08-24T14:15:22Z"
}

Get Event list

Returns Event list map

query Parameters
channelIds
Array of integers <int64> [ items <int64 > ]

Channel ids

organization
string

Organization Id

Request Body schema: application/json
required
blockId
integer <int64>
eventType
string
Enum: "PRIMARY" "ADVERTISEMENT" "LIVE" "PLACEHOLDER" "BLOCK" "EMERGENCY"
hasLabel
boolean
label
string
onAirTimeFrom
string <date-time>
onAirTimeTo
string <date-time>
size
integer <int32>
strictPeriodSearch
boolean
term
string

Responses

Request samples

Content type
application/json
{
  • "blockId": 0,
  • "eventType": "PRIMARY",
  • "hasLabel": true,
  • "label": "string",
  • "onAirTimeFrom": "2019-08-24T14:15:22Z",
  • "onAirTimeTo": "2019-08-24T14:15:22Z",
  • "size": 0,
  • "strictPeriodSearch": true,
  • "term": "string"
}

Response samples

Content type
application/json
{
  • "property1": [
    ],
  • "property2": [
    ]
}

Shifts timeline based on given parameters

query Parameters
playoutId
required
string
organization
required
string
Request Body schema: application/json
required
allowExitEmergencyOnTake
boolean
allowExitLiveOnTake
boolean
Array of objects (ShiftedEventDTO)
originatorPlayoutId
string
rangeEnd
string <date-time>
rangeStart
string <date-time>
scteLiveSourceId
string
takeReason
string
takeSequenceNumber
integer <int32>
takenEventId
integer <int64>
version
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "allowExitEmergencyOnTake": true,
  • "allowExitLiveOnTake": true,
  • "content": [
    ],
  • "originatorPlayoutId": "string",
  • "rangeEnd": "2019-08-24T14:15:22Z",
  • "rangeStart": "2019-08-24T14:15:22Z",
  • "scteLiveSourceId": "string",
  • "takeReason": "string",
  • "takeSequenceNumber": 0,
  • "takenEventId": 0,
  • "version": 0
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "messages": [
    ]
}

Reset organization timeline statuses

Resets organization timeline statuses

query Parameters
organization
required
string

Responses

Response samples

Content type
application/json
{
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateFinished": "2019-08-24T14:15:22Z",
  • "entityId": "string",
  • "fileName": "string",
  • "id": "string",
  • "jobType": "string",
  • "messages": [
    ],
  • "organization": "string",
  • "resourceExtension": "string",
  • "resourceLink": "string",
  • "serviceProviderId": "string",
  • "status": "PENDING",
  • "uniqueId": "string",
  • "userId": "string"
}

Authorize twitch integration

Authorizes twitch integration by channel id. Timeline is not updated

query Parameters
state
required
integer <int64>

Channel id

code
required
string
organization
string

Organization Id

Responses

Response samples

Content type
application/json
{
  • "content": {
    },
  • "messages": [
    ]
}

Delete twitch settings

Removes twitch settings by organization id

query Parameters
organization
required
string

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "messages": [
    ]
}

Delete channel

Removes channel by id

path Parameters
channelId
required
integer <int64>

Channel id

query Parameters
organization
string

Organization Id

Responses

Response samples

Content type
application/json
{ }

Get channel

Returns channel found by id

path Parameters
channelId
required
integer <int64>

Channel id

query Parameters
exclude
Array of strings

List of fields to exclude. Currently only [playouts] and [timelineStatus] exclusion is supported

organization
string

Organization Id

Responses

Response samples

Content type
application/json
{
  • "audioFallbackLanguage": "string",
  • "audioLoudness": 0.1,
  • "audioLoudnessNormalizationEnabled": true,
  • "breakMax": 0,
  • "breakMin": 0,
  • "broadcastId": 0,
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "emergencyPlaylistId": 0,
  • "emergencyTemplate": "string",
  • "eventThresholds": {
    },
  • "fps": 0.1,
  • "gpiDelay": 0,
  • "gpiHardwareId": "string",
  • "graphicsProject": "string",
  • "graphicsProjectV2": "string",
  • "id": 0,
  • "ingestLookaheadEnabled": true,
  • "key": "4adfe27e-63d3-45b9-8238-62b6ed6fdb5e",
  • "liveSettings": {
    },
  • "lockOwnerUserName": "string",
  • "lockType": "APPLY_SCHEDULE",
  • "manualSecondaryEvents": [
    ],
  • "multimediaPackage": "string",
  • "name": "string",
  • "pendingChanges": {
    },
  • "playlistStartTime": "2019-08-24T14:15:22Z",
  • "playoutSettings": {
    },
  • "playouts": [
    ],
  • "recordingFileNamePattern": "string",
  • "skipTakeDelay": 0,
  • "startOfDay": 0,
  • "stationId": 0,
  • "timeZone": "string",
  • "timelineEditable": true,
  • "timelineLooped": true,
  • "timelineStatus": {
    },
  • "twitchSettings": {
    },
  • "unlockable": true,
  • "version": 0
}

Update channel

Updates channel by id. Timeline is not updated

path Parameters
channelId
required
integer <int64>

Channel id

query Parameters
organization
string

Organization Id

Request Body schema: application/json
required
audioFallbackLanguage
string
audioLoudness
number <float>
audioLoudnessNormalizationEnabled
boolean
breakMax
integer <int64>
breakMin
integer <int64>
broadcastId
integer <int64>
dateCreated
string <date-time>
dateUpdated
string <date-time>
description
string
emergencyPlaylistId
integer <int64>
emergencyTemplate
string
object (EventThresholdsDTO)
fps
number <float>
gpiDelay
integer <int64>
gpiHardwareId
string
graphicsProject
string
graphicsProjectV2
string
id
integer <int64>
ingestLookaheadEnabled
boolean
key
string <uuid>
object (LiveSettingsDTO)

Live settings object

lockOwnerUserName
string
lockType
string
Enum: "APPLY_SCHEDULE" "SKIP_TAKE" "EDIT_MODE"
Array of objects (ChannelSecondaryEvent)
multimediaPackage
string
name
string
object (PendingChangesDTO)
playlistStartTime
string <date-time>
object (PlayoutSettingsDTO)
Array of objects (PlayoutDTO)
recordingFileNamePattern
string
skipTakeDelay
integer <int32>
startOfDay
integer <int64>
stationId
integer <int64>
timeZone
string
timelineEditable
boolean
timelineLooped
boolean
object (TimelineStatusDTO)
object (TwitchSettingsDTO)
unlockable
boolean
version
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "audioFallbackLanguage": "string",
  • "audioLoudness": 0.1,
  • "audioLoudnessNormalizationEnabled": true,
  • "breakMax": 0,
  • "breakMin": 0,
  • "broadcastId": 0,
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "emergencyPlaylistId": 0,
  • "emergencyTemplate": "string",
  • "eventThresholds": {
    },
  • "fps": 0.1,
  • "gpiDelay": 0,
  • "gpiHardwareId": "string",
  • "graphicsProject": "string",
  • "graphicsProjectV2": "string",
  • "id": 0,
  • "ingestLookaheadEnabled": true,
  • "key": "4adfe27e-63d3-45b9-8238-62b6ed6fdb5e",
  • "liveSettings": {
    },
  • "lockOwnerUserName": "string",
  • "lockType": "APPLY_SCHEDULE",
  • "manualSecondaryEvents": [
    ],
  • "multimediaPackage": "string",
  • "name": "string",
  • "pendingChanges": {
    },
  • "playlistStartTime": "2019-08-24T14:15:22Z",
  • "playoutSettings": {
    },
  • "playouts": [
    ],
  • "recordingFileNamePattern": "string",
  • "skipTakeDelay": 0,
  • "startOfDay": 0,
  • "stationId": 0,
  • "timeZone": "string",
  • "timelineEditable": true,
  • "timelineLooped": true,
  • "timelineStatus": {
    },
  • "twitchSettings": {
    },
  • "unlockable": true,
  • "version": 0
}

Response samples

Content type
application/json
{
  • "content": {
    },
  • "messages": [
    ]
}

Apply playlist to channel

Applies playlist to channel timeline

path Parameters
channelId
required
integer <int64>

Channel id

query Parameters
organization
string

Organization Id

Request Body schema: application/json
required
integer <int64>

Schedule id

Responses

Request samples

Content type
application/json
0
0

Response samples

Content type
application/json
{
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateFinished": "2019-08-24T14:15:22Z",
  • "entityId": "string",
  • "fileName": "string",
  • "id": "string",
  • "jobType": "string",
  • "messages": [
    ],
  • "organization": "string",
  • "resourceExtension": "string",
  • "resourceLink": "string",
  • "serviceProviderId": "string",
  • "status": "PENDING",
  • "uniqueId": "string",
  • "userId": "string"
}

Apply playlist to channel

Applies playlist to channel timeline

path Parameters
channelId
required
integer <int64>

Channel id

query Parameters
organization
string

Organization Id

Request Body schema: application/json
required
integer <int64>

Schedule id

Responses

Request samples

Content type
application/json
0
0

Response samples

Content type
application/json
{
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateFinished": "2019-08-24T14:15:22Z",
  • "entityId": "string",
  • "fileName": "string",
  • "id": "string",
  • "jobType": "string",
  • "messages": [
    ],
  • "organization": "string",
  • "resourceExtension": "string",
  • "resourceLink": "string",
  • "serviceProviderId": "string",
  • "status": "PENDING",
  • "uniqueId": "string",
  • "userId": "string"
}

Apply playlist to channel multiple times

Applies same playlist to channel timeline to multiple days

path Parameters
channelId
required
integer <int64>

Channel id

query Parameters
organization
string

Organization Id

Request Body schema: application/json
required
rangeInDays
integer <int32>
scheduleId
integer <int64>
startTime
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "rangeInDays": 0,
  • "scheduleId": 0,
  • "startTime": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateFinished": "2019-08-24T14:15:22Z",
  • "entityId": "string",
  • "fileName": "string",
  • "id": "string",
  • "jobType": "string",
  • "messages": [
    ],
  • "organization": "string",
  • "resourceExtension": "string",
  • "resourceLink": "string",
  • "serviceProviderId": "string",
  • "status": "PENDING",
  • "uniqueId": "string",
  • "userId": "string"
}

Apply scheduling timeline to channel timeline

Applies scheduling timeline to channel timeline

path Parameters
channelId
required
integer <int64>
query Parameters
organization
required
string
Request Body schema: application/json
required
rangeEndTime
string <date-time>
rangeStartTime
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "rangeEndTime": "2019-08-24T14:15:22Z",
  • "rangeStartTime": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateFinished": "2019-08-24T14:15:22Z",
  • "entityId": "string",
  • "fileName": "string",
  • "id": "string",
  • "jobType": "string",
  • "messages": [
    ],
  • "organization": "string",
  • "resourceExtension": "string",
  • "resourceLink": "string",
  • "serviceProviderId": "string",
  • "status": "PENDING",
  • "uniqueId": "string",
  • "userId": "string"
}

Assign playouts to channel

Assings playouts to channel by id

path Parameters
channelId
required
integer <int64>

Channel id

query Parameters
organization
string

Organization Id

Request Body schema: application/json
required
Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

Content type
application/json
{
  • "content": {
    },
  • "messages": [
    ]
}

Get channel timeline blocks

Returns channel timeline blocks

path Parameters
channelId
required
integer <int64>

Channel id

query Parameters
organization
required
string

Organization Id

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Delete channel emergency playlist

Returns updated channel.

path Parameters
channelId
required
integer <int64>

Channel id

query Parameters
organization
string

Organization Id

Responses

Response samples

Content type
application/json
{
  • "content": {
    },
  • "messages": [
    ]
}

Get channel emergency playlist

Returns channel emergency playlist.

path Parameters
channelId
required
integer <int64>

Channel id

query Parameters
organization
string

Organization Id

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Apply emergency playlist to channel

Sets emergency playlist to a channel. Playlist is read from schedule passed in body.

path Parameters
channelId
required
integer <int64>

Channel id

query Parameters
organization
string

Organization Id

Request Body schema: application/json
required
integer <int64>

Schedule id

Responses

Request samples

Content type
application/json
0
0

Response samples

Content type
application/json
{
  • "content": {
    },
  • "messages": [
    ]
}

Apply emergency template to channel

Sets emergency template to a channel. Emergency template name is passed in body.

path Parameters
channelId
required
integer <int64>

Channel id

query Parameters
organization
string

Organization Id

Request Body schema: application/json
required
string

Emergency template name

Responses

Request samples

Content type
application/json
"string"

Response samples

Content type
application/json
{
  • "content": {
    },
  • "messages": [
    ]
}

Apply graphics project to channel

Sets graphics project to a channel. Graphics project name is passed in body.

path Parameters
channelId
required
integer <int64>

Channel id

query Parameters
organization
string

Organization Id

Request Body schema: application/json
required
string

Graphics project name

Responses

Request samples

Content type
application/json
"string"

Response samples

Content type
application/json
{
  • "content": {
    },
  • "messages": [
    ]
}

Schedule immediate live secondary events

Schedule immediate rendering of live secondary events

path Parameters
channelId
required
integer <int64>

Channel id

query Parameters
organization
required
string

Organization Id

Request Body schema: application/json
required
Array
command
string
Enum: "ON" "OFF"
objectName
string
offset
integer <int64>
origin
string
Enum: "FROM_START" "FROM_END"
object
object

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "code": 0,
  • "messages": [
    ]
}

Update channel live settings

Updates channel live settings by id

path Parameters
channelId
required
integer <int64>

Channel id

query Parameters
version
required
integer <int32>

Channel version

organization
string

Organization Id

Request Body schema: application/json
Array of objects (SecondaryEventDTO)

Responses

Request samples

Content type
application/json
{
  • "secondaryEvents": [
    ]
}

Response samples

Content type
application/json
{
  • "content": {
    },
  • "messages": [
    ]
}

Sets lock to channel for last minute changes

Locked channel field are not modifiable for any user. Only lock owner will be able to modify timeline

path Parameters
channelId
required
integer <int64>

Channel id

query Parameters
organization
string

Organization Id

Responses

Response samples

Content type
application/json
{
  • "content": {
    },
  • "messages": [
    ]
}

getChannelLoopedTimeline

path Parameters
channelId
required
integer <int64>

Channel id

Responses

Response samples

Content type
application/json
[
  • {
    }
]

createLoopedTimelineEvent

path Parameters
channelId
required
integer <int64>

Channel id

query Parameters
version
required
integer <int32>

Channel version

Request Body schema: application/json
required
object (EventAssetDataDTO)
duration
integer <int64>
id
integer <int64>
mediaId
string
orderNumber
integer <int64>
Array of objects (SecondaryEventDTO)
som
integer <int64>
timecodeIn
integer <int64>
title
string
version
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "assetData": {
    },
  • "duration": 0,
  • "id": 0,
  • "mediaId": "string",
  • "orderNumber": 0,
  • "secondaryEvents": [
    ],
  • "som": 0,
  • "timecodeIn": 0,
  • "title": "string",
  • "version": 0
}

Response samples

Content type
application/json
{
  • "content": {
    },
  • "messages": [
    ]
}

modifyLoopedTimeline

path Parameters
channelId
required
integer <int64>

Channel id

query Parameters
version
required
integer <int32>

Channel version

Request Body schema: application/json
required
Array of objects (LoopedEventDTO)
deleted
Array of integers <int64> [ items <int64 > ]
Array of objects (LoopedEventDTO)

Responses

Request samples

Content type
application/json
{
  • "created": [
    ],
  • "deleted": [
    ],
  • "updated": [
    ]
}

Response samples

Content type
application/json
{
  • "content": {
    },
  • "messages": [
    ]
}

shuffleLoopedTimeline

path Parameters
channelId
required
integer <int64>

Channel id

query Parameters
version
required
integer <int32>

Channel version

Responses

Response samples

Content type
application/json
{
  • "content": {
    },
  • "messages": [
    ]
}

deleteLoopedTimelineEvent

path Parameters
channelId
required
integer <int64>

Channel id

eventId
required
integer <int64>

Timeline event id

query Parameters
version
required
integer <int32>

Channel version

Responses

Response samples

Content type
application/json
{
  • "content": {
    },
  • "messages": [
    ]
}

getChannelLoopedTimelineEvent

path Parameters
channelId
required
integer <int64>

Channel id

eventId
required
integer <int64>

Event id

Responses

Response samples

Content type
application/json
{
  • "assetData": {
    },
  • "duration": 0,
  • "id": 0,
  • "mediaId": "string",
  • "orderNumber": 0,
  • "secondaryEvents": [
    ],
  • "som": 0,
  • "timecodeIn": 0,
  • "title": "string",
  • "version": 0
}

updateLoopedTimelineEvent

path Parameters
channelId
required
integer <int64>

Channel id

eventId
required
integer <int64>

Looped timeline event id

query Parameters
version
required
integer <int32>

Channel version

Request Body schema: application/json
required
object (EventAssetDataDTO)
duration
integer <int64>
id
integer <int64>
mediaId
string
orderNumber
integer <int64>
Array of objects (SecondaryEventDTO)
som
integer <int64>
timecodeIn
integer <int64>
title
string
version
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "assetData": {
    },
  • "duration": 0,
  • "id": 0,
  • "mediaId": "string",
  • "orderNumber": 0,
  • "secondaryEvents": [
    ],
  • "som": 0,
  • "timecodeIn": 0,
  • "title": "string",
  • "version": 0
}

Response samples

Content type
application/json
{
  • "content": {
    },
  • "messages": [
    ]
}

Apply multimedia package to channel

Sets multimedia package to a channel. Multimedia package name is passed in body.

path Parameters
channelId
required
integer <int64>

Channel id

query Parameters
organization
string

Organization Id

Request Body schema: application/json
required
string

Multimedia caption package name

Responses

Request samples

Content type
application/json
"string"

Response samples

Content type
application/json
{
  • "content": {
    },
  • "messages": [
    ]
}

Search for pending changes timeline events

Returns list of timeline events according to specified search parameters for last minut changes

path Parameters
channelId
required
integer <int64>

Channel id

query Parameters
evaluateSecondaryEventParameters
boolean

Evaluate secondary event parameters

required
object (TimelineSearchDTO)
organization
string

Organization Id

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create channel timeline event

Creates specified channel timeline event. Changes are saved to DB, but not applied to playout services.

path Parameters
channelId
required
integer <int64>

Channel id

query Parameters
organization
string

Organization Id

Request Body schema: application/json
required
object (EventAssetDataDTO)
object (AudioTransitionDTO)
blockId
integer <int64>
blockMode
string
Enum: "ORDERED" "RANDOM"
category
string
color
string
Array of objects (ContentAdvisory)
deviation
integer <int64>
duration
integer <int64>
eventType
string
Enum: "PRIMARY" "ADVERTISEMENT" "LIVE" "PLACEHOLDER" "BLOCK" "EMERGENCY"
floating
string
Enum: "START" "END" "FIXED"
houseId
string
id
integer <int64>
ignoreIncomingScte35Signals
boolean
label
string
liveCustomActiveBefore
integer <int64>
liveCustomUrl
string
liveId
string
locked
boolean
manualEnd
boolean
manualStart
boolean
maxExtendedDuration
integer <int64>
mediaId
string
object (EventMetadataDTO)
onAirTime
string <date-time>
Array of objects (PidDTO)
placeholderId
string
Array of objects (PlayoutSwitchDTO)
object (PrimarySCTESourceSwitchDTO)
object (EventProgrammeDTO)
reconciliationId
string
recording
boolean
recordingPattern
string
Array of objects (SCTE35SignalDTO)
object (SCTE35TriggerDTO)
Array of objects (SecondaryEventDTO)
som
integer <int64>
status
string
Enum: "NOT_READY" "CACHING_IN_PROGRESS" "READY" "FAILED" "LIVE" "EMPTY" "INCOMPLETE" "ARCHIVED"
Array of objects (StreamOverrideDTO)
timecodeIn
integer <int64>
title
string
Array of objects (TwitchRPCDTO)
Array of objects (UntimedAdDTO)
Array of objects (VoiceoverDTO)

Responses

Request samples

Content type
application/json
{
  • "assetData": {
    },
  • "audioTransition": {
    },
  • "blockId": 0,
  • "blockMode": "ORDERED",
  • "category": "string",
  • "color": "string",
  • "contentAdvisory": [
    ],
  • "deviation": 0,
  • "duration": 0,
  • "eventType": "PRIMARY",
  • "floating": "START",
  • "houseId": "string",
  • "id": 0,
  • "ignoreIncomingScte35Signals": true,
  • "label": "string",
  • "liveCustomActiveBefore": 0,
  • "liveCustomUrl": "string",
  • "liveId": "string",
  • "locked": true,
  • "manualEnd": true,
  • "manualStart": true,
  • "maxExtendedDuration": 0,
  • "mediaId": "string",
  • "metadata": {
    },
  • "onAirTime": "2019-08-24T14:15:22Z",
  • "pidOverrides": [
    ],
  • "placeholderId": "string",
  • "playoutSwitches": [
    ],
  • "primarySCTESourceSwitch": {
    },
  • "programme": {
    },
  • "reconciliationId": "string",
  • "recording": true,
  • "recordingPattern": "string",
  • "scte35Signals": [
    ],
  • "scte35Trigger": {
    },
  • "secondaryEvents": [
    ],
  • "som": 0,
  • "status": "NOT_READY",
  • "streamOverrides": [
    ],
  • "timecodeIn": 0,
  • "title": "string",
  • "twitchRPCList": [
    ],
  • "untimedAds": [
    ],
  • "voiceovers": [
    ]
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "messages": [
    ]
}

Bulk update channel timeline events

Updates specified channel timeline events. Changes are saved to DB, but not applied to playout services.

path Parameters
channelId
required
integer <int64>

Channel id

query Parameters
organization
string

Organization Id

Request Body schema: application/json
required
Array
object (EventAssetDataDTO)
object (AudioTransitionDTO)
blockId
integer <int64>
blockMode
string
Enum: "ORDERED" "RANDOM"
category
string
color
string
Array of objects (ContentAdvisory)
deviation
integer <int64>
duration
integer <int64>
eventType
string
Enum: "PRIMARY" "ADVERTISEMENT" "LIVE" "PLACEHOLDER" "BLOCK" "EMERGENCY"
floating
string
Enum: "START" "END" "FIXED"
houseId
string
id
integer <int64>
ignoreIncomingScte35Signals
boolean
label
string
liveCustomActiveBefore
integer <int64>
liveCustomUrl
string
liveId
string
locked
boolean
manualEnd
boolean
manualStart
boolean
maxExtendedDuration
integer <int64>
mediaId
string
object (EventMetadataDTO)
onAirTime
string <date-time>
Array of objects (PidDTO)
placeholderId
string
Array of objects (PlayoutSwitchDTO)
object (PrimarySCTESourceSwitchDTO)
object (EventProgrammeDTO)
reconciliationId
string
recording
boolean
recordingPattern
string
Array of objects (SCTE35SignalDTO)
object (SCTE35TriggerDTO)
Array of objects (SecondaryEventDTO)
som
integer <int64>
status
string
Enum: "NOT_READY" "CACHING_IN_PROGRESS" "READY" "FAILED" "LIVE" "EMPTY" "INCOMPLETE" "ARCHIVED"
Array of objects (StreamOverrideDTO)
timecodeIn
integer <int64>
title
string
Array of objects (TwitchRPCDTO)
Array of objects (UntimedAdDTO)
Array of objects (VoiceoverDTO)

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "code": 0,
  • "messages": [
    ]
}

Search timeline assets by name in last minute changes

path Parameters
channelId
required
integer <int64>
query Parameters
assetName
required
string
from
string <date-time>
organization
string

Organization Id

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Clear timeline period

Removes all events from timeline which fall into specified period (fully or partly)

path Parameters
channelId
required
integer <int64>

Channel id

query Parameters
organization
string

Organization Id

Request Body schema: application/json
required
from
string <date-time>
to
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "from": "2019-08-24T14:15:22Z",
  • "to": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "messages": [
    ]
}

Delete channel pending changes events without channel lock

Deletes specified channel pending changes events.

path Parameters
channelId
required
integer <int64>

Channel id

query Parameters
shift
boolean

Shift following events after removal

version
required
integer <int32>

Channel version

organization
string

Organization Id

Request Body schema: application/json
required
Array
integer <int64>

Responses

Request samples

Content type
application/json
[
  • 0
]

Response samples

Content type
application/json
{
  • "modifiableFrom": "2019-08-24T14:15:22Z"
}

Fix further conflicts

Shifts events starting from supplied event Id until next locked event or last event in order to remove overlaps and gaps.

path Parameters
channelId
required
integer <int64>

Channel id

query Parameters
organization
string

Organization Id

Request Body schema: application/json
integer <int64>

Event Id

Responses

Request samples

Content type
application/json
0
0

Response samples

Content type
application/json
{
  • "code": 0,
  • "messages": [
    ]
}

Insert channel timeline event shifting all following events further

Insertion requires channel to be locked. Changes are saved to DB and not applied to playout services.

path Parameters
channelId
required
integer <int64>

Channel id

query Parameters
trimAllowed
boolean

true if trimming/removing events while shifting is allowed

version
required
integer <int32>

Channel version

organization
string

Organization Id

Request Body schema: application/json
required
required
Array of objects (EventDTO)
loopTo
string <date-time>
onAirTime
string <date-time>
placeholderOverrideEnabled
boolean

Responses

Request samples

Content type
application/json
{
  • "events": [
    ],
  • "loopTo": "2019-08-24T14:15:22Z",
  • "onAirTime": "2019-08-24T14:15:22Z",
  • "placeholderOverrideEnabled": true
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "messages": [
    ]
}

Insert channel timeline event events with different onAirTime

Insertion requires channel to be locked. Changes are saved to DB and not applied to playout services.

path Parameters
channelId
required
integer <int64>

Channel id

query Parameters
version
required
integer <int32>

Channel version

organization
string

Organization Id

Request Body schema: application/json
required
Array
object (EventAssetDataDTO)
object (AudioTransitionDTO)
blockId
integer <int64>
blockMode
string
Enum: "ORDERED" "RANDOM"
category
string
color
string
Array of objects (ContentAdvisory)
deviation
integer <int64>
duration
integer <int64>
eventType
string
Enum: "PRIMARY" "ADVERTISEMENT" "LIVE" "PLACEHOLDER" "BLOCK" "EMERGENCY"
floating
string
Enum: "START" "END" "FIXED"
houseId
string
id
integer <int64>
ignoreIncomingScte35Signals
boolean
label
string
liveCustomActiveBefore
integer <int64>
liveCustomUrl
string
liveId
string
locked
boolean
manualEnd
boolean
manualStart
boolean
maxExtendedDuration
integer <int64>
mediaId
string
object (EventMetadataDTO)
onAirTime
string <date-time>
Array of objects (PidDTO)
placeholderId
string
Array of objects (PlayoutSwitchDTO)
object (PrimarySCTESourceSwitchDTO)
object (EventProgrammeDTO)
reconciliationId
string
recording
boolean
recordingPattern
string
Array of objects (SCTE35SignalDTO)
object (SCTE35TriggerDTO)
Array of objects (SecondaryEventDTO)
som
integer <int64>
status
string
Enum: "NOT_READY" "CACHING_IN_PROGRESS" "READY" "FAILED" "LIVE" "EMPTY" "INCOMPLETE" "ARCHIVED"
Array of objects (StreamOverrideDTO)
timecodeIn
integer <int64>
title
string
Array of objects (TwitchRPCDTO)
Array of objects (UntimedAdDTO)
Array of objects (VoiceoverDTO)

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "code": 0,
  • "messages": [
    ]
}

makeEPG

path Parameters
channelId
required
integer <int64>

Channel id

query Parameters
version
required
integer <int32>

Channel version

organization
string
Request Body schema: application/json
required
eventType
string
Enum: "PRIMARY" "ADVERTISEMENT" "LIVE" "PLACEHOLDER" "BLOCK" "EMERGENCY"

Responses

Request samples

Content type
application/json
{
  • "eventType": "PRIMARY"
}

Response samples

Content type
application/json
{
  • "content": {
    },
  • "messages": [
    ]
}

markSCTE

path Parameters
channelId
required
integer <int64>

Channel id

query Parameters
version
required
integer <int32>

Channel version

organization
string
Request Body schema: application/json
required
eventType
string
Enum: "PRIMARY" "ADVERTISEMENT" "LIVE" "PLACEHOLDER" "BLOCK" "EMERGENCY"

Responses

Request samples

Content type
application/json
{
  • "eventType": "PRIMARY"
}

Response samples

Content type
application/json
{
  • "content": {
    },
  • "messages": [
    ]
}

Modify timeline events

Creates, updates, deletes multiple schedule events

path Parameters
channelId
required
integer <int64>

Channel id

query Parameters
version
required
integer <int32>

Channel version

trimAllowed
boolean

true if trimming/removing events while shifting is allowed

organization
string

Organization Id

Request Body schema: application/json
required
Array of objects (EventDTO)
deleted
Array of integers <int64> [ items <int64 > ]
Array of objects (EventDTO)

Responses

Request samples

Content type
application/json
{
  • "created": [
    ],
  • "deleted": [
    ],
  • "updated": [
    ]
}

Response samples

Content type
application/json
{
  • "content": {
    },
  • "messages": [
    ]
}

Replaces asset for all events that match asset id

Replaces asset for all events that match asset idChanges are saved to DB, but not applied to playout services.

path Parameters
channelId
required
integer <int64>

Channel id

assetId
required
string

AssetId

query Parameters
organization
string

Organization Id

Request Body schema: application/json
required
assetId
string
fillGaps
boolean
from
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "assetId": "string",
  • "fillGaps": true,
  • "from": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "eventsModified": 0,
  • "firstEventTime": "2019-08-24T14:15:22Z",
  • "lastEventTime": "2019-08-24T14:15:22Z",
  • "newMediaId": "string",
  • "originalMediaId": "string"
}

Revert pending timeline changes

Reverts all changes made since channel lock was set. Returns reverted timeline.

path Parameters
channelId
required
integer <int64>

Channel id

query Parameters
organization
string

Organization Id

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "messages": [
    ]
}

Sync event titles with asset

Syncs event titles with asset title or name.

path Parameters
channelId
required
integer <int64>

Channel id

query Parameters
organization
string

Organization Id

Request Body schema: application/json
Array
integer <int64>

Responses

Request samples

Content type
application/json
[
  • 0
]

Response samples

Content type
application/json
{
  • "code": 0,
  • "messages": [
    ]
}

update

path Parameters
channelId
required
integer <int64>

Channel id

query Parameters
version
required
integer <int32>

Channel version

organization
string
Request Body schema: application/json
required
eventType
string
Enum: "PRIMARY" "ADVERTISEMENT" "LIVE" "PLACEHOLDER" "BLOCK" "EMERGENCY"
object (EventProgrammeDTO)
replacementType
string
Enum: "PRIMARY" "ADVERTISEMENT" "LIVE" "PLACEHOLDER" "BLOCK" "EMERGENCY"
Array of objects (SCTE35SignalDTO)
Array of objects (SecondaryEventDTO)

Responses

Request samples

Content type
application/json
{
  • "eventType": "PRIMARY",
  • "programme": {
    },
  • "replacementType": "PRIMARY",
  • "scte35Signals": [
    ],
  • "secondaryEvents": [
    ]
}

Response samples

Content type
application/json
{
  • "content": {
    },
  • "messages": [
    ]
}

Delete channel timeline event

Deletes specified channel timeline event. Changes are saved to DB, but not applied to playout services.

path Parameters
channelId
required
integer <int64>

Channel id

eventId
required
integer <int64>

Timeline event id

query Parameters
organization
string

Organization Id

Responses

Response samples

Content type
application/json
{ }

Update channel timeline event

Updates specified channel timeline event. Changes are saved to DB, but not applied to playout services.

path Parameters
channelId
required
integer <int64>

Channel id

eventId
required
integer <int64>

Timeline event id

query Parameters
replaceAllAssets
boolean

Replace all asset events with new event

organization
string

Organization Id

Request Body schema: application/json
required
object (EventAssetDataDTO)
object (AudioTransitionDTO)
blockId
integer <int64>
blockMode
string
Enum: "ORDERED" "RANDOM"
category
string
color
string
Array of objects (ContentAdvisory)
deviation
integer <int64>
duration
integer <int64>
eventType
string
Enum: "PRIMARY" "ADVERTISEMENT" "LIVE" "PLACEHOLDER" "BLOCK" "EMERGENCY"
floating
string
Enum: "START" "END" "FIXED"
houseId
string
id
integer <int64>
ignoreIncomingScte35Signals
boolean
label
string
liveCustomActiveBefore
integer <int64>
liveCustomUrl
string
liveId
string
locked
boolean
manualEnd
boolean
manualStart
boolean
maxExtendedDuration
integer <int64>
mediaId
string
object (EventMetadataDTO)
onAirTime
string <date-time>
Array of objects (PidDTO)
placeholderId
string
Array of objects (PlayoutSwitchDTO)
object (PrimarySCTESourceSwitchDTO)
object (EventProgrammeDTO)
reconciliationId
string
recording
boolean
recordingPattern
string
Array of objects (SCTE35SignalDTO)
object (SCTE35TriggerDTO)
Array of objects (SecondaryEventDTO)
som
integer <int64>
status
string
Enum: "NOT_READY" "CACHING_IN_PROGRESS" "READY" "FAILED" "LIVE" "EMPTY" "INCOMPLETE" "ARCHIVED"
Array of objects (StreamOverrideDTO)
timecodeIn
integer <int64>
title
string
Array of objects (TwitchRPCDTO)
Array of objects (UntimedAdDTO)
Array of objects (VoiceoverDTO)

Responses

Request samples

Content type
application/json
{
  • "assetData": {
    },
  • "audioTransition": {
    },
  • "blockId": 0,
  • "blockMode": "ORDERED",
  • "category": "string",
  • "color": "string",
  • "contentAdvisory": [
    ],
  • "deviation": 0,
  • "duration": 0,
  • "eventType": "PRIMARY",
  • "floating": "START",
  • "houseId": "string",
  • "id": 0,
  • "ignoreIncomingScte35Signals": true,
  • "label": "string",
  • "liveCustomActiveBefore": 0,
  • "liveCustomUrl": "string",
  • "liveId": "string",
  • "locked": true,
  • "manualEnd": true,
  • "manualStart": true,
  • "maxExtendedDuration": 0,
  • "mediaId": "string",
  • "metadata": {
    },
  • "onAirTime": "2019-08-24T14:15:22Z",
  • "pidOverrides": [
    ],
  • "placeholderId": "string",
  • "playoutSwitches": [
    ],
  • "primarySCTESourceSwitch": {
    },
  • "programme": {
    },
  • "reconciliationId": "string",
  • "recording": true,
  • "recordingPattern": "string",
  • "scte35Signals": [
    ],
  • "scte35Trigger": {
    },
  • "secondaryEvents": [
    ],
  • "som": 0,
  • "status": "NOT_READY",
  • "streamOverrides": [
    ],
  • "timecodeIn": 0,
  • "title": "string",
  • "twitchRPCList": [
    ],
  • "untimedAds": [
    ],
  • "voiceovers": [
    ]
}

Response samples

Content type
application/json
{
  • "content": {
    },
  • "messages": [
    ]
}

Get channel permanent graphics

Get channel permanent graphics

path Parameters
channelId
required
integer <int64>

Channel id

query Parameters
version
required
integer <int32>

Channel version

organization
required
string

Organization Id

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Update channel permanent graphics

Updates channel permanent graphics by id

path Parameters
channelId
required
integer <int64>

Channel id

query Parameters
version
required
integer <int32>

Channel version

organization
required
string

Organization Id

Request Body schema: application/json
Array
Array of objects (Condition)
elementName
string

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "content": {
    },
  • "messages": [
    ]
}

Get channel placeholder playlist

Returns channel placeholder playlist.

path Parameters
channelId
required
integer <int64>

Channel id

query Parameters
organization
string

Organization Id

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Apply placeholder playlists to channel

Sets placeholder playlists to a channel. Playlists are read from playlist IDs passed in body.

path Parameters
channelId
required
integer <int64>

Channel id

query Parameters
organization
string

Organization Id

Request Body schema: application/json
required
Array
Array of objects (PlaceholderPlaylistItemDTO)
name
string
playlistId
integer <int64>

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "content": {
    },
  • "messages": [
    ]
}

Assign backup playout to channel

Assings backup playout to channel by id

path Parameters
channelId
required
integer <int64>
query Parameters
backupPlayoutId
required
string
backupType
required
string
Enum: "HOT" "WARM"
primaryPlayoutId
required
string
organization
required
string

Responses

Response samples

Content type
application/json
{ }

Reset channels playouts

Resets channels playouts. sends all current data to the playouts

path Parameters
channelId
required
integer <int64>
query Parameters
organization
required
string

Responses

Response samples

Content type
application/json
{
  • "content": {
    },
  • "messages": [
    ]
}

Reset channels playout

Resets channels playout. sends all current data to the playout

path Parameters
channelId
required
integer <int64>
playoutId
required
string
query Parameters
organization
required
string

Responses

Response samples

Content type
application/json
{
  • "content": {
    },
  • "messages": [
    ]
}

Reset channels playout timeline

Resets channels playouts timeline.Sends current timeline to playout

path Parameters
channelId
required
integer <int64>
playoutId
required
string
query Parameters
organization
required
string

Responses

Response samples

Content type
application/json
{
  • "content": {
    },
  • "messages": [
    ]
}

Prolong channel lock for last minute changes

Prolong channel lock for last minute changes.

path Parameters
channelId
required
integer <int64>

Channel id

query Parameters
organization
string

Organization Id

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "messages": [
    ]
}

Releases lock channel for last minute changes

Channel without a lock can be modified and deleted, but it's timeline is not modifiable. Before lock is released timeline is validated and sent to playout services for update.

path Parameters
channelId
required
integer <int64>

Channel id

query Parameters
organization
string

Organization Id

Responses

Response samples

Content type
application/json
{
  • "content": {
    },
  • "messages": [
    ]
}

Add instant secondary event to channel

Add instant secondary event to channel, appends to existing

path Parameters
channelId
required
integer <int64>

Channel id

query Parameters
organization
required
string

Organization Id

Request Body schema: application/json
required
objectName
string

The name of graphic object

object

Substitution parameters

state
string
Enum: "ON" "DEFAULT" "OFF" "ON" "DEFAULT" "OFF"

The state of the event

title
string

The title of the event

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "objectName": "string",
  • "parameters": {
    },
  • "state": "DEFAULT",
  • "title": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "objectName": "string",
  • "parameters": {
    },
  • "state": "DEFAULT",
  • "title": "string"
}

Delete instant secondary event from channel

Delete instant secondary event from channel

path Parameters
channelId
required
integer <int64>

Channel id

id
required
string
query Parameters
organization
required
string

Organization Id

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "messages": [
    ]
}

Get instant secondary from channel by id

Get instant secondary from channel by id and object name

path Parameters
channelId
required
integer <int64>

Channel id

id
required
string
query Parameters
organization
required
string

Organization Id

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "objectName": "string",
  • "parameters": {
    },
  • "state": "DEFAULT",
  • "title": "string"
}

Update instant secondary event on channel

Update instant secondary event on channel

path Parameters
channelId
required
integer <int64>

Channel id

id
required
string
query Parameters
organization
required
string

Organization Id

Request Body schema: application/json
required
objectName
string

The name of graphic object

object

Substitution parameters

state
string
Enum: "ON" "DEFAULT" "OFF" "ON" "DEFAULT" "OFF"

The state of the event

title
string

The title of the event

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "objectName": "string",
  • "parameters": {
    },
  • "state": "DEFAULT",
  • "title": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "objectName": "string",
  • "parameters": {
    },
  • "state": "DEFAULT",
  • "title": "string"
}

Returns channels secondary events

Returns channels secondary events

path Parameters
channelId
required
integer <int64>

Channel id

query Parameters
organization
required
string

Organization Id

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Replace all instant secondary event to channel

Replace all instant secondary event to channel

path Parameters
channelId
required
integer <int64>

Channel id

query Parameters
organization
required
string

Organization Id

Request Body schema: application/json
required
Array
objectName
string

The name of graphic object

object

Substitution parameters

state
string
Enum: "ON" "DEFAULT" "OFF" "ON" "DEFAULT" "OFF"

The state of the event

title
string

The title of the event

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

Search for timeline events

Returns list of timeline events according to specified search parameters

path Parameters
channelId
required
integer <int64>

Channel id

query Parameters
evaluateSecondaryEventParameters
boolean

Evaluate secondary event parameters

required
object (TimelineSearchDTO)
organization
string

Organization Id

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Search timeline assets by name

path Parameters
channelId
required
integer <int64>
query Parameters
assetName
required
string
from
string <date-time>
organization
string

Organization Id

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Delete channel timeline events without channel lock

Deletes specified channel timeline events. Changes are saved to DB and applied to playout services.

path Parameters
channelId
required
integer <int64>

Channel id

query Parameters
shift
boolean

Shift following events after removal

version
required
integer <int32>

Channel version

organization
string

Organization Id

Request Body schema: application/json
required
Array
integer <int64>

Responses

Request samples

Content type
application/json
[
  • 0
]

Response samples

Content type
application/json
{
  • "content": {
    },
  • "messages": [
    ]
}

Insert channel timeline event shifting all following events further

Inserts specified channel timeline event without channel lock. Changes are saved to DB and applied to playout services.

path Parameters
channelId
required
integer <int64>

Channel id

query Parameters
version
required
integer <int32>

Channel version

organization
string

Organization Id

Request Body schema: application/json
required
skipPlaceholders
boolean
tags
required
Array of strings unique
timeFrom
required
string <date-time>
timeTo
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "skipPlaceholders": true,
  • "tags": [
    ],
  • "timeFrom": "2019-08-24T14:15:22Z",
  • "timeTo": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "content": {
    },
  • "messages": [
    ]
}

Remove channel timeline gap by shifting all following events further

Removes channel timeline gap without channel lock. Changes are saved to DB and applied to playout services.

path Parameters
channelId
required
integer <int64>

Channel id

query Parameters
version
required
integer <int32>

Channel version

organization
string

Organization Id

Request Body schema: application/json
required
timeFrom
required
string <date-time>
timeTo
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "timeFrom": "2019-08-24T14:15:22Z",
  • "timeTo": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "content": {
    },
  • "messages": [
    ]
}

Bulk update channel timeline events

Modifies specified channel looped timeline events without channel lock. Changes are saved to DB and applied to playout services.

path Parameters
channelId
required
integer <int64>

Channel id

query Parameters
version
required
integer <int32>

Channel version

organization
string

Organization Id

Request Body schema: application/json
required
Array
object (EventAssetDataDTO)
object (AudioTransitionDTO)
blockId
integer <int64>
blockMode
string
Enum: "ORDERED" "RANDOM"
category
string
color
string
Array of objects (ContentAdvisory)
deviation
integer <int64>
duration
integer <int64>
eventType
string
Enum: "PRIMARY" "ADVERTISEMENT" "LIVE" "PLACEHOLDER" "BLOCK" "EMERGENCY"
floating
string
Enum: "START" "END" "FIXED"
houseId
string
id
integer <int64>
ignoreIncomingScte35Signals
boolean
label
string
liveCustomActiveBefore
integer <int64>
liveCustomUrl
string
liveId
string
locked
boolean
manualEnd
boolean
manualStart
boolean
maxExtendedDuration
integer <int64>
mediaId
string
object (EventMetadataDTO)
onAirTime
string <date-time>
Array of objects (PidDTO)
placeholderId
string
Array of objects (PlayoutSwitchDTO)
object (PrimarySCTESourceSwitchDTO)
object (EventProgrammeDTO)
reconciliationId
string
recording
boolean
recordingPattern
string
Array of objects (SCTE35SignalDTO)
object (SCTE35TriggerDTO)
Array of objects (SecondaryEventDTO)
som
integer <int64>
status
string
Enum: "NOT_READY" "CACHING_IN_PROGRESS" "READY" "FAILED" "LIVE" "EMPTY" "INCOMPLETE" "ARCHIVED"
Array of objects (StreamOverrideDTO)
timecodeIn
integer <int64>
title
string
Array of objects (TwitchRPCDTO)
Array of objects (UntimedAdDTO)
Array of objects (VoiceoverDTO)

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "content": {
    },
  • "messages": [
    ]
}

Insert channel timeline event shifting all following events further

Inserts specified channel timeline event without channel lock. Changes are saved to DB and applied to playout services.

path Parameters
channelId
required
integer <int64>

Channel id

query Parameters
version
required
integer <int32>

Channel version

organization
string

Organization Id

Request Body schema: application/json
required
required
Array of objects (EventDTO)
loopTo
string <date-time>
onAirTime
string <date-time>
placeholderOverrideEnabled
boolean

Responses

Request samples

Content type
application/json
{
  • "events": [
    ],
  • "loopTo": "2019-08-24T14:15:22Z",
  • "onAirTime": "2019-08-24T14:15:22Z",
  • "placeholderOverrideEnabled": true
}

Response samples

Content type
application/json
{
  • "content": {
    },
  • "messages": [
    ]
}

Insert playlist into timeline shifting existing events

Insert playlist into timeline shifting existing events without channel lock. Changes are saved to DB and applied to playout services.

path Parameters
channelId
required
integer <int64>

Channel id

query Parameters
version
required
integer <int32>

Channel version

organization
string

Organization Id

Request Body schema: application/json
required
onAirTime
string <date-time>
placeholderOverrideEnabled
boolean
scheduleId
required
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "onAirTime": "2019-08-24T14:15:22Z",
  • "placeholderOverrideEnabled": true,
  • "scheduleId": 0
}

Response samples

Content type
application/json
{
  • "content": {
    },
  • "messages": [
    ]
}

Evaluate secondary event parameters

Returns evaluated parameter value map, where placeholders like ${current.title} are replaced with real values

path Parameters
channelId
required
integer <int64>
query Parameters
onAirTimeFrom
required
integer <int64>
organization
string

Organization Id

Request Body schema: application/json
required
command
string
Enum: "ON" "OFF"
objectName
string
offset
integer <int64>
origin
string
Enum: "FROM_START" "FROM_END"
object
object

Responses

Request samples

Content type
application/json
{
  • "command": "ON",
  • "objectName": "string",
  • "offset": 0,
  • "origin": "FROM_START",
  • "parameters": {
    },
  • "substitution": {
    }
}

Response samples

Content type
application/json
{
  • "property1": {
    },
  • "property2": {
    }
}

Skip manually locked event for channel

path Parameters
channelId
required
integer <int64>
query Parameters
version
required
integer <int32>

Channel version

organization
string

Organization Id

Request Body schema: application/json
fireDelay
integer <int64>
fireTime
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "fireDelay": 0,
  • "fireTime": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "content": {
    },
  • "messages": [
    ]
}

Validate channel timeline

Returns channel timeline report

path Parameters
channelId
required
integer <int64>

Channel id

query Parameters
organization
string

Organization Id

Responses

Response samples

Content type
application/json
{
  • "archivedAssetEvents": [
    ],
  • "breakIssues": [
    ],
  • "breaks": [
    ],
  • "deviationEvents": [
    ],
  • "events": [
    ],
  • "gaps": [
    ],
  • "incompleteAssetEvents": [
    ],
  • "invalidGraphicsObjectEvents": [
    ],
  • "messages": [
    ],
  • "missingAssetEvents": [
    ],
  • "missingAssets": [
    ],
  • "missingVoiceoverEvents": [
    ],
  • "missingVoiceovers": [
    ],
  • "programmeDeviationEvents": [
    ],
  • "status": "ERROR",
  • "unsuccessfulQCAssetEvents": [
    ],
  • "voiceoverDeviationEvents": [
    ]
}

Delete channel timeline event without channel lock

Deletes specified channel looped timeline event. Changes are saved to DB and applied to playout services.

path Parameters
channelId
required
integer <int64>

Channel id

eventId
required
integer <int64>

Timeline event id

query Parameters
version
required
integer <int32>

Channel version

organization
string

Organization Id

Responses

Response samples

Content type
application/json
{
  • "content": {
    },
  • "messages": [
    ]
}

Shift channel immediate timeline event

Updates specified channel timeline event with new onAirTime and moves other events to partially simulate Drag&drop without channel lock. Changes are saved to DB and applied to playout services.

path Parameters
channelId
required
integer <int64>

Channel id

eventId
required
integer <int64>

Timeline event id

query Parameters
version
required
integer <int32>

Channel version

organization
string

Organization Id

Request Body schema: application/json
required
duration
integer <int64>
lock
boolean
onAirTime
required
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "duration": 0,
  • "lock": true,
  • "onAirTime": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "content": {
    },
  • "messages": [
    ]
}

Take given event

Moves specified event to play now. All following events are moved up the timeline until locked event is reached or timeline ends

path Parameters
channelId
required
integer <int64>

Channel id

eventId
required
integer <int64>

Timeline event id

query Parameters
playoutId
string

Playout id

version
required
integer <int32>

Channel version

organization
string

Organization Id

Request Body schema: application/json
fireDelay
integer <int64>
fireTime
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "fireDelay": 0,
  • "fireTime": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "content": {
    },
  • "messages": [
    ]
}

Reset channel timeline status

Resets channel timeline status

path Parameters
channelId
required
integer <int64>
query Parameters
organization
required
string

Responses

Response samples

Content type
application/json
{ }

Authorize twitch integration

Authorizes twitch integration by channel id. Timeline is not updated

path Parameters
channelId
required
integer <int64>

Channel id

query Parameters
organization
string

Organization Id

Responses

Response samples

Content type
application/json
{ }

Remove twitch integration

path Parameters
channelId
required
integer <int64>

Channel id

query Parameters
organization
string

Organization Id

Responses

Response samples

Content type
application/json
{
  • "content": {
    },
  • "messages": [
    ]
}

Apply graphics project to channel

Sets graphics project to a channel. Graphics project name is passed in body.

path Parameters
channelId
required
integer <int64>

Channel id

query Parameters
organization
string

Organization Id

Request Body schema: application/json
required
string

Graphics project name

Responses

Request samples

Content type
application/json
"string"

Response samples

Content type
application/json
{
  • "content": {
    },
  • "messages": [
    ]
}

Validates playlist against channel

Validates whether a playlist can be applied to channel. Returns related errors and warnings

path Parameters
channelId
required
integer <int64>

Channel id

scheduleId
required
integer <int64>

Schedule id

query Parameters
organization
string

Organization Id

Responses

Response samples

Content type
application/json
{
  • "archivedAssetEvents": [
    ],
  • "archivedAssets": [
    ],
  • "deviationEvents": [
    ],
  • "gaps": [
    ],
  • "incompleteAssetEvents": [
    ],
  • "incompleteAssets": [
    ],
  • "invalidGraphicsObjectEvents": [
    ],
  • "mergingEvents": [
    ],
  • "messages": [
    ],
  • "missingAssetEvents": [
    ],
  • "missingAssets": [
    ],
  • "missingVoiceoverEvents": [
    ],
  • "missingVoiceovers": [
    ],
  • "overlappingEvents": [
    ],
  • "overriddenTimelineEvents": [
    ],
  • "programmeDeviationEvents": [
    ],
  • "status": "ERROR",
  • "unsuccessfulQCAssetEvents": [
    ],
  • "unsuccessfulQCAssets": [
    ],
  • "voiceoverDeviationEvents": [
    ]
}

Validates playlist against multiple channel days

Validates whether a playlist can be applied to channel to multiple days. Returns related errors and warnings

path Parameters
channelId
required
integer <int64>

Channel id

scheduleId
required
integer <int64>

Schedule id

query Parameters
startTime
required
string <date-time>

Date and time when schedule must start

rangeInDays
required
integer <int32>

Number of rangeInDays to copy schedule

organization
string

Organization Id

Responses

Response samples

Content type
application/json
{
  • "archivedAssetEvents": [
    ],
  • "archivedAssets": [
    ],
  • "deviationEvents": [
    ],
  • "gaps": [
    ],
  • "incompleteAssetEvents": [
    ],
  • "incompleteAssets": [
    ],
  • "invalidGraphicsObjectEvents": [
    ],
  • "mergingEvents": [
    ],
  • "messages": [
    ],
  • "missingAssetEvents": [
    ],
  • "missingAssets": [
    ],
  • "missingVoiceoverEvents": [
    ],
  • "missingVoiceovers": [
    ],
  • "overlappingEvents": [
    ],
  • "overriddenTimelineEvents": [
    ],
  • "programmeDeviationEvents": [
    ],
  • "status": "ERROR",
  • "unsuccessfulQCAssetEvents": [
    ],
  • "unsuccessfulQCAssets": [
    ],
  • "voiceoverDeviationEvents": [
    ]
}

Validates scheduling timelinge against channel

Validates whether a scheduling timeline can be applied to channel. Returns related errors and warnings

path Parameters
channelId
required
integer <int64>
query Parameters
rangeStartTime
required
string <date-time>
rangeEndTime
required
string <date-time>
organization
required
string

Responses

Response samples

Content type
application/json
{
  • "archivedAssetEvents": [
    ],
  • "archivedAssets": [
    ],
  • "deviationEvents": [
    ],
  • "gaps": [
    ],
  • "incompleteAssetEvents": [
    ],
  • "incompleteAssets": [
    ],
  • "invalidGraphicsObjectEvents": [
    ],
  • "mergingEvents": [
    ],
  • "messages": [
    ],
  • "missingAssetEvents": [
    ],
  • "missingAssets": [
    ],
  • "missingVoiceoverEvents": [
    ],
  • "missingVoiceovers": [
    ],
  • "overlappingEvents": [
    ],
  • "overriddenTimelineEvents": [
    ],
  • "programmeDeviationEvents": [
    ],
  • "status": "ERROR",
  • "unsuccessfulQCAssetEvents": [
    ],
  • "unsuccessfulQCAssets": [
    ],
  • "voiceoverDeviationEvents": [
    ]
}

Get channel validation rules

Returns channel validation rules

path Parameters
channelId
required
integer <int64>

Channel id

query Parameters
organization
string

Organization Id

Responses

Response samples

Content type
application/json
{
  • "minAssetAudios": 0,
  • "minAssetSubtitles": 0,
  • "minAssetVideos": 0
}

Set channel validation rules

Updates channel validation rules

path Parameters
channelId
required
integer <int64>

Channel id

query Parameters
organization
string

Organization Id

Request Body schema: application/json
required
minAssetAudios
integer <int32>
minAssetSubtitles
integer <int32>
minAssetVideos
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "minAssetAudios": 0,
  • "minAssetSubtitles": 0,
  • "minAssetVideos": 0
}

Response samples

Content type
application/json
{
  • "content": {
    },
  • "messages": [
    ]
}