Schedule

Download OpenAPI specification:Download

Flyway

Flyway API

Get flyway migrations

Get flyway migrations

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Delete flyway migrations

Delete flyway migrations

path Parameters
rank
required
integer <int32>

Responses

Response samples

Content type
application/json
{ }

Job resource

Job resource API

getJobs

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

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"
}

Schedule

Schedule API

Get schedules

Returns schedules

query Parameters
required
object (ScheduleSearch)
organization
string

Organization Id

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create new schedule

Creates new schedule

query Parameters
organization
string

Organization Id

Request Body schema: application/json
required
archiveStatus
string
Enum: "NOT_ARCHIVED" "ARCHIVING" "UN_ARCHIVING" "ARCHIVED"
breakMax
integer <int64>
breakMin
integer <int64>
channel
string
channelId
integer <int64>
dateApplied
string <date-time>
dateCreated
string <date-time>
dateUpdated
string <date-time>
finishDate
string <date-time>
finiteType
boolean
fps
number <float>
graphicsProject
string
graphicsProjectV2
string
id
integer <int64>
loopType
boolean
name
string
organization
string
playlistType
string
startDate
string <date-time>
status
string
txdate
string
version
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "archiveStatus": "NOT_ARCHIVED",
  • "breakMax": 0,
  • "breakMin": 0,
  • "channel": "string",
  • "channelId": 0,
  • "dateApplied": "2019-08-24T14:15:22Z",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "finishDate": "2019-08-24T14:15:22Z",
  • "finiteType": true,
  • "fps": 0,
  • "graphicsProject": "string",
  • "graphicsProjectV2": "string",
  • "id": 0,
  • "loopType": true,
  • "name": "string",
  • "organization": "string",
  • "playlistType": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "status": "string",
  • "txdate": "string",
  • "version": 0
}

Response samples

Content type
application/json
{
  • "archiveStatus": "NOT_ARCHIVED",
  • "breakMax": 0,
  • "breakMin": 0,
  • "channel": "string",
  • "channelId": 0,
  • "dateApplied": "2019-08-24T14:15:22Z",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "finishDate": "2019-08-24T14:15:22Z",
  • "finiteType": true,
  • "fps": 0,
  • "graphicsProject": "string",
  • "graphicsProjectV2": "string",
  • "id": 0,
  • "loopType": true,
  • "name": "string",
  • "organization": "string",
  • "playlistType": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "status": "string",
  • "txdate": "string",
  • "version": 0
}

Bulk delete schedules

Deletes specified schedules

query Parameters
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
[
  • {
    }
]

Disable debug logging

Disable debug logging

Responses

Response samples

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

Enable debug logging

Enable debug logging

Responses

Response samples

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

refreshScheduleAssetData

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"
}

Import schedule from xml

Creates new schedule

query Parameters
fps
number <float>
scriptId
string
fileName
string
organization
string

Organization Id

Request Body schema: multipart/form-data
file
required
string <binary>

Responses

Response samples

Content type
application/json
{
  • "archiveStatus": "NOT_ARCHIVED",
  • "breakMax": 0,
  • "breakMin": 0,
  • "channel": "string",
  • "channelId": 0,
  • "dateApplied": "2019-08-24T14:15:22Z",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "finishDate": "2019-08-24T14:15:22Z",
  • "finiteType": true,
  • "fps": 0,
  • "graphicsProject": "string",
  • "graphicsProjectV2": "string",
  • "id": 0,
  • "loopType": true,
  • "name": "string",
  • "organization": "string",
  • "playlistType": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "status": "string",
  • "txdate": "string",
  • "version": 0
}

Get schedules

Returns schedules

query Parameters
selectedPlaylistId
integer <int64>
organization
string

Organization Id

size
integer

Number of items per page (defaults to 20)

page
integer

Page number (defaults to 0)

sort
string

Properties that should be sorted by in the format property,property(,ASC|DESC). Default sort direction is ascending. Use multiple sort parameters if you want to switch directions, e.g. ?sort=firstname&sort=lastname,asc

