Channel

Download OpenAPI specification:Download

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"
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,
  • "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,
  • "gpiDelay": 0,
  • "gpiHardwareId": "string",
  • "graphicsProject": "string",
  • "graphicsProjectV2": "string",
  • "id": 0,
  • "ingestLookaheadEnabled": true,
  • "key": "4adfe27e-63d3-45b9-8238-62b6ed6fdb5e",
  • "liveSettings": {
    },
  • "lockOwnerUserName": "string",
  • "lockType": "APPLY_SCHEDULE",
  • "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
application/json
{
  • "code": 0,
  • "messages": [
    ]
}

devLogOn

Responses

Response samples

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

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
application/json
{
  • "code": 0,
  • "messages": [
    ]
}

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,
  • "id": 0,
  • "name": "string",
  • "version": 0
}

Response samples

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