Request Body schema: application/json
dateUpdatedFrom
string <date-time>
dateUpdatedTo
string <date-time>
finishDateFrom
string <date-time>
finishDateTo
string <date-time>
fps
number <float>
name
string
nameSubString
string
startDateFrom
string <date-time>
startDateTo
string <date-time>
statuses
Array of strings

Responses

Request samples

Content type
application/json
{
  • "dateUpdatedFrom": "2019-08-24T14:15:22Z",
  • "dateUpdatedTo": "2019-08-24T14:15:22Z",
  • "finishDateFrom": "2019-08-24T14:15:22Z",
  • "finishDateTo": "2019-08-24T14:15:22Z",
  • "fps": 0,
  • "name": "string",
  • "nameSubString": "string",
  • "startDateFrom": "2019-08-24T14:15:22Z",
  • "startDateTo": "2019-08-24T14:15:22Z",
  • "statuses": [
    ]
}

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "empty": true,
  • "first": true,
  • "last": true,
  • "number": 0,
  • "numberOfElements": 0,
  • "pageable": {
    },
  • "size": 0,
  • "sort": {
    },
  • "totalElements": 0,
  • "totalPages": 0
}

Delete schedule

Removes schedule by id

path Parameters
scheduleId
required
integer <int64>

Schedule id

query Parameters
organization
string

Organization Id

Responses

Response samples

Content type
application/json
{
  • "archiveStatus": "NOT_ARCHIVED",
  • "breakMax": 0,
  • "breakMin": 0,
  • "channel": "string",
  • "channelId": 0,
  • "dateApplied": "2019-08-24T14:15:22Z",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "finishDate": "2019-08-24T14:15:22Z",
  • "finiteType": true,
  • "fps": 0,
  • "graphicsProject": "string",
  • "graphicsProjectV2": "string",
  • "id": 0,
  • "loopType": true,
  • "name": "string",
  • "organization": "string",
  • "playlistType": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "status": "string",
  • "txdate": "string",
  • "version": 0
}

Get schedule

Returns schedule found by id

path Parameters
scheduleId
required
integer <int64>

Schedule id

query Parameters
organization
string

Organization Id

Responses

Response samples

Content type
application/json
{
  • "archiveStatus": "NOT_ARCHIVED",
  • "breakMax": 0,
  • "breakMin": 0,
  • "channel": "string",
  • "channelId": 0,
  • "dateApplied": "2019-08-24T14:15:22Z",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "finishDate": "2019-08-24T14:15:22Z",
  • "finiteType": true,
  • "fps": 0,
  • "graphicsProject": "string",
  • "graphicsProjectV2": "string",
  • "id": 0,
  • "loopType": true,
  • "name": "string",
  • "organization": "string",
  • "playlistType": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "status": "string",
  • "txdate": "string",
  • "version": 0
}

Update schedule

Updates schedule by id

path Parameters
scheduleId
required
integer <int64>

Schedule id

query Parameters
organization
string

Organization Id

Request Body schema: application/json
required
archiveStatus
string
Enum: "NOT_ARCHIVED" "ARCHIVING" "UN_ARCHIVING" "ARCHIVED"
breakMax
integer <int64>
breakMin
integer <int64>
channel
string
channelId
integer <int64>
dateApplied
string <date-time>
dateCreated
string <date-time>
dateUpdated
string <date-time>
finishDate
string <date-time>
finiteType
boolean
fps
number <float>
graphicsProject
string
graphicsProjectV2
string
id
integer <int64>
loopType
boolean
name
string
organization
string
playlistType
string
startDate
string <date-time>
status
string
txdate
string
version
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "archiveStatus": "NOT_ARCHIVED",
  • "breakMax": 0,
  • "breakMin": 0,
  • "channel": "string",
  • "channelId": 0,
  • "dateApplied": "2019-08-24T14:15:22Z",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "finishDate": "2019-08-24T14:15:22Z",
  • "finiteType": true,
  • "fps": 0,
  • "graphicsProject": "string",
  • "graphicsProjectV2": "string",
  • "id": 0,
  • "loopType": true,
  • "name": "string",
  • "organization": "string",
  • "playlistType": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "status": "string",
  • "txdate": "string",
  • "version": 0
}

Response samples

Content type
application/json
{
  • "archiveStatus": "NOT_ARCHIVED",
  • "breakMax": 0,
  • "breakMin": 0,
  • "channel": "string",
  • "channelId": 0,
  • "dateApplied": "2019-08-24T14:15:22Z",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "finishDate": "2019-08-24T14:15:22Z",
  • "finiteType": true,
  • "fps": 0,
  • "graphicsProject": "string",
  • "graphicsProjectV2": "string",
  • "id": 0,
  • "loopType": true,
  • "name": "string",
  • "organization": "string",
  • "playlistType": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "status": "string",
  • "txdate": "string",
  • "version": 0
}

Archive schedule event list

Sends schedule events to archive

path Parameters
scheduleId
required
integer <int64>
query Parameters
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"
}

Search retrieve playlist assets by name

path Parameters
scheduleId
required
integer <int64>
query Parameters
assetName
required
string
organization
string

Organization Id

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Make EPG events

Performs EPG event make based on critteria

path Parameters
scheduleId
required
integer <int64>
query Parameters
organization
string
required
object (ScheduleEventSearchDTO)
Request Body schema: application/json
required
eventType
string
Enum: "PRIMARY" "ADVERTISEMENT" "LIVE" "PLACEHOLDER" "BLOCK"
pageNumber
integer <int32>
pageSize
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "eventType": "PRIMARY",
  • "pageNumber": 0,
  • "pageSize": 0
}

Response samples

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

Mark SCTE events

Performs SCTE event mark based on critteria

path Parameters
scheduleId
required
integer <int64>
query Parameters
organization
string
required
object (ScheduleEventSearchDTO)
Request Body schema: application/json
required
eventType
string
Enum: "PRIMARY" "ADVERTISEMENT" "LIVE" "PLACEHOLDER" "BLOCK"
pageNumber
integer <int32>
pageSize
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "eventType": "PRIMARY",
  • "pageNumber": 0,
  • "pageSize": 0
}

Response samples

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

Sync event titles with asset title.

Syncs event title with asset system fields title.

path Parameters
scheduleId
required
integer <int64>

Schedule id

query Parameters
required
object (ScheduleEventSearchDTO)
required
object (Pageable)
organization
required
string
Request Body schema: application/json
required
Array
integer <int64>

Responses

Request samples

Content type
application/json
[
  • 0
]

Response samples

Content type
application/json
{
  • "finishDate": "2019-08-24T14:15:22Z",
  • "id": 0,
  • "page": {
    },
  • "startDate": "2019-08-24T14:15:22Z"
}

tryFixFurtherConflicts

path Parameters
scheduleId
required
integer <int64>
query Parameters
organization
required
string
eventId
integer <int64>
fixAll
boolean
required
object (Pageable)
required
object (ScheduleEventSearchDTO)

Responses

Response samples

Content type
application/json
{
  • "finishDate": "2019-08-24T14:15:22Z",
  • "id": 0,
  • "page": {
    },
  • "startDate": "2019-08-24T14:15:22Z"
}

Update event changes

Performs event change update based on critteria

path Parameters
scheduleId
required
integer <int64>
query Parameters
organization
string
required
object (ScheduleEventSearchDTO)
Request Body schema: application/json
required
eventType
string
Enum: "PRIMARY" "ADVERTISEMENT" "LIVE" "PLACEHOLDER" "BLOCK"
ids
Array of integers <int64> unique [ items <int64 > ]
pageNumber
integer <int32>
pageSize
integer <int32>
object (EventProgrammeDTO)
replacementType
string
Enum: "PRIMARY" "ADVERTISEMENT" "LIVE" "PLACEHOLDER" "BLOCK"
Array of objects (SCTE35SignalDTO)
Array of objects (SecondaryEventDTO)

Responses

Request samples

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

Response samples

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

Update schedule changes

Update schedule changes

path Parameters
scheduleId
required
integer <int64>
changesId
required
integer <int64>
query Parameters
organization
required
string
required
object (ScheduleEventSearchDTO)
Request Body schema: application/json
required
createFirst
boolean
Array of objects (EventDTO)
deleteOnly
boolean
deleted
Array of integers <int64> [ items <int64 > ]
empty
boolean
object (EventLoop)
pageNumber
integer <int32>
pageSize
integer <int32>
object (AssetReplacement)
Array of objects (EventDTO)
shiftBy
integer <int64>
shiftFrom
string <date-time>
object (EventSplit)
updateOnly
boolean
Array of objects (EventDTO)

Responses

Request samples

Content type
application/json
{
  • "createFirst": true,
  • "created": [
    ],
  • "deleteOnly": true,
  • "deleted": [
    ],
  • "empty": true,
  • "eventLoop": {
    },
  • "pageNumber": 0,
  • "pageSize": 0,
  • "replacement": {
    },
  • "sentToEnd": [
    ],
  • "shiftBy": 0,
  • "shiftFrom": "2019-08-24T14:15:22Z",
  • "split": {
    },
  • "updateOnly": true,
  • "updated": [
    ]
}

Response samples

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

Apply schedule changes

Apply schedule changes

path Parameters
scheduleId
required
integer <int64>
changesId
required
integer <int64>
query Parameters
organization
required
string
Request Body schema: application/json
required
createFirst
boolean
Array of objects (EventDTO)
deleteOnly
boolean
deleted
Array of integers <int64> [ items <int64 > ]
empty
boolean
object (EventLoop)
pageNumber
integer <int32>
pageSize
integer <int32>
object (AssetReplacement)
Array of objects (EventDTO)
shiftBy
integer <int64>
shiftFrom
string <date-time>
object (EventSplit)
updateOnly
boolean
Array of objects (EventDTO)

Responses

Request samples

Content type
application/json
{
  • "createFirst": true,
  • "created": [
    ],
  • "deleteOnly": true,
  • "deleted": [
    ],
  • "empty": true,
  • "eventLoop": {
    },
  • "pageNumber": 0,
  • "pageSize": 0,
  • "replacement": {
    },
  • "sentToEnd": [
    ],
  • "shiftBy": 0,
  • "shiftFrom": "2019-08-24T14:15:22Z",
  • "split": {
    },
  • "updateOnly": true,
  • "updated": [
    ]
}

Response samples

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

Discard schedule changes

Discard schedule changes

path Parameters
scheduleId
required
integer <int64>
changesId
required
integer <int64>
query Parameters
organization
required
string

Responses

Response samples

Content type
application/json
{
  • "archiveStatus": "NOT_ARCHIVED",
  • "breakMax": 0,
  • "breakMin": 0,
  • "channel": "string",
  • "channelId": 0,
  • "dateApplied": "2019-08-24T14:15:22Z",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "finishDate": "2019-08-24T14:15:22Z",
  • "finiteType": true,
  • "fps": 0,
  • "graphicsProject": "string",
  • "graphicsProjectV2": "string",
  • "id": 0,
  • "loopType": true,
  • "name": "string",
  • "organization": "string",
  • "playlistType": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "status": "string",
  • "txdate": "string",
  • "version": 0
}

Get schedule changes event page numbers

Returns event page numbers of schedule changes found by id

path Parameters
scheduleId
required
integer <int64>
changesId
required
integer <int64>
query Parameters
time
required
integer <int64>
pageSize
required
integer <int64>
required
object (ScheduleEventSearchDTO)
organization
required
string

Responses

Response samples

Content type
application/json
0
0

Get schedule changes event programme summary

Get schedule changes event programme summary

path Parameters
scheduleId
required
integer <int64>
changesId
required
integer <int64>
query Parameters
organization
required
string

Responses

Response samples

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

Get schedule changes events page

Get schedule changes events page

path Parameters
scheduleId
required
integer <int64>
changesId
required
integer <int64>
query Parameters
required
object (ScheduleEventSearchDTO)
required
object (Pageable)
organization
required
string

Responses

Response samples

Content type
application/json
{
  • "content": [