logo
API docs by Redocly

Schedule

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

getCollectionResource-job-get_1_1

get-job

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
{
  • "_embedded": {
    },
  • "_links": {
    }
}

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

Update job

Update job status

path Parameters
jobId
required
integer <int64>

Job id

query Parameters
organization
Array of strings
Request Body schema: application/json
required
dateCreated
string <date-time>
dateFinished
string <date-time>
entityId
string
fileName
string
id
string
jobType
string
Array of objects (ModifyResultMessage)
organization
string
resourceExtension
string
resourceLink
string
serviceProviderId
string
status
string
Enum: "PENDING" "PROCESSING" "SUCCEEDED" "FAILED" "CANCELED"
uniqueId
string
userId
string

Responses

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

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
page
integer >= 0
Default: 0

Zero-based page index (0..N)

size
integer >= 1
Default: 20

The size of the page to be returned

sort
Array of strings

Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

required
object (ScheduleSearch)
organization
string

Organization Id

Responses

Response samples

Content type
{
  • "_embedded": {
    },
  • "_links": {
    },
  • "page": {
    }
}

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>
fps
number
fpsFloat
number <float>
graphicsProject
string
graphicsProjectV2
string
id
integer <int64>
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",
  • "fps": 0,
  • "fpsFloat": 0.1,
  • "graphicsProject": "string",
  • "graphicsProjectV2": "string",
  • "id": 0,
  • "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",
  • "fps": 0,
  • "graphicsProject": "string",
  • "graphicsProjectV2": "string",
  • "id": 0,
  • "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
[
  • {
    }
]

List of deleted playlists

List of deleted playlists

query Parameters
organization
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Disable debug logging

Disable debug logging

Responses

Response samples

Content type
"string"

Enable debug logging

Enable debug logging

Responses

Response samples

Content type
"string"

Download source schedule file

Returns source schedule file

query Parameters
fileId
required
string
organization
string

Organization Id

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
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",
  • "deleted": true,
  • "finishDate": "2019-08-24T14:15:22Z",
  • "finiteType": true,
  • "fps": 0,
  • "graphicsProject": "string",
  • "graphicsProjectV2": "string",
  • "id": 0,
  • "loopType": true,
  • "name": "string",
  • "organization": "string",
  • "playlistType": "FINITE",
  • "startDate": "2019-08-24T14:15:22Z",
  • "txdate": "string",
  • "version": 0
}

Import schedule from xml

Creates new schedule, returns processing job

query Parameters
fps
number
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
{
  • "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"
}

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
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",
  • "fps": 0,
  • "graphicsProject": "string",
  • "graphicsProjectV2": "string",
  • "id": 0,
  • "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",
  • "fps": 0,
  • "graphicsProject": "string",
  • "graphicsProjectV2": "string",
  • "id": 0,
  • "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>
fps
number
fpsFloat
number <float>
graphicsProject
string
graphicsProjectV2
string
id
integer <int64>
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",
  • "fps": 0,
  • "fpsFloat": 0.1,
  • "graphicsProject": "string",
  • "graphicsProjectV2": "string",
  • "id": 0,
  • "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",
  • "fps": 0,
  • "graphicsProject": "string",
  • "graphicsProjectV2": "string",
  • "id": 0,
  • "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" "EMERGENCY"
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" "EMERGENCY"
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" "EMERGENCY"
ids
Array of integers <int64> unique [ items <int64 > ]
pageNumber
integer <int32>
pageSize
integer <int32>
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",
  • "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",
  • "fps": 0,
  • "graphicsProject": "string",
  • "graphicsProjectV2": "string",
  • "id": 0,
  • "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": [
    ],
  • "empty": true,
  • "first": true,
  • "gaps": {
    },
  • "last": true,
  • "number": 0,
  • "numberOfElements": 0,
  • "overlaps": {
    },
  • "pageable": {
    },
  • "programmes": {
    },
  • "size": 0,
  • "sort": [
    ],
  • "totalElements": 0,
  • "totalPages": 0
}

Evaluate secondary event parameters

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

path Parameters
scheduleId
required
integer <int64>
changesId
required
integer <int64>
query Parameters
onAirTimeFrom
required
integer <int64>
organization
required
string
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": {
    }
}

Get schedule changes event summary

Get schedule changes event summary

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

Responses

Response samples

Content type
application/json
{
  • "currentEventPage": 0,
  • "eventsByType": {
    },
  • "gaps": {
    },
  • "missingAssetsEvents": {
    },
  • "overlaps": {
    },
  • "totalProgrammes": 0,
  • "unsuccessfulQCAssetsEvents": {
    }
}

Make EPG events

Performs EPG event make based on critteria

path Parameters
scheduleId
required
integer <int64>
changesId
required
integer <int64>
query Parameters
organization
string
required
object (ScheduleEventSearchDTO)
Request Body schema: application/json
required
eventType
string
Enum: "PRIMARY" "ADVERTISEMENT" "LIVE" "PLACEHOLDER" "BLOCK" "EMERGENCY"
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>
changesId
required
integer <int64>
query Parameters
organization
string
required
object (ScheduleEventSearchDTO)
Request Body schema: application/json
required
eventType
string
Enum: "PRIMARY" "ADVERTISEMENT" "LIVE" "PLACEHOLDER" "BLOCK" "EMERGENCY"
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": [
    ]
}

Update event changes

Performs event change update based on critteria

path Parameters
scheduleId
required
integer <int64>
changesId
required
integer <int64>
query Parameters
organization
string
required
object (ScheduleEventSearchDTO)
Request Body schema: application/json
required
eventType
string
Enum: "PRIMARY" "ADVERTISEMENT" "LIVE" "PLACEHOLDER" "BLOCK" "EMERGENCY"
ids
Array of integers <int64> unique [ items <int64 > ]
pageNumber
integer <int32>
pageSize
integer <int32>
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",
  • "ids": [
    ],
  • "pageNumber": 0,
  • "pageSize": 0,
  • "programme": {
    },
  • "replacementType": "PRIMARY",
  • "scte35Signals": [
    ],
  • "secondaryEvents": [
    ]
}

Response samples

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

Copy schedule

Copies schedule

path Parameters
scheduleId
required
integer <int64>

Schedule id

query Parameters
organization
string

Organization Id

Request Body schema: application/json
required
string

Responses

Request samples

Content type
application/json
"string"

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",
  • "fps": 0,
  • "graphicsProject": "string",
  • "graphicsProjectV2": "string",
  • "id": 0,
  • "name": "string",
  • "organization": "string",
  • "playlistType": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "status": "string",
  • "txdate": "string",
  • "version": 0
}

Download exported schedule file

Returns XML file containing exported schedule

path Parameters
scheduleId
required
integer <int64>

Schedule id

fileName
required
string

File name

query Parameters
organization
string

Organization Id

Responses

Response samples

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

Get schedule event list

Returns event list of 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
[
  • {
    }
]

Create schedule event

Creates new event

path Parameters
scheduleId
required
integer <int64>

Schedule 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"
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
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)
version
integer <int32>
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",
  • "houseId": "string",
  • "id": 0,
  • "ignoreIncomingScte35Signals": true,
  • "label": "string",
  • "liveCustomActiveBefore": 0,
  • "liveCustomUrl": "string",
  • "liveId": "string",
  • "locked": true,
  • "manualEnd": true,
  • "manualStart": true,
  • "maxExtendedDuration": 0,
  • "mediaId": "string",
  • "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": [
    ],
  • "version": 0,
  • "voiceovers": [
    ]
}

Response samples

Content type
application/json
{
  • "assetData": {
    },
  • "audioTransition": {
    },
  • "blockId": 0,
  • "blockMode": "ORDERED",
  • "category": "string",
  • "color": "string",
  • "contentAdvisory": [
    ],
  • "deviation": 0,
  • "duration": 0,
  • "eventType": "PRIMARY",
  • "houseId": "string",
  • "id": 0,
  • "ignoreIncomingScte35Signals": true,
  • "label": "string",
  • "liveCustomActiveBefore": 0,
  • "liveCustomUrl": "string",
  • "liveId": "string",
  • "locked": true,
  • "manualEnd": true,
  • "manualStart": true,
  • "maxExtendedDuration": 0,
  • "mediaId": "string",
  • "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": [
    ],
  • "version": 0,
  • "voiceovers": [
    ]
}

Bulk update schedule events

Updates events

path Parameters
scheduleId
required
integer <int64>

Schedule id

query Parameters
version
required
integer <int32>

Schedule 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"
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
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)
version
integer <int32>
Array of objects (VoiceoverDTO)

Responses

Request samples

Content type
application/json
[
  • {
    }
]

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",
  • "fps": 0,
  • "graphicsProject": "string",
  • "graphicsProjectV2": "string",
  • "id": 0,
  • "name": "string",
  • "organization": "string",
  • "playlistType": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "status": "string",
  • "txdate": "string",
  • "version": 0
}

Bulk delete schedule events

Deletes specified schedule events

path Parameters
scheduleId
required
integer <int64>

Schedule id

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
{
  • "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",
  • "fps": 0,
  • "graphicsProject": "string",
  • "graphicsProjectV2": "string",
  • "id": 0,
  • "name": "string",
  • "organization": "string",
  • "playlistType": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "status": "string",
  • "txdate": "string",
  • "version": 0
}

Get schedule event page numbers

Returns event page numbers of schedule found by id

path Parameters
scheduleId
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

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
scheduleId
required
integer <int64>

Schedule id

query Parameters
version
required
integer <int32>

Schedule version

fixAll
boolean
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
{
  • "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",
  • "fps": 0,
  • "graphicsProject": "string",
  • "graphicsProjectV2": "string",
  • "id": 0,
  • "name": "string",
  • "organization": "string",
  • "playlistType": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "status": "string",
  • "txdate": "string",
  • "version": 0
}

Modify schedule events

Creates, updates, deletes multiple schedule events

path Parameters
scheduleId
required
integer <int64>

Schedule id

query Parameters
version
required
integer <int32>

Schedule version

organization
string

Organization Id

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": [
    ]
}

Schedule EPG summary

Returns schedule EPG summary

path Parameters
scheduleId
required
integer <int64>

Schedule id

query Parameters
organization
string

Organization Id

Responses

Response samples

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

Replaces asset for all events that match asset id

Replaces asset for all events that match asset id

path Parameters
scheduleId
required
integer <int64>

Playlist id

assetId
required
string

AssetId

query Parameters
version
required
integer <int32>

Schedule version

organization
string

Organization Id

Request Body schema: application/json
required
assetId
string
fillGaps
boolean

Responses

Request samples

Content type
application/json
{
  • "assetId": "string",
  • "fillGaps": true
}

Response samples

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

Get schedule event page

Returns event page of schedule found by id

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

Organization Id

term
string

Search term - search by event title

size
long

Number of items per page (defaults to 20)

page
integer

Page number (defaults to 0)

Responses

Response samples

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

Evaluate secondary event parameters

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

path Parameters
scheduleId
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": {
    }
}

Shift schedule Deprecated

Shift schedule by specified number of milliseconds

path Parameters
scheduleId
required
integer <int64>

Schedule id

query Parameters
organization
string

Organization Id

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

Number of milliseconds to shift

Responses

Request samples

Content type
application/json
0
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",
  • "fps": 0,
  • "graphicsProject": "string",
  • "graphicsProjectV2": "string",
  • "id": 0,
  • "name": "string",
  • "organization": "string",
  • "playlistType": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "status": "string",
  • "txdate": "string",
  • "version": 0
}

Schedule event summary

Returns schedule events summary containing event/gap/overlap totals and pages

path Parameters
scheduleId
required
integer <int64>

Schedule id

query Parameters
organization
string

Organization Id

size
long

Number of items per page (defaults to 20)

Responses

Response samples

Content type
application/json
{
  • "currentEventPage": 0,
  • "eventsByType": {
    },
  • "gaps": {
    },
  • "missingAssetsEvents": {
    },
  • "overlaps": {
    },
  • "totalProgrammes": 0,
  • "unsuccessfulQCAssetsEvents": {
    }
}

Sync event titles with asset title.

Syncs event title with asset system fields title.

path Parameters
scheduleId
required
integer <int64>

Schedule id

query Parameters
organization
required
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
{
  • "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",
  • "fps": 0,
  • "graphicsProject": "string",
  • "graphicsProjectV2": "string",
  • "id": 0,
  • "name": "string",
  • "organization": "string",
  • "playlistType": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "status": "string",
  • "txdate": "string",
  • "version": 0
}

Transpose schedule

Transposes schedule to a new starting time

path Parameters
scheduleId
required
integer <int64>

Schedule id

query Parameters
organization
string

Organization Id

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

Start time

Responses

Request samples

Content type
application/json
"2019-08-24T14:15:22Z"

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",
  • "fps": 0,
  • "graphicsProject": "string",
  • "graphicsProjectV2": "string",
  • "id": 0,
  • "name": "string",
  • "organization": "string",
  • "playlistType": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "status": "string",
  • "txdate": "string",
  • "version": 0
}

Validate schedule

Returns validation result

path Parameters
scheduleId
required
integer <int64>

Schedule id

query Parameters
channelId
integer <int64>

Channel Id

fullList
boolean
Default: true

fullList

organization
string

Organization Id

Responses

Response samples

Content type
application/json
{
  • "archivedAssetEvents": [
    ],
  • "archivedAssets": [
    ],
  • "breakIssues": [
    ],
  • "breaks": [
    ],
  • "deviationEvents": [
    ],
  • "events": [
    ],
  • "fps": 0,
  • "gaps": [
    ],
  • "lightEvents": [
    ],
  • "mergingEvents": [
    ],
  • "messages": [
    ],
  • "missingAssetEvents": [
    ],
  • "missingAssets": [
    ],
  • "missingVoiceoverEvents": [
    ],
  • "missingVoiceovers": [
    ],
  • "name": "string",
  • "overlappingEvents": [
    ],
  • "programmeDeviationEvents": [
    ],
  • "scheduleFinishTime": "2019-08-24T14:15:22Z",
  • "scheduleStartTime": "2019-08-24T14:15:22Z",
  • "status": "ERROR",
  • "unsuccessfulQCAssetEvents": [
    ],
  • "unsuccessfulQCAssets": [
    ],
  • "voiceoverDeviationEvents": [
    ]
}

Delete schedule event

Removes schedule event by id

path Parameters
scheduleId
required
integer <int64>

Schedule id

eventId
required
integer <int64>

Event id

query Parameters
organization
string

Organization Id

Responses

Response samples

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

Get schedule event

Returns event of schedule found by id

path Parameters
scheduleId
required
integer <int64>

Schedule id

eventId
required
integer <int64>

Event id

query Parameters
organization
string

Organization Id

Responses

Response samples

Content type
application/json
{
  • "assetData": {
    },
  • "audioTransition": {
    },
  • "blockId": 0,
  • "blockMode": "ORDERED",
  • "category": "string",
  • "color": "string",
  • "contentAdvisory": [
    ],
  • "deviation": 0,
  • "duration": 0,
  • "eventType": "PRIMARY",
  • "houseId": "string",
  • "id": 0,
  • "ignoreIncomingScte35Signals": true,
  • "label": "string",
  • "liveCustomActiveBefore": 0,
  • "liveCustomUrl": "string",
  • "liveId": "string",
  • "locked": true,
  • "manualEnd": true,
  • "manualStart": true,
  • "maxExtendedDuration": 0,
  • "mediaId": "string",
  • "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": [
    ],
  • "version": 0,
  • "voiceovers": [
    ]
}

Update schedule event

Updates event

path Parameters
scheduleId
required
integer <int64>

Schedule id

eventId
required
integer <int64>

Event 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"
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
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)
version
integer <int32>
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",
  • "houseId": "string",
  • "id": 0,
  • "ignoreIncomingScte35Signals": true,
  • "label": "string",
  • "liveCustomActiveBefore": 0,
  • "liveCustomUrl": "string",
  • "liveId": "string",
  • "locked": true,
  • "manualEnd": true,
  • "manualStart": true,
  • "maxExtendedDuration": 0,
  • "mediaId": "string",
  • "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": [
    ],
  • "version": 0,
  • "voiceovers": [
    ]
}

Response samples

Content type
application/json
{
  • "assetData": {
    },
  • "audioTransition": {
    },
  • "blockId": 0,
  • "blockMode": "ORDERED",
  • "category": "string",
  • "color": "string",
  • "contentAdvisory": [
    ],
  • "deviation": 0,
  • "duration": 0,
  • "eventType": "PRIMARY",
  • "houseId": "string",
  • "id": 0,
  • "ignoreIncomingScte35Signals": true,
  • "label": "string",
  • "liveCustomActiveBefore": 0,
  • "liveCustomUrl": "string",
  • "liveId": "string",
  • "locked": true,
  • "manualEnd": true,
  • "manualStart": true,
  • "maxExtendedDuration": 0,
  • "mediaId": "string",
  • "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": [
    ],
  • "version": 0,
  • "voiceovers": [
    ]
}

Export schedule as XML

Exports schedule into XML format

path Parameters
scheduleId
required
integer <int64>
query Parameters
timeInMilliseconds
boolean

Use milliseconds instead of frames in time values

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

Restore deleted playlist

Restore deleted playlist

path Parameters
scheduleId
required
integer <int64>

Schedule id

query Parameters
organization
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",
  • "fps": 0,
  • "graphicsProject": "string",
  • "graphicsProjectV2": "string",
  • "id": 0,
  • "name": "string",
  • "organization": "string",
  • "playlistType": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "status": "string",
  • "txdate": "string",
  • "version": 0
}

Unarchive schedule event list

Extracts schedule event list from 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"
}

Blocks

Block management

Get blocks

Returns blocks

query Parameters
page
integer >= 0
Default: 0

Zero-based page index (0..N)

size
integer >= 1
Default: 20

The size of the page to be returned

sort
Array of strings

Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

include
Array of strings

Enter 'events' as included field to retrieve events info in the result

required
object (BlockSearchDTO)
organization
string

Organization Id

Responses

Response samples

Content type
{
  • "_embedded": {
    },
  • "_links": {
    },
  • "page": {
    }
}

Create new block

Creates new block

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
{
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "events": [
    ],
  • "fps": 0.1,
  • "id": 0,
  • "name": "string",
  • "version": 0
}

Bulk delete block

Deletes specified block

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

refreshAssetData

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

Get blocks

Returns blocks

query Parameters
include
Array of strings

Enter 'events' as included field to retrieve events info in the result

organization
string

Organization Id

Request Body schema: application/json
required
empty
boolean
ids
Array of integers <int64> [ items <int64 > ]
name
string
nameSubString
string

Responses

Request samples

Content type
application/json
{
  • "empty": true,
  • "ids": [
    ],
  • "name": "string",
  • "nameSubString": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Import block from xml

Creates new block

query Parameters
fps
number <float>
organization
required
string
scriptId
string
fileName
string
Request Body schema: application/json
file
required
string <binary>

Responses

Request samples

Content type
application/json
{
  • "file": "string"
}

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

Search blocks

Returns blocks

query Parameters
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
empty
boolean
ids
Array of integers <int64> [ items <int64 > ]
name
string
nameSubString
string

Responses

Request samples

Content type
application/json
{
  • "empty": true,
  • "ids": [
    ],
  • "name": "string",
  • "nameSubString": "string"
}

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 block

Removes block by id

path Parameters
blockId
required
integer <int64>

Block id

query Parameters
organization
string

Organization Id

Responses

Response samples

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

Get block

Returns block found by id

path Parameters
blockId
required
integer <int64>

Block id

query Parameters
organization
string

Organization Id

Responses

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

Update block

Updates block by id

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
{
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "events": [
    ],
  • "fps": 0.1,
  • "id": 0,
  • "name": "string",
  • "version": 0
}

Block assignments

Returns block assignments

path Parameters
blockId
required
integer <int64>

Block id

query Parameters
organization
required
string

Responses

Response samples

Content type
application/json
{
  • "channels": [
    ],
  • "schedules": [
    ]
}

Copy block

Copies block

path Parameters
blockId
required
integer <int64>

Block id

query Parameters
organization
string

Organization Id

Request Body schema: application/json
required
string

Responses

Request samples

Content type
application/json
"string"

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

Get block event list

Returns event list of block found by id

path Parameters
blockId
required
integer <int64>

Block id

query Parameters
organization
string

Organization Id

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create block event

Creates new event

path Parameters
blockId
required
integer <int64>

Block id

query Parameters
organization
string

Organization Id

Request Body schema: application/json
required
object (EventAssetDataDTO)
duration
integer <int64>
id
integer <int64>
mediaId
string
orderIndex
integer <int64>
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",
  • "orderIndex": 0,
  • "som": 0,
  • "timecodeIn": 0,
  • "title": "string",
  • "version": 0
}

Response samples

Content type
application/json
{ }

Bulk delete block events

Deletes specified block events

path Parameters
blockId
required
integer <int64>

Block id

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
{
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "events": [
    ],
  • "fps": 0.1,
  • "id": 0,
  • "name": "string",
  • "version": 0
}

Modify block events

Creates, updates, deletes multiple block events

path Parameters
blockId
required
integer <int64>

Block id

query Parameters
version
required
integer <int32>

Block version

organization
string

Organization Id

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

Responses

Request samples

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

Response samples

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

Validated block

Returns validation result

path Parameters
blockId
required
integer <int64>

Block id

query Parameters
organization
string

Organization Id

Responses

Response samples

Content type
application/json
{
  • "archivedAssetEvents": [
    ],
  • "archivedAssets": [
    ],
  • "events": [
    ],
  • "incompleteAssetEvents": [
    ],
  • "incompleteAssets": [
    ],
  • "messages": [
    ],
  • "missingAssetEvents": [
    ],
  • "missingAssets": [
    ],
  • "status": "OK",
  • "unsuccessfulQCAssetEvents": [
    ],
  • "unsuccessfulQCAssets": [
    ]
}

Delete block event

Removes block event by id

path Parameters
blockId
required
integer <int64>

Block id

eventId
required
integer <int64>

Event id

query Parameters
organization
string

Organization Id

Responses

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

Get block event

Returns event of block found by id

path Parameters
blockId
required
integer <int64>

Block id

eventId
required
integer <int64>

Event id

query Parameters
organization
string

Organization Id

Responses

Response samples

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

Update block event

Updates event

path Parameters
blockId
required
integer <int64>

Block id

eventId
required
integer <int64>

Event id

query Parameters
organization
string

Organization Id

Request Body schema: application/json
required
object (EventAssetDataDTO)
duration
integer <int64>
id
integer <int64>
mediaId
string
orderIndex
integer <int64>
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",
  • "orderIndex": 0,
  • "som": 0,
  • "timecodeIn": 0,
  • "title": "string",
  • "version": 0
}

Response samples

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

Export block as XML

Exports block into XML format

path Parameters
blockId
required
integer <int64>
query Parameters
organization
required
string
Use milliseconds instead of frames in time values
boolean

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

Emergency playlist resource

Emergency playlist resource

Get emergency playlists

Returns emergency playlists

query Parameters
page
integer >= 0
Default: 0

Zero-based page index (0..N)

size
integer >= 1
Default: 20

The size of the page to be returned

sort
Array of strings

Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

includeEvents
boolean
required
object (EmergencyPlaylistSearch)
organization
string

Organization Id

Responses

Response samples

Content type
{
  • "_embedded": {
    },
  • "_links": {
    },
  • "page": {
    }
}

Create new playlist

Creates new playlist

query Parameters
organization
string

Organization Id

Request Body schema: application/json
required
dateCreated
string <date-time>
dateUpdated
string <date-time>
fps
number
fpsFloat
number <float>
graphicsProject
string
graphicsProjectV2
string
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",
  • "fps": 0,
  • "fpsFloat": 0.1,
  • "graphicsProject": "string",
  • "graphicsProjectV2": "string",
  • "id": 0,
  • "name": "string",
  • "version": 0
}

Response samples

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

Bulk delete playlist

Deletes specified playlists

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

refreshPlaylistAssetData

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

Search emergency playlists

Returns emergency playlists

query Parameters
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
fps
number
name
string
nameSubString
string

Responses

Request samples

Content type
application/json
{
  • "fps": 0,
  • "name": "string",
  • "nameSubString": "string"
}

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 playlist

Removes playlist by id

path Parameters
playlistId
required
integer <int64>

Playlist id

query Parameters
organization
string

Organization Id

Responses

Response samples

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

Get emergency playlist

Returns emergency playlist found by id

path Parameters
playlistId
required
integer <int64>

Playlist id

query Parameters
organization
string

Organization Id

Responses

Response samples

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

Update playlist

Updates playlist by id

path Parameters
playlistId
required
integer <int64>

Playlist id

query Parameters
organization
string

Organization Id

Request Body schema: application/json
required
dateCreated
string <date-time>
dateUpdated
string <date-time>
fps
number
fpsFloat
number <float>
graphicsProject
string
graphicsProjectV2
string
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",
  • "fps": 0,
  • "fpsFloat": 0.1,
  • "graphicsProject": "string",
  • "graphicsProjectV2": "string",
  • "id": 0,
  • "name": "string",
  • "version": 0
}

Response samples

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

Copy playlist

Copies playlist

path Parameters
playlistId
required
integer <int64>

Playlist id

query Parameters
organization
string

Organization Id

Request Body schema: application/json
required
string

Responses

Request samples

Content type
application/json
"string"

Response samples

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

Get playlist event list

Returns event list of playlist found by id

path Parameters
playlistId
required
integer <int64>

Playlist id

query Parameters
organization
string

Organization Id

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create playlist event

Creates new event

path Parameters
playlistId
required
integer <int64>

Playlist id

query Parameters
organization
string

Organization Id

Request Body schema: application/json
required
object (EventAssetDataDTO)
duration
integer <int64>
id
integer <int64>
mediaId
string
orderIndex
integer <int64>
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",
  • "orderIndex": 0,
  • "som": 0,
  • "timecodeIn": 0,
  • "title": "string",
  • "version": 0
}

Response samples

Content type
application/json
{ }

Bulk update playlist events

Updates events

path Parameters
playlistId
required
integer <int64>

playlist id

query Parameters
organization
string

Organization Id

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

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

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

Bulk delete playlist events

Deletes specified playlist events

path Parameters
playlistId
required
integer <int64>

Playlist id

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
{
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "fps": 0,
  • "graphicsProject": "string",
  • "graphicsProjectV2": "string",
  • "id": 0,
  • "name": "string",
  • "version": 0
}

Validated emergency playlist

Returns validation result

path Parameters
playlistId
required
integer <int64>

Playlist id

query Parameters
organization
string

Organization Id

Responses

Response samples

Content type
application/json
{
  • "archivedAssetEvents": [
    ],
  • "archivedAssets": [
    ],
  • "events": [
    ],
  • "incompleteAssetEvents": [
    ],
  • "incompleteAssets": [
    ],
  • "messages": [
    ],
  • "missingAssetEvents": [
    ],
  • "missingAssets": [
    ],
  • "status": "OK",
  • "unsuccessfulQCAssetEvents": [
    ],
  • "unsuccessfulQCAssets": [
    ]
}

Delete playlist event

Removes playlist event by id

path Parameters
playlistId
required
integer <int64>

Playlist id

eventId
required
integer <int64>

Event id

query Parameters
organization
string

Organization Id

Responses

Response samples

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

Get playlist event

Returns event of playlist found by id

path Parameters
playlistId
required
integer <int64>

Playlist id

eventId
required
integer <int64>

Event id

query Parameters
organization
string

Organization Id

Responses

Response samples

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

Update playlist event

Updates event

path Parameters
playlistId
required
integer <int64>

Playlist id

eventId
required
integer <int64>

Event id

query Parameters
organization
string

Organization Id

Request Body schema: application/json
required
object (EventAssetDataDTO)
duration
integer <int64>
id
integer <int64>
mediaId
string
orderIndex
integer <int64>
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",
  • "orderIndex": 0,
  • "som": 0,
  • "timecodeIn": 0,
  • "title": "string",
  • "version": 0
}

Response samples

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

Assets

Asset management

Returns asset assignments

Asset assignments

query Parameters
organization
required
string
Request Body schema: application/json
required
Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

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

block-event-entity-controller

getCollectionResource-blockevent-get_1

get-blockevent

Responses

Response samples

Content type
{
  • "_embedded": {
    },
  • "_links": {
    }
}

postCollectionResource-blockevent-post

create-blockevent

Request Body schema: application/json
required
object (EventAssetDataDTO)
duration
integer <int64>
id
integer <int64>
mediaId
string
orderIndex
integer <int64>
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",
  • "orderIndex": 0,
  • "som": 0,
  • "timecodeIn": 0,
  • "title": "string",
  • "version": 0
}

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "assetData": {
    },
  • "duration": 0,
  • "mediaId": "string",
  • "orderIndex": 0,
  • "som": 0,
  • "timecodeIn": 0,
  • "title": "string",
  • "version": 0
}

deleteItemResource-blockevent-delete

delete-blockevent

path Parameters
id
required
string

Responses

getItemResource-blockevent-get

get-blockevent

path Parameters
id
required
string

Responses

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "assetData": {
    },
  • "duration": 0,
  • "mediaId": "string",
  • "orderIndex": 0,
  • "som": 0,
  • "timecodeIn": 0,
  • "title": "string",
  • "version": 0
}

patchItemResource-blockevent-patch

patch-blockevent

path Parameters
id
required
string
Request Body schema: application/json
required
object (EventAssetDataDTO)
duration
integer <int64>
id
integer <int64>
mediaId
string
orderIndex
integer <int64>
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",
  • "orderIndex": 0,
  • "som": 0,
  • "timecodeIn": 0,
  • "title": "string",
  • "version": 0
}

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "assetData": {
    },
  • "duration": 0,
  • "mediaId": "string",
  • "orderIndex": 0,
  • "som": 0,
  • "timecodeIn": 0,
  • "title": "string",
  • "version": 0
}

putItemResource-blockevent-put

update-blockevent

path Parameters
id
required
string
Request Body schema: application/json
required
object (EventAssetDataDTO)
duration
integer <int64>
id
integer <int64>
mediaId
string
orderIndex
integer <int64>
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",
  • "orderIndex": 0,
  • "som": 0,
  • "timecodeIn": 0,
  • "title": "string",
  • "version": 0
}

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "assetData": {
    },
  • "duration": 0,
  • "mediaId": "string",
  • "orderIndex": 0,
  • "som": 0,
  • "timecodeIn": 0,
  • "title": "string",
  • "version": 0
}

block-event-search-controller

executeSearch-blockevent-get

query Parameters
organization
string

Responses

Response samples

Content type
application/hal+json
{
  • "_embedded": {
    },
  • "_links": {
    }
}

executeSearch-blockevent-get_1

query Parameters
object (Block)
eventId
integer <int64>

Responses

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "assetData": {
    },
  • "duration": 0,
  • "mediaId": "string",
  • "orderIndex": 0,
  • "som": 0,
  • "timecodeIn": 0,
  • "title": "string",
  • "version": 0
}

block-entity-controller

Get blocks

Returns blocks

query Parameters
page
integer >= 0
Default: 0

Zero-based page index (0..N)

size
integer >= 1
Default: 20

The size of the page to be returned

sort
Array of strings

Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

include
Array of strings

Enter 'events' as included field to retrieve events info in the result

required
object (BlockSearchDTO)
organization
string

Organization Id

Responses

Response samples

Content type
{
  • "_embedded": {
    },
  • "_links": {
    },
  • "page": {
    }
}

Create new block

Creates new block

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
{
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "events": [
    ],
  • "fps": 0.1,
  • "id": 0,
  • "name": "string",
  • "version": 0
}

deleteItemResource-block-delete

delete-block

path Parameters
id
required
string

Responses

getItemResource-block-get

get-block

path Parameters
id
required
string

Responses

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "fps": 0.1,
  • "name": "string",
  • "organization": "string",
  • "version": 0
}

patchItemResource-block-patch

patch-block

path Parameters
id
required
string
Request Body schema: application/json
required
dateCreated
string <date-time>
dateUpdated
string <date-time>
events
Array of strings
fps
number <float>
id
integer <int64>
name
string
organization
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",
  • "organization": "string",
  • "version": 0
}

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "fps": 0.1,
  • "name": "string",
  • "organization": "string",
  • "version": 0
}

putItemResource-block-put

update-block

path Parameters
id
required
string
Request Body schema: application/json
required
dateCreated
string <date-time>
dateUpdated
string <date-time>
events
Array of strings
fps
number <float>
id
integer <int64>
name
string
organization
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",
  • "organization": "string",
  • "version": 0
}

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "fps": 0.1,
  • "name": "string",
  • "organization": "string",
  • "version": 0
}

block-search-controller

executeSearch-block-get

query Parameters
blockId
integer <int64>
organization
string

Responses

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "fps": 0.1,
  • "name": "string",
  • "organization": "string",
  • "version": 0
}

executeSearch-block-get_1

query Parameters
organization
string

Responses

Response samples

Content type
application/hal+json
{
  • "_embedded": {
    },
  • "_links": {
    }
}

block-property-reference-controller

deletePropertyReference-block-delete

delete-blockevent-by-block-Id

path Parameters
id
required
string

Responses

followPropertyReference-block-get_1

get-blockevent-by-block-Id

path Parameters
id
required
string

Responses

Response samples

Content type
{
  • "_embedded": {
    },
  • "_links": {
    }
}

createPropertyReference-block-patch

patch-blockevent-by-block-Id

path Parameters
id
required
string
Request Body schema:
required
object
object (Links)

Responses

Request samples

Content type
{
  • "_embedded": {
    },
  • "_links": {
    }
}

Response samples

Content type
application/hal+json
{
  • "_embedded": {
    },
  • "_links": {
    }
}

createPropertyReference-block-put

update-blockevent-by-block-Id

path Parameters
id
required
string
Request Body schema:
required
object
object (Links)

Responses

Request samples

Content type
{
  • "_embedded": {
    },
  • "_links": {
    }
}

Response samples

Content type
application/hal+json
{
  • "_embedded": {
    },
  • "_links": {
    }
}

deletePropertyReferenceId-block-delete

delete-blockevent-by-block-Id

path Parameters
id
required
string
propertyId
required
string

Responses

followPropertyReference-block-get

get-blockevent-by-block-Id

path Parameters
id
required
string
propertyId
required
string

Responses

Response samples

Content type
application/hal+json
{
  • "_embedded": {
    },
  • "_links": {
    }
}

emergency-event-entity-controller

getCollectionResource-emergencyevent-get_1

get-emergencyevent

Responses

Response samples

Content type
{
  • "_embedded": {
    },
  • "_links": {
    }
}

postCollectionResource-emergencyevent-post

create-emergencyevent

Request Body schema: application/json
required
object (EventAssetDataDTO)
duration
integer <int64>
id
integer <int64>
mediaId
string
orderIndex
integer <int64>
playlist
string
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",
  • "orderIndex": 0,
  • "playlist": "string",
  • "som": 0,
  • "timecodeIn": 0,
  • "title": "string",
  • "version": 0
}

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "assetData": {
    },
  • "duration": 0,
  • "mediaId": "string",
  • "orderIndex": 0,
  • "som": 0,
  • "timecodeIn": 0,
  • "title": "string",
  • "version": 0
}

deleteItemResource-emergencyevent-delete

delete-emergencyevent

path Parameters
id
required
string

Responses

getItemResource-emergencyevent-get

get-emergencyevent

path Parameters
id
required
string

Responses

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "assetData": {
    },
  • "duration": 0,
  • "mediaId": "string",
  • "orderIndex": 0,
  • "som": 0,
  • "timecodeIn": 0,
  • "title": "string",
  • "version": 0
}

patchItemResource-emergencyevent-patch

patch-emergencyevent

path Parameters
id
required
string
Request Body schema: application/json
required
object (EventAssetDataDTO)
duration
integer <int64>
id
integer <int64>
mediaId
string
orderIndex
integer <int64>
playlist
string
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",
  • "orderIndex": 0,
  • "playlist": "string",
  • "som": 0,
  • "timecodeIn": 0,
  • "title": "string",
  • "version": 0
}

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "assetData": {
    },
  • "duration": 0,
  • "mediaId": "string",
  • "orderIndex": 0,
  • "som": 0,
  • "timecodeIn": 0,
  • "title": "string",
  • "version": 0
}

putItemResource-emergencyevent-put

update-emergencyevent

path Parameters
id
required
string
Request Body schema: application/json
required
object (EventAssetDataDTO)
duration
integer <int64>
id
integer <int64>
mediaId
string
orderIndex
integer <int64>
playlist
string
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",
  • "orderIndex": 0,
  • "playlist": "string",
  • "som": 0,
  • "timecodeIn": 0,
  • "title": "string",
  • "version": 0
}

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "assetData": {
    },
  • "duration": 0,
  • "mediaId": "string",
  • "orderIndex": 0,
  • "som": 0,
  • "timecodeIn": 0,
  • "title": "string",
  • "version": 0
}

emergency-event-search-controller

executeSearch-emergencyevent-get

query Parameters
organization
string

Responses

Response samples

Content type
application/hal+json
{
  • "_embedded": {
    },
  • "_links": {
    }
}

executeSearch-emergencyevent-get_1

query Parameters
mediaId
string
organization
string

Responses

Response samples

Content type
application/hal+json
{
  • "_embedded": {
    },
  • "_links": {
    }
}

executeSearch-emergencyevent-get_2

query Parameters
organization
string

Responses

Response samples

Content type
application/hal+json
{
  • "_embedded": {
    },
  • "_links": {
    }
}

executeSearch-emergencyevent-get_3

query Parameters
object (EmergencyPlaylist)
eventId
integer <int64>

Responses

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "assetData": {
    },
  • "duration": 0,
  • "mediaId": "string",
  • "orderIndex": 0,
  • "som": 0,
  • "timecodeIn": 0,
  • "title": "string",
  • "version": 0
}

executeSearch-emergencyevent-get_4

query Parameters
object (EmergencyPlaylist)

Responses

Response samples

Content type
application/hal+json
{
  • "_embedded": {
    },
  • "_links": {
    }
}

emergency-event-property-reference-controller

deletePropertyReference-emergencyevent-delete

delete-emergencyplaylist-by-emergencyevent-Id

path Parameters
id
required
string

Responses

followPropertyReference-emergencyevent-get_1

get-emergencyplaylist-by-emergencyevent-Id

path Parameters
id
required
string

Responses

Response samples

Content type
{
  • "_links": {
    },
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "fps": 0,
  • "graphicsProject": "string",
  • "graphicsProjectV2": "string",
  • "name": "string",
  • "organization": "string",
  • "version": 0
}

createPropertyReference-emergencyevent-patch

patch-emergencyplaylist-by-emergencyevent-Id

path Parameters
id
required
string
Request Body schema:
required
object
object (Links)

Responses

Request samples

Content type
{
  • "_embedded": {
    },
  • "_links": {
    }
}

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "fps": 0,
  • "graphicsProject": "string",
  • "graphicsProjectV2": "string",
  • "name": "string",
  • "organization": "string",
  • "version": 0
}

createPropertyReference-emergencyevent-put

update-emergencyplaylist-by-emergencyevent-Id

path Parameters
id
required
string
Request Body schema:
required
object
object (Links)

Responses

Request samples

Content type
{
  • "_embedded": {
    },
  • "_links": {
    }
}

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "fps": 0,
  • "graphicsProject": "string",
  • "graphicsProjectV2": "string",
  • "name": "string",
  • "organization": "string",
  • "version": 0
}

deletePropertyReferenceId-emergencyevent-delete

delete-emergencyplaylist-by-emergencyevent-Id

path Parameters
id
required
string
propertyId
required
string

Responses

followPropertyReference-emergencyevent-get

get-emergencyplaylist-by-emergencyevent-Id

path Parameters
id
required
string
propertyId
required
string

Responses

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "fps": 0,
  • "graphicsProject": "string",
  • "graphicsProjectV2": "string",
  • "name": "string",
  • "organization": "string",
  • "version": 0
}

emergency-playlist-entity-controller

Get emergency playlists

Returns emergency playlists

query Parameters
page
integer >= 0
Default: 0

Zero-based page index (0..N)

size
integer >= 1
Default: 20

The size of the page to be returned

sort
Array of strings

Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

includeEvents
boolean
required
object (EmergencyPlaylistSearch)
organization
string

Organization Id

Responses

Response samples

Content type
{
  • "_embedded": {
    },
  • "_links": {
    },
  • "page": {
    }
}

Create new playlist

Creates new playlist

query Parameters
organization
string

Organization Id

Request Body schema: application/json
required
dateCreated
string <date-time>
dateUpdated
string <date-time>
fps
number
fpsFloat
number <float>
graphicsProject
string
graphicsProjectV2
string
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",
  • "fps": 0,
  • "fpsFloat": 0.1,
  • "graphicsProject": "string",
  • "graphicsProjectV2": "string",
  • "id": 0,
  • "name": "string",
  • "version": 0
}

Response samples

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

deleteItemResource-emergencyplaylist-delete

delete-emergencyplaylist

path Parameters
id
required
string

Responses

getItemResource-emergencyplaylist-get

get-emergencyplaylist

path Parameters
id
required
string

Responses

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "fps": 0,
  • "graphicsProject": "string",
  • "graphicsProjectV2": "string",
  • "name": "string",
  • "organization": "string",
  • "version": 0
}

patchItemResource-emergencyplaylist-patch

patch-emergencyplaylist

path Parameters
id
required
string
Request Body schema: application/json
required
dateCreated
string <date-time>
dateUpdated
string <date-time>
events
Array of strings
fps
number
graphicsProject
string
graphicsProjectV2
string
id
integer <int64>
name
string
organization
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,
  • "graphicsProject": "string",
  • "graphicsProjectV2": "string",
  • "id": 0,
  • "name": "string",
  • "organization": "string",
  • "version": 0
}

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "fps": 0,
  • "graphicsProject": "string",
  • "graphicsProjectV2": "string",
  • "name": "string",
  • "organization": "string",
  • "version": 0
}

putItemResource-emergencyplaylist-put

update-emergencyplaylist

path Parameters
id
required
string
Request Body schema: application/json
required
dateCreated
string <date-time>
dateUpdated
string <date-time>
events
Array of strings
fps
number
graphicsProject
string
graphicsProjectV2
string
id
integer <int64>
name
string
organization
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,
  • "graphicsProject": "string",
  • "graphicsProjectV2": "string",
  • "id": 0,
  • "name": "string",
  • "organization": "string",
  • "version": 0
}

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "fps": 0,
  • "graphicsProject": "string",
  • "graphicsProjectV2": "string",
  • "name": "string",
  • "organization": "string",
  • "version": 0
}

emergency-playlist-search-controller

executeSearch-emergencyplaylist-get

query Parameters
playlistId
integer <int64>
organization
string

Responses

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "fps": 0,
  • "graphicsProject": "string",
  • "graphicsProjectV2": "string",
  • "name": "string",
  • "organization": "string",
  • "version": 0
}

executeSearch-emergencyplaylist-get_1

query Parameters
organization
string

Responses

Response samples

Content type
application/hal+json
{
  • "_embedded": {
    },
  • "_links": {
    }
}

executeSearch-emergencyplaylist-get_2

Responses

Response samples

Content type
application/hal+json
{
  • "_embedded": {
    },
  • "_links": {
    }
}

emergency-playlist-property-reference-controller

deletePropertyReference-emergencyplaylist-delete

delete-emergencyevent-by-emergencyplaylist-Id

path Parameters
id
required
string

Responses

followPropertyReference-emergencyplaylist-get_1

get-emergencyevent-by-emergencyplaylist-Id

path Parameters
id
required
string

Responses

Response samples

Content type
{
  • "_embedded": {
    },
  • "_links": {
    }
}

createPropertyReference-emergencyplaylist-patch

patch-emergencyevent-by-emergencyplaylist-Id

path Parameters
id
required
string
Request Body schema:
required
object
object (Links)

Responses

Request samples

Content type
{
  • "_embedded": {
    },
  • "_links": {
    }
}

Response samples

Content type
application/hal+json
{
  • "_embedded": {
    },
  • "_links": {
    }
}

createPropertyReference-emergencyplaylist-put

update-emergencyevent-by-emergencyplaylist-Id

path Parameters
id
required
string
Request Body schema:
required
object
object (Links)

Responses

Request samples

Content type
{
  • "_embedded": {
    },
  • "_links": {
    }
}

Response samples

Content type
application/hal+json
{
  • "_embedded": {
    },
  • "_links": {
    }
}

deletePropertyReferenceId-emergencyplaylist-delete

delete-emergencyevent-by-emergencyplaylist-Id

path Parameters
id
required
string
propertyId
required
string

Responses

followPropertyReference-emergencyplaylist-get

get-emergencyevent-by-emergencyplaylist-Id

path Parameters
id
required
string
propertyId
required
string

Responses

Response samples

Content type
application/hal+json
{
  • "_embedded": {
    },
  • "_links": {
    }
}

event-entity-controller

getCollectionResource-event-get_1

get-event

query Parameters
page
integer >= 0
Default: 0

Zero-based page index (0..N)

size
integer >= 1
Default: 20

The size of the page to be returned

sort
Array of strings

Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

Responses

Response samples

Content type
{
  • "_embedded": {
    },
  • "_links": {
    },
  • "page": {
    }
}

postCollectionResource-event-post

create-event

Request Body schema: application/json
required
object (EventAssetDataDTO)
object (AudioTransitionDTO)
block
boolean
blockId
integer <int64>
blockMode
string
Enum: "ORDERED" "RANDOM"
category
string
changes
string
color
string
Array of objects (ContentAdvisory)
duration
integer <int64>
eventType
string
Enum: "PRIMARY" "ADVERTISEMENT" "LIVE" "PLACEHOLDER" "BLOCK" "EMERGENCY"
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
onAirTime
string <date-time>
onAirTimeTime
integer <int64>
Array of objects (PidDTO)
placeholderId
string
Array of objects (PlayoutSwitchDTO)
object (PrimarySCTESourceSwitchDTO)
object (EventProgrammeDTO)
reconciliationId
string
recording
boolean
recordingPattern
string
schedule
string
Array of objects (SCTE35SignalDTO)
object (SCTE35TriggerDTO)
Array of objects (SecondaryEventDTO)
som
integer <int64>
Array of objects (StreamOverrideDTO)
timecodeIn
integer <int64>
title
string
Array of objects (TwitchRPCDTO)
Array of objects (UntimedAdDTO)
version
integer <int32>
Array of objects (VoiceoverDTO)

Responses

Request samples

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

Response samples

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

deleteItemResource-event-delete

delete-event

path Parameters
id
required
string

Responses

getItemResource-event-get

get-event

path Parameters
id
required
string

Responses

Response samples

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

patchItemResource-event-patch

patch-event

path Parameters
id
required
string
Request Body schema: application/json
required
object (EventAssetDataDTO)
object (AudioTransitionDTO)
block
boolean
blockId
integer <int64>
blockMode
string
Enum: "ORDERED" "RANDOM"
category
string
changes
string
color
string
Array of objects (ContentAdvisory)
duration
integer <int64>
eventType
string
Enum: "PRIMARY" "ADVERTISEMENT" "LIVE" "PLACEHOLDER" "BLOCK" "EMERGENCY"
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
onAirTime
string <date-time>
onAirTimeTime
integer <int64>
Array of objects (PidDTO)
placeholderId
string
Array of objects (PlayoutSwitchDTO)
object (PrimarySCTESourceSwitchDTO)
object (EventProgrammeDTO)
reconciliationId
string
recording
boolean
recordingPattern
string
schedule
string
Array of objects (SCTE35SignalDTO)
object (SCTE35TriggerDTO)
Array of objects (SecondaryEventDTO)
som
integer <int64>
Array of objects (StreamOverrideDTO)
timecodeIn
integer <int64>
title
string
Array of objects (TwitchRPCDTO)
Array of objects (UntimedAdDTO)
version
integer <int32>
Array of objects (VoiceoverDTO)

Responses

Request samples

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

Response samples

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

putItemResource-event-put

update-event

path Parameters
id
required
string
Request Body schema: application/json
required
object (EventAssetDataDTO)
object (AudioTransitionDTO)
block
boolean
blockId
integer <int64>
blockMode
string
Enum: "ORDERED" "RANDOM"
category
string
changes
string
color
string
Array of objects (ContentAdvisory)
duration
integer <int64>
eventType
string
Enum: "PRIMARY" "ADVERTISEMENT" "LIVE" "PLACEHOLDER" "BLOCK" "EMERGENCY"
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
onAirTime
string <date-time>
onAirTimeTime
integer <int64>
Array of objects (PidDTO)
placeholderId
string
Array of objects (PlayoutSwitchDTO)
object (PrimarySCTESourceSwitchDTO)
object (EventProgrammeDTO)
reconciliationId
string
recording
boolean
recordingPattern
string
schedule
string
Array of objects (SCTE35SignalDTO)
object (SCTE35TriggerDTO)
Array of objects (SecondaryEventDTO)
som
integer <int64>
Array of objects (StreamOverrideDTO)
timecodeIn
integer <int64>
title
string
Array of objects (TwitchRPCDTO)
Array of objects (UntimedAdDTO)
version
integer <int32>
Array of objects (VoiceoverDTO)

Responses

Request samples

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

Response samples

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

event-search-controller

executeSearch-event-get

query Parameters
scheduleChangesId
integer <int64>
eventType
string

Responses

Response samples

Content type
application/hal+json
0
0

executeSearch-event-get_1

query Parameters
object (Schedule)
object (ScheduleChanges)

Responses

executeSearch-event-get_2

query Parameters
scheduleId
integer <int64>
scheduleChangesId
integer <int64>
newScheduleId
integer <int64>

Responses

Response samples

Content type
application/hal+json
0
0

executeSearch-event-get_3

query Parameters
object (Schedule)
eventIds
Array of integers <int64> [ items <int64 > ]

Responses

Response samples

Content type
application/hal+json
0
0

executeSearch-event-get_4

query Parameters
scheduleChangesId
integer <int64>

Responses

Response samples

Content type
application/hal+json
0
0

executeSearch-event-get_5

query Parameters
scheduleId
integer <int64>

Responses

Response samples

Content type
application/hal+json
0
0

executeSearch-event-get_6

query Parameters
scheduleId
integer <int64>

Responses

Response samples

Content type
application/hal+json
0
0

executeSearch-event-get_7

query Parameters
organization
string

Responses

Response samples

Content type
application/hal+json
{
  • "_embedded": {
    },
  • "_links": {
    }
}

executeSearch-event-get_8

query Parameters
object (ScheduleChanges)
page
integer >= 0
Default: 0

Zero-based page index (0..N)

size
integer >= 1
Default: 20

The size of the page to be returned

sort
Array of strings

Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

Responses

Response samples

Content type
application/hal+json
{
  • "_embedded": {
    },
  • "_links": {
    },
  • "page": {
    }
}

executeSearch-event-get_9

query Parameters
object (ScheduleChanges)
eventIds
Array of integers <int64> [ items <int64 > ]

Responses

Response samples

Content type
application/hal+json
{
  • "_embedded": {
    },
  • "_links": {
    }
}

executeSearch-event-get_10

query Parameters
object (ScheduleChanges)
onAirTime
Array of strings <date-time> [ items <date-time > ]

Responses

Response samples

Content type
application/hal+json
{
  • "_embedded": {
    },
  • "_links": {
    }
}

executeSearch-event-get_11

query Parameters
object (ScheduleChanges)

Responses

Response samples

Content type
application/hal+json
{
  • "_embedded": {
    },
  • "_links": {
    }
}

executeSearch-event-get_12

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

Responses

Response samples

Content type
application/hal+json
{
  • "_embedded": {
    },
  • "_links": {
    }
}

executeSearch-event-get_13

query Parameters
object (Schedule)
page
integer >= 0
Default: 0

Zero-based page index (0..N)

size
integer >= 1
Default: 20

The size of the page to be returned

sort
Array of strings

Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

Responses

Response samples

Content type
application/hal+json
{
  • "_embedded": {
    },
  • "_links": {
    },
  • "page": {
    }
}

executeSearch-event-get_14

query Parameters
object (Schedule)
eventId
integer <int64>

Responses

Response samples

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

executeSearch-event-get_15

query Parameters
object (Schedule)
eventIds
Array of integers <int64> [ items <int64 > ]

Responses

Response samples

Content type
application/hal+json
{
  • "_embedded": {
    },
  • "_links": {
    }
}

executeSearch-event-get_16

query Parameters
object (Schedule)
onAirTime
string <date-time>

Responses

Response samples

Content type
application/hal+json
{
  • "_embedded": {
    },
  • "_links": {
    }
}

executeSearch-event-get_17

query Parameters
object (Schedule)

Responses

Response samples

Content type
application/hal+json
{
  • "_embedded": {
    },
  • "_links": {
    }
}

executeSearch-event-get_18

query Parameters
object (ScheduleChanges)
onAirTime
string <date-time>

Responses

Response samples

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

executeSearch-event-get_19

query Parameters
object (ScheduleChanges)
onAirTime
string <date-time>
label
string

Responses

Response samples

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

executeSearch-event-get_20

query Parameters
object (ScheduleChanges)
onAirTime
string <date-time>

Responses

Response samples

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

executeSearch-event-get_21

query Parameters
object (Schedule)
locked
boolean

Responses

Response samples

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

executeSearch-event-get_22

query Parameters
object (Schedule)
onAirTime
string <date-time>

Responses

Response samples

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

executeSearch-event-get_23

query Parameters
object (Schedule)
onAirTime
string <date-time>
label
string

Responses

Response samples

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

executeSearch-event-get_24

query Parameters
object (Schedule)
onAirTime
string <date-time>

Responses

Response samples

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

executeSearch-event-get_25

query Parameters
object (Schedule)

Responses

Response samples

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

executeSearch-event-get_26

query Parameters
object (Schedule)

Responses

Response samples

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

executeSearch-event-get_27

query Parameters
changesId
integer <int64>
onAirTime
string <date-time>

Responses

Response samples

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

executeSearch-event-get_28

query Parameters
scheduleId
integer <int64>
onAirTime
string <date-time>

Responses

Response samples

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

executeSearch-event-get_29

query Parameters
scheduleId
integer <int64>
ids
Array of integers <int64> [ items <int64 > ]

Responses

Response samples

Content type
application/hal+json
{
  • "_embedded": {
    },
  • "_links": {
    }
}

executeSearch-event-get_30

query Parameters
changesId
integer <int64>
onAirTime
string <date-time>

Responses

Response samples

Content type
application/hal+json
{
  • "_embedded": {
    },
  • "_links": {
    }
}

executeSearch-event-get_31

query Parameters
scheduleId
integer <int64>
onAirTime
string <date-time>

Responses

Response samples

Content type
application/hal+json
{
  • "_embedded": {
    },
  • "_links": {
    }
}

executeSearch-event-get_32

query Parameters
scheduleId
integer <int64>
assetName
string
organization
string

Responses

Response samples

Content type
application/hal+json
{
  • "_embedded": {
    },
  • "_links": {
    }
}

executeSearch-event-get_33

query Parameters
scheduleChangesId
integer <int64>
eventType
string

Responses

Response samples

Content type
application/hal+json
0
0

executeSearch-event-get_34

query Parameters
scheduleChangesId
integer <int64>
eventType
string
on
string
onoff
string
off
string

Responses

Response samples

Content type
application/hal+json
0
0

executeSearch-event-get_35

query Parameters
scheduleChangesId
integer <int64>
eventType
string

Responses

Response samples

Content type
application/hal+json
0
0

executeSearch-event-get_36

query Parameters
scheduleId
integer <int64>
programStep
integer <int64>
shift
integer <int64>
from
integer <int64>
to
integer <int64>

Responses

Response samples

Content type
application/hal+json
0
0

executeSearch-event-get_37

query Parameters
scheduleId
integer <int64>
shiftSeconds
number
shift
integer <int64>

Responses

Response samples

Content type
application/hal+json
0
0

executeSearch-event-get_38

query Parameters
scheduleChangesId
integer <int64>
eventType
string
secondaryEvents
string
scte35Signals
string
programme
string
replacementType
string

Responses

Response samples

Content type
application/hal+json
0
0

event-property-reference-controller

deletePropertyReference-event-delete

delete-schedulechanges-by-event-Id

path Parameters
id
required
string

Responses

followPropertyReference-event-get_1

get-schedulechanges-by-event-Id

path Parameters
id
required
string

Responses

Response samples

Content type
{
  • "_links": {
    },
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "finishDate": "2019-08-24T14:15:22Z",
  • "scheduleVersion": 0,
  • "startDate": "2019-08-24T14:15:22Z",
  • "userName": "string"
}

createPropertyReference-event-patch

patch-schedulechanges-by-event-Id

path Parameters
id
required
string
Request Body schema:
required
object
object (Links)

Responses

Request samples

Content type
{
  • "_embedded": {
    },
  • "_links": {
    }
}

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "finishDate": "2019-08-24T14:15:22Z",
  • "scheduleVersion": 0,
  • "startDate": "2019-08-24T14:15:22Z",
  • "userName": "string"
}

createPropertyReference-event-put

update-schedulechanges-by-event-Id

path Parameters
id
required
string
Request Body schema:
required
object
object (Links)

Responses

Request samples

Content type
{
  • "_embedded": {
    },
  • "_links": {
    }
}

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "finishDate": "2019-08-24T14:15:22Z",
  • "scheduleVersion": 0,
  • "startDate": "2019-08-24T14:15:22Z",
  • "userName": "string"
}

deletePropertyReferenceId-event-delete

delete-schedulechanges-by-event-Id

path Parameters
id
required
string
propertyId
required
string

Responses

followPropertyReference-event-get

get-schedulechanges-by-event-Id

path Parameters
id
required
string
propertyId
required
string

Responses

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "finishDate": "2019-08-24T14:15:22Z",
  • "scheduleVersion": 0,
  • "startDate": "2019-08-24T14:15:22Z",
  • "userName": "string"
}

deletePropertyReference-event-delete_1

delete-schedule-by-event-Id

path Parameters
id
required
string

Responses

followPropertyReference-event-get_2_1

get-schedule-by-event-Id

path Parameters
id
required
string

Responses

Response samples

Content type
{
  • "_links": {
    },
  • "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",
  • "deleted": true,
  • "finishDate": "2019-08-24T14:15:22Z",
  • "finiteType": true,
  • "fps": 0,
  • "graphicsProject": "string",
  • "graphicsProjectV2": "string",
  • "loopType": true,
  • "name": "string",
  • "organization": "string",
  • "playlistType": "FINITE",
  • "startDate": "2019-08-24T14:15:22Z",
  • "txdate": "string",
  • "version": 0
}

createPropertyReference-event-patch_1

patch-schedule-by-event-Id

path Parameters
id
required
string
Request Body schema:
required
object
object (Links)

Responses

Request samples

Content type
{
  • "_embedded": {
    },
  • "_links": {
    }
}

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "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",
  • "deleted": true,
  • "finishDate": "2019-08-24T14:15:22Z",
  • "finiteType": true,
  • "fps": 0,
  • "graphicsProject": "string",
  • "graphicsProjectV2": "string",
  • "loopType": true,
  • "name": "string",
  • "organization": "string",
  • "playlistType": "FINITE",
  • "startDate": "2019-08-24T14:15:22Z",
  • "txdate": "string",
  • "version": 0
}

createPropertyReference-event-put_1

update-schedule-by-event-Id

path Parameters
id
required
string
Request Body schema:
required
object
object (Links)

Responses

Request samples

Content type
{
  • "_embedded": {
    },
  • "_links": {
    }
}

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "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",
  • "deleted": true,
  • "finishDate": "2019-08-24T14:15:22Z",
  • "finiteType": true,
  • "fps": 0,
  • "graphicsProject": "string",
  • "graphicsProjectV2": "string",
  • "loopType": true,
  • "name": "string",
  • "organization": "string",
  • "playlistType": "FINITE",
  • "startDate": "2019-08-24T14:15:22Z",
  • "txdate": "string",
  • "version": 0
}

deletePropertyReferenceId-event-delete_1

delete-schedule-by-event-Id

path Parameters
id
required
string
propertyId
required
string

Responses

followPropertyReference-event-get_2

get-schedule-by-event-Id

path Parameters
id
required
string
propertyId
required
string

Responses

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "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",
  • "deleted": true,
  • "finishDate": "2019-08-24T14:15:22Z",
  • "finiteType": true,
  • "fps": 0,
  • "graphicsProject": "string",
  • "graphicsProjectV2": "string",
  • "loopType": true,
  • "name": "string",
  • "organization": "string",
  • "playlistType": "FINITE",
  • "startDate": "2019-08-24T14:15:22Z",
  • "txdate": "string",
  • "version": 0
}

export-file-entity-controller

getCollectionResource-exportfile-get_1

get-exportfile

Responses

Response samples

Content type
{
  • "_embedded": {
    },
  • "_links": {
    }
}

postCollectionResource-exportfile-post

create-exportfile

Request Body schema: application/json
required
entityId
integer <int64>
file
string <byte>
fileName
string
id
integer <int64>
organization
string

Responses

Request samples

Content type
application/json
{
  • "entityId": 0,
  • "file": "string",
  • "fileName": "string",
  • "id": 0,
  • "organization": "string"
}

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "entityId": 0,
  • "file": "string",
  • "fileName": "string",
  • "organization": "string"
}

deleteItemResource-exportfile-delete

delete-exportfile

path Parameters
id
required
string

Responses

getItemResource-exportfile-get

get-exportfile

path Parameters
id
required
string

Responses

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "entityId": 0,
  • "file": "string",
  • "fileName": "string",
  • "organization": "string"
}

patchItemResource-exportfile-patch

patch-exportfile

path Parameters
id
required
string
Request Body schema: application/json
required
entityId
integer <int64>
file
string <byte>
fileName
string
id
integer <int64>
organization
string

Responses

Request samples

Content type
application/json
{
  • "entityId": 0,
  • "file": "string",
  • "fileName": "string",
  • "id": 0,
  • "organization": "string"
}

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "entityId": 0,
  • "file": "string",
  • "fileName": "string",
  • "organization": "string"
}

putItemResource-exportfile-put

update-exportfile

path Parameters
id
required
string
Request Body schema: application/json
required
entityId
integer <int64>
file
string <byte>
fileName
string
id
integer <int64>
organization
string

Responses

Request samples

Content type
application/json
{
  • "entityId": 0,
  • "file": "string",
  • "fileName": "string",
  • "id": 0,
  • "organization": "string"
}

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "entityId": 0,
  • "file": "string",
  • "fileName": "string",
  • "organization": "string"
}

export-file-search-controller

executeSearch-exportfile-get

query Parameters
entityId
integer <int64>
fileName
string
organization
string

Responses

executeSearch-exportfile-get_1

query Parameters
entityId
integer <int64>
filename
string
organization
string

Responses

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "entityId": 0,
  • "file": "string",
  • "fileName": "string",
  • "organization": "string"
}

flyway-entity-controller

getCollectionResource-flyway-get_1

get-flyway

Responses

Response samples

Content type
{
  • "_embedded": {
    },
  • "_links": {
    }
}

postCollectionResource-flyway-post

create-flyway

Request Body schema: application/json
required
checksum
integer <int32>
description
string
executionTime
integer <int32>
installedBy
string
installedOn
string <date-time>
installedRank
integer <int32>
script
string
success
boolean
type
string
version
string

Responses

Request samples

Content type
application/json
{
  • "checksum": 0,
  • "description": "string",
  • "executionTime": 0,
  • "installedBy": "string",
  • "installedOn": "2019-08-24T14:15:22Z",
  • "installedRank": 0,
  • "script": "string",
  • "success": true,
  • "type": "string",
  • "version": "string"
}

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "checksum": 0,
  • "description": "string",
  • "executionTime": 0,
  • "installedBy": "string",
  • "installedOn": "2019-08-24T14:15:22Z",
  • "script": "string",
  • "success": true,
  • "type": "string",
  • "version": "string"
}

deleteItemResource-flyway-delete

delete-flyway

path Parameters
id
required
string

Responses

getItemResource-flyway-get

get-flyway

path Parameters
id
required
string

Responses

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "checksum": 0,
  • "description": "string",
  • "executionTime": 0,
  • "installedBy": "string",
  • "installedOn": "2019-08-24T14:15:22Z",
  • "script": "string",
  • "success": true,
  • "type": "string",
  • "version": "string"
}

patchItemResource-flyway-patch

patch-flyway

path Parameters
id
required
string
Request Body schema: application/json
required
checksum
integer <int32>
description
string
executionTime
integer <int32>
installedBy
string
installedOn
string <date-time>
installedRank
integer <int32>
script
string
success
boolean
type
string
version
string

Responses

Request samples

Content type
application/json
{
  • "checksum": 0,
  • "description": "string",
  • "executionTime": 0,
  • "installedBy": "string",
  • "installedOn": "2019-08-24T14:15:22Z",
  • "installedRank": 0,
  • "script": "string",
  • "success": true,
  • "type": "string",
  • "version": "string"
}

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "checksum": 0,
  • "description": "string",
  • "executionTime": 0,
  • "installedBy": "string",
  • "installedOn": "2019-08-24T14:15:22Z",
  • "script": "string",
  • "success": true,
  • "type": "string",
  • "version": "string"
}

putItemResource-flyway-put

update-flyway

path Parameters
id
required
string
Request Body schema: application/json
required
checksum
integer <int32>
description
string
executionTime
integer <int32>
installedBy
string
installedOn
string <date-time>
installedRank
integer <int32>
script
string
success
boolean
type
string
version
string

Responses

Request samples

Content type
application/json
{
  • "checksum": 0,
  • "description": "string",
  • "executionTime": 0,
  • "installedBy": "string",
  • "installedOn": "2019-08-24T14:15:22Z",
  • "installedRank": 0,
  • "script": "string",
  • "success": true,
  • "type": "string",
  • "version": "string"
}

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "checksum": 0,
  • "description": "string",
  • "executionTime": 0,
  • "installedBy": "string",
  • "installedOn": "2019-08-24T14:15:22Z",
  • "script": "string",
  • "success": true,
  • "type": "string",
  • "version": "string"
}

job-entity-controller

getCollectionResource-job-get_1_1

get-job

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
{
  • "_embedded": {
    },
  • "_links": {
    }
}

postCollectionResource-job-post

create-job

Request Body schema: application/json
required
accountUserId
string
dateCreated
string <date-time>
dateFinished
string <date-time>
object (JobDetails)
entityId
integer <int64>
id
integer <int64>
Array of objects (ModifyResultMessage)
organization
string
providerId
string
resourceLink
string
status
string
Enum: "PENDING" "PROCESSING" "SUCCEEDED" "FAILED" "CANCELED"
type
string
Enum: "TIMELINE_EPG_XML_EXPORT" "EXPORT" "EXPORT_BLOCK" "PLAN_ASSET_DATA_REFRESH" "TIMELINE_ASSET_DATA_REFRESH" "SCHEDULE_ASSET_DATA_REFRESH" "EMERGENCY_ASSET_DATA_REFRESH" "BLOCK_ASSET_DATA_REFRESH" "SCHEDULE_ARCHIVE" "SCHEDULE_UNARCHIVE" "SCHEDULE_IMPORT"
userId
string

Responses

Request samples

Content type
application/json
{
  • "accountUserId": "string",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateFinished": "2019-08-24T14:15:22Z",
  • "details": {
    },
  • "entityId": 0,
  • "id": 0,
  • "messages": [
    ],
  • "organization": "string",
  • "providerId": "string",
  • "resourceLink": "string",
  • "status": "PENDING",
  • "type": "TIMELINE_EPG_XML_EXPORT",
  • "userId": "string"
}

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "accountUserId": "string",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateFinished": "2019-08-24T14:15:22Z",
  • "details": {
    },
  • "entityId": 0,
  • "messages": [
    ],
  • "organization": "string",
  • "providerId": "string",
  • "resourceLink": "string",
  • "status": "PENDING",
  • "type": "TIMELINE_EPG_XML_EXPORT",
  • "userId": "string"
}

deleteItemResource-job-delete

delete-job

path Parameters
id
required
string

Responses

getItemResource-job-get

get-job

path Parameters
id
required
string

Responses

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "accountUserId": "string",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateFinished": "2019-08-24T14:15:22Z",
  • "details": {
    },
  • "entityId": 0,
  • "messages": [
    ],
  • "organization": "string",
  • "providerId": "string",
  • "resourceLink": "string",
  • "status": "PENDING",
  • "type": "TIMELINE_EPG_XML_EXPORT",
  • "userId": "string"
}

patchItemResource-job-patch

patch-job

path Parameters
id
required
string
Request Body schema: application/json
required
accountUserId
string
dateCreated
string <date-time>
dateFinished
string <date-time>
object (JobDetails)
entityId
integer <int64>
id
integer <int64>
Array of objects (ModifyResultMessage)
organization
string
providerId
string
resourceLink
string
status
string
Enum: "PENDING" "PROCESSING" "SUCCEEDED" "FAILED" "CANCELED"
type
string
Enum: "TIMELINE_EPG_XML_EXPORT" "EXPORT" "EXPORT_BLOCK" "PLAN_ASSET_DATA_REFRESH" "TIMELINE_ASSET_DATA_REFRESH" "SCHEDULE_ASSET_DATA_REFRESH" "EMERGENCY_ASSET_DATA_REFRESH" "BLOCK_ASSET_DATA_REFRESH" "SCHEDULE_ARCHIVE" "SCHEDULE_UNARCHIVE" "SCHEDULE_IMPORT"
userId
string

Responses

Request samples

Content type
application/json
{
  • "accountUserId": "string",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateFinished": "2019-08-24T14:15:22Z",
  • "details": {
    },
  • "entityId": 0,
  • "id": 0,
  • "messages": [
    ],
  • "organization": "string",
  • "providerId": "string",
  • "resourceLink": "string",
  • "status": "PENDING",
  • "type": "TIMELINE_EPG_XML_EXPORT",
  • "userId": "string"
}

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "accountUserId": "string",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateFinished": "2019-08-24T14:15:22Z",
  • "details": {
    },
  • "entityId": 0,
  • "messages": [
    ],
  • "organization": "string",
  • "providerId": "string",
  • "resourceLink": "string",
  • "status": "PENDING",
  • "type": "TIMELINE_EPG_XML_EXPORT",
  • "userId": "string"
}

putItemResource-job-put

update-job

path Parameters
id
required
string
Request Body schema: application/json
required
accountUserId
string
dateCreated
string <date-time>
dateFinished
string <date-time>
object (JobDetails)
entityId
integer <int64>
id
integer <int64>
Array of objects (ModifyResultMessage)
organization
string
providerId
string
resourceLink
string
status
string
Enum: "PENDING" "PROCESSING" "SUCCEEDED" "FAILED" "CANCELED"
type
string
Enum: "TIMELINE_EPG_XML_EXPORT" "EXPORT" "EXPORT_BLOCK" "PLAN_ASSET_DATA_REFRESH" "TIMELINE_ASSET_DATA_REFRESH" "SCHEDULE_ASSET_DATA_REFRESH" "EMERGENCY_ASSET_DATA_REFRESH" "BLOCK_ASSET_DATA_REFRESH" "SCHEDULE_ARCHIVE" "SCHEDULE_UNARCHIVE" "SCHEDULE_IMPORT"
userId
string

Responses

Request samples

Content type
application/json
{
  • "accountUserId": "string",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateFinished": "2019-08-24T14:15:22Z",
  • "details": {
    },
  • "entityId": 0,
  • "id": 0,
  • "messages": [
    ],
  • "organization": "string",
  • "providerId": "string",
  • "resourceLink": "string",
  • "status": "PENDING",
  • "type": "TIMELINE_EPG_XML_EXPORT",
  • "userId": "string"
}

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "accountUserId": "string",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateFinished": "2019-08-24T14:15:22Z",
  • "details": {
    },
  • "entityId": 0,
  • "messages": [
    ],
  • "organization": "string",
  • "providerId": "string",
  • "resourceLink": "string",
  • "status": "PENDING",
  • "type": "TIMELINE_EPG_XML_EXPORT",
  • "userId": "string"
}

job-search-controller

executeSearch-job-get

query Parameters
id
integer <int64>
organizations
Array of strings

Responses

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "accountUserId": "string",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateFinished": "2019-08-24T14:15:22Z",
  • "details": {
    },
  • "entityId": 0,
  • "messages": [
    ],
  • "organization": "string",
  • "providerId": "string",
  • "resourceLink": "string",
  • "status": "PENDING",
  • "type": "TIMELINE_EPG_XML_EXPORT",
  • "userId": "string"
}

executeSearch-job-get_1

query Parameters
date
string <date-time>
export
string
Enum: "TIMELINE_EPG_XML_EXPORT" "EXPORT" "EXPORT_BLOCK" "PLAN_ASSET_DATA_REFRESH" "TIMELINE_ASSET_DATA_REFRESH" "SCHEDULE_ASSET_DATA_REFRESH" "EMERGENCY_ASSET_DATA_REFRESH" "BLOCK_ASSET_DATA_REFRESH" "SCHEDULE_ARCHIVE" "SCHEDULE_UNARCHIVE" "SCHEDULE_IMPORT"

Responses

Response samples

Content type
application/hal+json
{
  • "_embedded": {
    },
  • "_links": {
    }
}

executeSearch-job-get_2

query Parameters
date
string <date-time>

Responses

Response samples

Content type
application/hal+json
{
  • "_embedded": {
    },
  • "_links": {
    }
}

plan-block-series-entity-controller

getCollectionResource-planblockseries-get_1

get-planblockseries

Responses

Response samples

Content type
{
  • "_embedded": {
    },
  • "_links": {
    }
}

postCollectionResource-planblockseries-post

create-planblockseries

Request Body schema: application/json
required
blocks
Array of strings
required
object (BlockSeriesConfigurationDTO)
id
integer <int64>
plan
string

Responses

Request samples

Content type
application/json
{
  • "blocks": [
    ],
  • "configuration": {
    },
  • "id": 0,
  • "plan": "string"
}

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "configuration": {
    }
}

deleteItemResource-planblockseries-delete

delete-planblockseries

path Parameters
id
required
string

Responses

getItemResource-planblockseries-get

get-planblockseries

path Parameters
id
required
string

Responses

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "configuration": {
    }
}

patchItemResource-planblockseries-patch

patch-planblockseries

path Parameters
id
required
string
Request Body schema: application/json
required
blocks
Array of strings
required
object (BlockSeriesConfigurationDTO)
id
integer <int64>
plan
string

Responses

Request samples

Content type
application/json
{
  • "blocks": [
    ],
  • "configuration": {
    },
  • "id": 0,
  • "plan": "string"
}

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "configuration": {
    }
}

putItemResource-planblockseries-put

update-planblockseries

path Parameters
id
required
string
Request Body schema: application/json
required
blocks
Array of strings
required
object (BlockSeriesConfigurationDTO)
id
integer <int64>
plan
string

Responses

Request samples

Content type
application/json
{
  • "blocks": [
    ],
  • "configuration": {
    },
  • "id": 0,
  • "plan": "string"
}

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "configuration": {
    }
}

plan-block-series-search-controller

executeSearch-planblockseries-get

query Parameters
object (Plan)

Responses

executeSearch-planblockseries-get_1

query Parameters
object (Plan)

Responses

Response samples

Content type
application/hal+json
0
0

executeSearch-planblockseries-get_2

query Parameters
id
integer <int64>
object (Plan)

Responses

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "configuration": {
    }
}

executeSearch-planblockseries-get_3

query Parameters
object (Plan)

Responses

Response samples

Content type
application/hal+json
{
  • "_embedded": {
    },
  • "_links": {
    }
}

executeSearch-planblockseries-get_4

query Parameters
object (Plan)

Responses

Response samples

Content type
application/hal+json
{
  • "_embedded": {
    },
  • "_links": {
    }
}

executeSearch-planblockseries-get_5

query Parameters
planIdFrom
integer <int64>
planIdTo
integer <int64>

Responses

plan-block-series-property-reference-controller

deletePropertyReference-planblockseries-delete

delete-planblock-by-planblockseries-Id

path Parameters
id
required
string

Responses

followPropertyReference-planblockseries-get_1

get-planblock-by-planblockseries-Id

path Parameters
id
required
string

Responses

Response samples

Content type
{
  • "_embedded": {
    },
  • "_links": {
    }
}

createPropertyReference-planblockseries-patch

patch-planblock-by-planblockseries-Id

path Parameters
id
required
string
Request Body schema:
required
object
object (Links)

Responses

Request samples

Content type
{
  • "_embedded": {
    },
  • "_links": {
    }
}

Response samples

Content type
application/hal+json
{
  • "_embedded": {
    },
  • "_links": {
    }
}

createPropertyReference-planblockseries-put

update-planblock-by-planblockseries-Id

path Parameters
id
required
string
Request Body schema:
required
object
object (Links)

Responses

Request samples

Content type
{
  • "_embedded": {
    },
  • "_links": {
    }
}

Response samples

Content type
application/hal+json
{
  • "_embedded": {
    },
  • "_links": {
    }
}

deletePropertyReferenceId-planblockseries-delete

delete-planblock-by-planblockseries-Id

path Parameters
id
required
string
propertyId
required
string

Responses

followPropertyReference-planblockseries-get

get-planblock-by-planblockseries-Id

path Parameters
id
required
string
propertyId
required
string

Responses

Response samples

Content type
application/hal+json
{
  • "_embedded": {
    },
  • "_links": {
    }
}

deletePropertyReference-planblockseries-delete_1

delete-plan-by-planblockseries-Id

path Parameters
id
required
string

Responses

followPropertyReference-planblockseries-get_2_1

get-plan-by-planblockseries-Id

path Parameters
id
required
string

Responses

Response samples

Content type
{
  • "_links": {
    },
  • "changedId": 0,
  • "channelId": 0,
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "firstWeekDay": 0,
  • "name": "string",
  • "organization": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "startOfDay": 0,
  • "status": "DRAFT",
  • "timeZone": "string",
  • "version": 0
}

createPropertyReference-planblockseries-patch_1

patch-plan-by-planblockseries-Id

path Parameters
id
required
string
Request Body schema:
required
object
object (Links)

Responses

Request samples

Content type
{
  • "_embedded": {
    },
  • "_links": {
    }
}

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "changedId": 0,
  • "channelId": 0,
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "firstWeekDay": 0,
  • "name": "string",
  • "organization": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "startOfDay": 0,
  • "status": "DRAFT",
  • "timeZone": "string",
  • "version": 0
}

createPropertyReference-planblockseries-put_1

update-plan-by-planblockseries-Id

path Parameters
id
required
string
Request Body schema:
required
object
object (Links)

Responses

Request samples

Content type
{
  • "_embedded": {
    },
  • "_links": {
    }
}

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "changedId": 0,
  • "channelId": 0,
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "firstWeekDay": 0,
  • "name": "string",
  • "organization": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "startOfDay": 0,
  • "status": "DRAFT",
  • "timeZone": "string",
  • "version": 0
}

deletePropertyReferenceId-planblockseries-delete_1

delete-plan-by-planblockseries-Id

path Parameters
id
required
string
propertyId
required
string

Responses

followPropertyReference-planblockseries-get_2

get-plan-by-planblockseries-Id

path Parameters
id
required
string
propertyId
required
string

Responses

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "changedId": 0,
  • "channelId": 0,
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "firstWeekDay": 0,
  • "name": "string",
  • "organization": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "startOfDay": 0,
  • "status": "DRAFT",
  • "timeZone": "string",
  • "version": 0
}

plan-block-entity-controller

getCollectionResource-planblock-get_1

get-planblock

Responses

Response samples

Content type
{
  • "_embedded": {
    },
  • "_links": {
    }
}

postCollectionResource-planblock-post

create-planblock

Request Body schema: application/json
required
categoryId
string
description
string
duration
integer <int64>
editable
boolean
events
Array of strings
id
integer <int64>
plan
string
planTemplate
string
object (BlockProgrammeDTO)
series
string
startDate
string <date-time>
title
string

Responses

Request samples

Content type
application/json
{
  • "categoryId": "string",
  • "description": "string",
  • "duration": 0,
  • "editable": true,
  • "events": [
    ],
  • "id": 0,
  • "plan": "string",
  • "planTemplate": "string",
  • "programme": {
    },
  • "series": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "title": "string"
}

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "categoryId": "string",
  • "description": "string",
  • "duration": 0,
  • "editable": true,
  • "programme": {
    },
  • "startDate": "2019-08-24T14:15:22Z",
  • "title": "string"
}

deleteItemResource-planblock-delete

delete-planblock

path Parameters
id
required
string

Responses

getItemResource-planblock-get

get-planblock

path Parameters
id
required
string

Responses

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "categoryId": "string",
  • "description": "string",
  • "duration": 0,
  • "editable": true,
  • "programme": {
    },
  • "startDate": "2019-08-24T14:15:22Z",
  • "title": "string"
}

patchItemResource-planblock-patch

patch-planblock

path Parameters
id
required
string
Request Body schema: application/json
required
categoryId
string
description
string
duration
integer <int64>
editable
boolean
events
Array of strings
id
integer <int64>
plan
string
planTemplate
string
object (BlockProgrammeDTO)
series
string
startDate
string <date-time>
title
string

Responses

Request samples

Content type
application/json
{
  • "categoryId": "string",
  • "description": "string",
  • "duration": 0,
  • "editable": true,
  • "events": [
    ],
  • "id": 0,
  • "plan": "string",
  • "planTemplate": "string",
  • "programme": {
    },
  • "series": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "title": "string"
}

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "categoryId": "string",
  • "description": "string",
  • "duration": 0,
  • "editable": true,
  • "programme": {
    },
  • "startDate": "2019-08-24T14:15:22Z",
  • "title": "string"
}

putItemResource-planblock-put

update-planblock

path Parameters
id
required
string
Request Body schema: application/json
required
categoryId
string
description
string
duration
integer <int64>
editable
boolean
events
Array of strings
id
integer <int64>
plan
string
planTemplate
string
object (BlockProgrammeDTO)
series
string
startDate
string <date-time>
title
string

Responses

Request samples

Content type
application/json
{
  • "categoryId": "string",
  • "description": "string",
  • "duration": 0,
  • "editable": true,
  • "events": [
    ],
  • "id": 0,
  • "plan": "string",
  • "planTemplate": "string",
  • "programme": {
    },
  • "series": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "title": "string"
}

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "categoryId": "string",
  • "description": "string",
  • "duration": 0,
  • "editable": true,
  • "programme": {
    },
  • "startDate": "2019-08-24T14:15:22Z",
  • "title": "string"
}

plan-block-search-controller

executeSearch-planblock-get

query Parameters
object (Plan)
startDate
string <date-time>
endDate
string <date-time>

Responses

Response samples

Content type
application/hal+json
0
0

executeSearch-planblock-get_1

query Parameters
object (Plan)

Responses

Response samples

Content type
application/hal+json
0
0

executeSearch-planblock-get_2

query Parameters
object (Plan)

Responses

executeSearch-planblock-get_3

query Parameters
id
integer <int64>
object (Plan)

Responses

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "categoryId": "string",
  • "description": "string",
  • "duration": 0,
  • "editable": true,
  • "programme": {
    },
  • "startDate": "2019-08-24T14:15:22Z",
  • "title": "string"
}

executeSearch-planblock-get_4

query Parameters
object (PlanTemplate)

Responses

Response samples

Content type
application/hal+json
{
  • "_embedded": {
    },
  • "_links": {
    }
}

executeSearch-planblock-get_5

query Parameters
object (Plan)

Responses

Response samples

Content type
application/hal+json
{
  • "_embedded": {
    },
  • "_links": {
    }
}

executeSearch-planblock-get_6

query Parameters
object (PlanBlockSeries)

Responses

Response samples

Content type
application/hal+json
{
  • "_embedded": {
    },
  • "_links": {
    }
}

executeSearch-planblock-get_7

query Parameters
planIdFrom
integer <int64>
planIdTo
integer <int64>

Responses

executeSearch-planblock-get_8

query Parameters
categoryId
string
organization
string

Responses

plan-block-property-reference-controller

deletePropertyReference-planblock-delete

delete-planevent-by-planblock-Id

path Parameters
id
required
string

Responses

followPropertyReference-planblock-get_1

get-planevent-by-planblock-Id

path Parameters
id
required
string

Responses

Response samples

Content type
{
  • "_embedded": {
    },
  • "_links": {
    }
}

createPropertyReference-planblock-patch

patch-planevent-by-planblock-Id

path Parameters
id
required
string
Request Body schema:
required
object
object (Links)

Responses

Request samples

Content type
{
  • "_embedded": {
    },
  • "_links": {
    }
}

Response samples

Content type
application/hal+json
{
  • "_embedded": {
    },
  • "_links": {
    }
}

createPropertyReference-planblock-put

update-planevent-by-planblock-Id

path Parameters
id
required
string
Request Body schema:
required
object
object (Links)

Responses

Request samples

Content type
{
  • "_embedded": {
    },
  • "_links": {
    }
}

Response samples

Content type
application/hal+json
{
  • "_embedded": {
    },
  • "_links": {
    }
}

deletePropertyReferenceId-planblock-delete

delete-planevent-by-planblock-Id

path Parameters
id
required
string
propertyId
required
string

Responses

followPropertyReference-planblock-get

get-planevent-by-planblock-Id

path Parameters
id
required
string
propertyId
required
string

Responses

Response samples

Content type
application/hal+json
{
  • "_embedded": {
    },
  • "_links": {
    }
}

deletePropertyReference-planblock-delete_1

delete-plan-by-planblock-Id

path Parameters
id
required
string

Responses

followPropertyReference-planblock-get_2_1

get-plan-by-planblock-Id

path Parameters
id
required
string

Responses

Response samples

Content type
{
  • "_links": {
    },
  • "changedId": 0,
  • "channelId": 0,
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "firstWeekDay": 0,
  • "name": "string",
  • "organization": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "startOfDay": 0,
  • "status": "DRAFT",
  • "timeZone": "string",
  • "version": 0
}

createPropertyReference-planblock-patch_1

patch-plan-by-planblock-Id

path Parameters
id
required
string
Request Body schema:
required
object
object (Links)

Responses

Request samples

Content type
{
  • "_embedded": {
    },
  • "_links": {
    }
}

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "changedId": 0,
  • "channelId": 0,
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "firstWeekDay": 0,
  • "name": "string",
  • "organization": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "startOfDay": 0,
  • "status": "DRAFT",
  • "timeZone": "string",
  • "version": 0
}

createPropertyReference-planblock-put_1

update-plan-by-planblock-Id

path Parameters
id
required
string
Request Body schema:
required
object
object (Links)

Responses

Request samples

Content type
{
  • "_embedded": {
    },
  • "_links": {
    }
}

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "changedId": 0,
  • "channelId": 0,
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "firstWeekDay": 0,
  • "name": "string",
  • "organization": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "startOfDay": 0,
  • "status": "DRAFT",
  • "timeZone": "string",
  • "version": 0
}

deletePropertyReferenceId-planblock-delete_1

delete-plan-by-planblock-Id

path Parameters
id
required
string
propertyId
required
string

Responses

followPropertyReference-planblock-get_2

get-plan-by-planblock-Id

path Parameters
id
required
string
propertyId
required
string

Responses

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "changedId": 0,
  • "channelId": 0,
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "firstWeekDay": 0,
  • "name": "string",
  • "organization": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "startOfDay": 0,
  • "status": "DRAFT",
  • "timeZone": "string",
  • "version": 0
}

deletePropertyReference-planblock-delete_2

delete-plantemplate-by-planblock-Id

path Parameters
id
required
string

Responses

followPropertyReference-planblock-get_3_1

get-plantemplate-by-planblock-Id

path Parameters
id
required
string

Responses

Response samples

Content type
{
  • "_links": {
    },
  • "blockCount": 0,
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "periodFrom": "2019-08-24T14:15:22Z",
  • "periodTo": "2019-08-24T14:15:22Z",
  • "version": 0
}

createPropertyReference-planblock-patch_2

patch-plantemplate-by-planblock-Id

path Parameters
id
required
string
Request Body schema:
required
object
object (Links)

Responses

Request samples

Content type
{
  • "_embedded": {
    },
  • "_links": {
    }
}

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "blockCount": 0,
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "periodFrom": "2019-08-24T14:15:22Z",
  • "periodTo": "2019-08-24T14:15:22Z",
  • "version": 0
}

createPropertyReference-planblock-put_2

update-plantemplate-by-planblock-Id

path Parameters
id
required
string
Request Body schema:
required
object
object (Links)

Responses

Request samples

Content type
{
  • "_embedded": {
    },
  • "_links": {
    }
}

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "blockCount": 0,
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "periodFrom": "2019-08-24T14:15:22Z",
  • "periodTo": "2019-08-24T14:15:22Z",
  • "version": 0
}

deletePropertyReferenceId-planblock-delete_2

delete-plantemplate-by-planblock-Id

path Parameters
id
required
string
propertyId
required
string

Responses

followPropertyReference-planblock-get_3

get-plantemplate-by-planblock-Id

path Parameters
id
required
string
propertyId
required
string

Responses

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "blockCount": 0,
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "periodFrom": "2019-08-24T14:15:22Z",
  • "periodTo": "2019-08-24T14:15:22Z",
  • "version": 0
}

deletePropertyReference-planblock-delete_3

delete-planblockseries-by-planblock-Id

path Parameters
id
required
string

Responses

followPropertyReference-planblock-get_4_1

get-planblockseries-by-planblock-Id

path Parameters
id
required
string

Responses

Response samples

Content type
{
  • "_links": {
    },
  • "configuration": {
    }
}

createPropertyReference-planblock-patch_3

patch-planblockseries-by-planblock-Id

path Parameters
id
required
string
Request Body schema:
required
object
object (Links)

Responses

Request samples

Content type
{
  • "_embedded": {
    },
  • "_links": {
    }
}

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "configuration": {
    }
}

createPropertyReference-planblock-put_3

update-planblockseries-by-planblock-Id

path Parameters
id
required
string
Request Body schema:
required
object
object (Links)

Responses

Request samples

Content type
{
  • "_embedded": {
    },
  • "_links": {
    }
}

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "configuration": {
    }
}

deletePropertyReferenceId-planblock-delete_3

delete-planblockseries-by-planblock-Id

path Parameters
id
required
string
propertyId
required
string

Responses

followPropertyReference-planblock-get_4

get-planblockseries-by-planblock-Id

path Parameters
id
required
string
propertyId
required
string

Responses

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "configuration": {
    }
}

plan-event-entity-controller

getCollectionResource-planevent-get_1

get-planevent

Responses

Response samples

Content type
{
  • "_embedded": {
    },
  • "_links": {
    }
}

postCollectionResource-planevent-post

create-planevent

Request Body schema: application/json
required
object (EventAssetDataDTO)
duration
integer <int64>
eventType
string
Enum: "PRIMARY" "ADVERTISEMENT" "LIVE" "PLACEHOLDER" "BLOCK" "EMERGENCY"
id
integer <int64>
maxExtendedDuration
integer <int64>
mediaId
string
onAirTime
string <date-time>
planBlock
string
som
integer <int64>
timecodeIn
integer <int64>
title
string
version
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "assetData": {
    },
  • "duration": 0,
  • "eventType": "PRIMARY",
  • "id": 0,
  • "maxExtendedDuration": 0,
  • "mediaId": "string",
  • "onAirTime": "2019-08-24T14:15:22Z",
  • "planBlock": "string",
  • "som": 0,
  • "timecodeIn": 0,
  • "title": "string",
  • "version": 0
}

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "assetData": {
    },
  • "duration": 0,
  • "eventType": "PRIMARY",
  • "maxExtendedDuration": 0,
  • "mediaId": "string",
  • "onAirTime": "2019-08-24T14:15:22Z",
  • "som": 0,
  • "timecodeIn": 0,
  • "title": "string",
  • "version": 0
}

deleteItemResource-planevent-delete

delete-planevent

path Parameters
id
required
string

Responses

getItemResource-planevent-get

get-planevent

path Parameters
id
required
string

Responses

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "assetData": {
    },
  • "duration": 0,
  • "eventType": "PRIMARY",
  • "maxExtendedDuration": 0,
  • "mediaId": "string",
  • "onAirTime": "2019-08-24T14:15:22Z",
  • "som": 0,
  • "timecodeIn": 0,
  • "title": "string",
  • "version": 0
}

patchItemResource-planevent-patch

patch-planevent

path Parameters
id
required
string
Request Body schema: application/json
required
object (EventAssetDataDTO)
duration
integer <int64>
eventType
string
Enum: "PRIMARY" "ADVERTISEMENT" "LIVE" "PLACEHOLDER" "BLOCK" "EMERGENCY"
id
integer <int64>
maxExtendedDuration
integer <int64>
mediaId
string
onAirTime
string <date-time>
planBlock
string
som
integer <int64>
timecodeIn
integer <int64>
title
string
version
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "assetData": {
    },
  • "duration": 0,
  • "eventType": "PRIMARY",
  • "id": 0,
  • "maxExtendedDuration": 0,
  • "mediaId": "string",
  • "onAirTime": "2019-08-24T14:15:22Z",
  • "planBlock": "string",
  • "som": 0,
  • "timecodeIn": 0,
  • "title": "string",
  • "version": 0
}

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "assetData": {
    },
  • "duration": 0,
  • "eventType": "PRIMARY",
  • "maxExtendedDuration": 0,
  • "mediaId": "string",
  • "onAirTime": "2019-08-24T14:15:22Z",
  • "som": 0,
  • "timecodeIn": 0,
  • "title": "string",
  • "version": 0
}

putItemResource-planevent-put

update-planevent

path Parameters
id
required
string
Request Body schema: application/json
required
object (EventAssetDataDTO)
duration
integer <int64>
eventType
string
Enum: "PRIMARY" "ADVERTISEMENT" "LIVE" "PLACEHOLDER" "BLOCK" "EMERGENCY"
id
integer <int64>
maxExtendedDuration
integer <int64>
mediaId
string
onAirTime
string <date-time>
planBlock
string
som
integer <int64>
timecodeIn
integer <int64>
title
string
version
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "assetData": {
    },
  • "duration": 0,
  • "eventType": "PRIMARY",
  • "id": 0,
  • "maxExtendedDuration": 0,
  • "mediaId": "string",
  • "onAirTime": "2019-08-24T14:15:22Z",
  • "planBlock": "string",
  • "som": 0,
  • "timecodeIn": 0,
  • "title": "string",
  • "version": 0
}

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "assetData": {
    },
  • "duration": 0,
  • "eventType": "PRIMARY",
  • "maxExtendedDuration": 0,
  • "mediaId": "string",
  • "onAirTime": "2019-08-24T14:15:22Z",
  • "som": 0,
  • "timecodeIn": 0,
  • "title": "string",
  • "version": 0
}

plan-event-search-controller

executeSearch-planevent-get

query Parameters
organization
string

Responses

Response samples

Content type
application/hal+json
{
  • "_embedded": {
    },
  • "_links": {
    }
}

executeSearch-planevent-get_1

query Parameters
eventId
integer <int64>
object (PlanBlock)

Responses

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "assetData": {
    },
  • "duration": 0,
  • "eventType": "PRIMARY",
  • "maxExtendedDuration": 0,
  • "mediaId": "string",
  • "onAirTime": "2019-08-24T14:15:22Z",
  • "som": 0,
  • "timecodeIn": 0,
  • "title": "string",
  • "version": 0
}

plan-event-property-reference-controller

deletePropertyReference-planevent-delete

delete-planblock-by-planevent-Id

path Parameters
id
required
string

Responses

followPropertyReference-planevent-get_1

get-planblock-by-planevent-Id

path Parameters
id
required
string

Responses

Response samples

Content type
{
  • "_links": {
    },
  • "categoryId": "string",
  • "description": "string",
  • "duration": 0,
  • "editable": true,
  • "programme": {
    },
  • "startDate": "2019-08-24T14:15:22Z",
  • "title": "string"
}

createPropertyReference-planevent-patch

patch-planblock-by-planevent-Id

path Parameters
id
required
string
Request Body schema:
required
object
object (Links)

Responses

Request samples

Content type
{
  • "_embedded": {
    },
  • "_links": {
    }
}

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "categoryId": "string",
  • "description": "string",
  • "duration": 0,
  • "editable": true,
  • "programme": {
    },
  • "startDate": "2019-08-24T14:15:22Z",
  • "title": "string"
}

createPropertyReference-planevent-put

update-planblock-by-planevent-Id

path Parameters
id
required
string
Request Body schema:
required
object
object (Links)

Responses

Request samples

Content type
{
  • "_embedded": {
    },
  • "_links": {
    }
}

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "categoryId": "string",
  • "description": "string",
  • "duration": 0,
  • "editable": true,
  • "programme": {
    },
  • "startDate": "2019-08-24T14:15:22Z",
  • "title": "string"
}

deletePropertyReferenceId-planevent-delete

delete-planblock-by-planevent-Id

path Parameters
id
required
string
propertyId
required
string

Responses

followPropertyReference-planevent-get

get-planblock-by-planevent-Id

path Parameters
id
required
string
propertyId
required
string

Responses

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "categoryId": "string",
  • "description": "string",
  • "duration": 0,
  • "editable": true,
  • "programme": {
    },
  • "startDate": "2019-08-24T14:15:22Z",
  • "title": "string"
}

plan-template-entity-controller

getCollectionResource-plantemplate-get_1

get-plantemplate

query Parameters
page
integer >= 0
Default: 0

Zero-based page index (0..N)

size
integer >= 1
Default: 20

The size of the page to be returned

sort
Array of strings

Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

Responses

Response samples

Content type
{
  • "_embedded": {
    },
  • "_links": {
    },
  • "page": {
    }
}

postCollectionResource-plantemplate-post

create-plantemplate

Request Body schema: application/json
required
blockCount
integer <int64>
dateCreated
string <date-time>
dateUpdated
string <date-time>
id
integer <int64>
name
required
string
periodFrom
string <date-time>
periodTo
string <date-time>
plan
string
version
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "blockCount": 0,
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "id": 0,
  • "name": "string",
  • "periodFrom": "2019-08-24T14:15:22Z",
  • "periodTo": "2019-08-24T14:15:22Z",
  • "plan": "string",
  • "version": 0
}

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "blockCount": 0,
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "periodFrom": "2019-08-24T14:15:22Z",
  • "periodTo": "2019-08-24T14:15:22Z",
  • "version": 0
}

deleteItemResource-plantemplate-delete

delete-plantemplate

path Parameters
id
required
string

Responses

getItemResource-plantemplate-get

get-plantemplate

path Parameters
id
required
string

Responses

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "blockCount": 0,
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "periodFrom": "2019-08-24T14:15:22Z",
  • "periodTo": "2019-08-24T14:15:22Z",
  • "version": 0
}

patchItemResource-plantemplate-patch

patch-plantemplate

path Parameters
id
required
string
Request Body schema: application/json
required
blockCount
integer <int64>
dateCreated
string <date-time>
dateUpdated
string <date-time>
id
integer <int64>
name
required
string
periodFrom
string <date-time>
periodTo
string <date-time>
plan
string
version
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "blockCount": 0,
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "id": 0,
  • "name": "string",
  • "periodFrom": "2019-08-24T14:15:22Z",
  • "periodTo": "2019-08-24T14:15:22Z",
  • "plan": "string",
  • "version": 0
}

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "blockCount": 0,
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "periodFrom": "2019-08-24T14:15:22Z",
  • "periodTo": "2019-08-24T14:15:22Z",
  • "version": 0
}

putItemResource-plantemplate-put

update-plantemplate

path Parameters
id
required
string
Request Body schema: application/json
required
blockCount
integer <int64>
dateCreated
string <date-time>
dateUpdated
string <date-time>
id
integer <int64>
name
required
string
periodFrom
string <date-time>
periodTo
string <date-time>
plan
string
version
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "blockCount": 0,
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "id": 0,
  • "name": "string",
  • "periodFrom": "2019-08-24T14:15:22Z",
  • "periodTo": "2019-08-24T14:15:22Z",
  • "plan": "string",
  • "version": 0
}

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "blockCount": 0,
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "periodFrom": "2019-08-24T14:15:22Z",
  • "periodTo": "2019-08-24T14:15:22Z",
  • "version": 0
}

plan-template-search-controller

executeSearch-plantemplate-get

query Parameters
id
integer <int64>
object (Plan)

Responses

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "blockCount": 0,
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "periodFrom": "2019-08-24T14:15:22Z",
  • "periodTo": "2019-08-24T14:15:22Z",
  • "version": 0
}

executeSearch-plantemplate-get_1

query Parameters
object (Plan)

Responses

Response samples

Content type
application/hal+json
{
  • "_embedded": {
    },
  • "_links": {
    }
}

plan-template-property-reference-controller

deletePropertyReference-plantemplate-delete

delete-plan-by-plantemplate-Id

path Parameters
id
required
string

Responses

followPropertyReference-plantemplate-get_1

get-plan-by-plantemplate-Id

path Parameters
id
required
string

Responses

Response samples

Content type
{
  • "_links": {
    },
  • "changedId": 0,
  • "channelId": 0,
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "firstWeekDay": 0,
  • "name": "string",
  • "organization": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "startOfDay": 0,
  • "status": "DRAFT",
  • "timeZone": "string",
  • "version": 0
}

createPropertyReference-plantemplate-patch

patch-plan-by-plantemplate-Id

path Parameters
id
required
string
Request Body schema:
required
object
object (Links)

Responses

Request samples

Content type
{
  • "_embedded": {
    },
  • "_links": {
    }
}

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "changedId": 0,
  • "channelId": 0,
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "firstWeekDay": 0,
  • "name": "string",
  • "organization": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "startOfDay": 0,
  • "status": "DRAFT",
  • "timeZone": "string",
  • "version": 0
}

createPropertyReference-plantemplate-put

update-plan-by-plantemplate-Id

path Parameters
id
required
string
Request Body schema:
required
object
object (Links)

Responses

Request samples

Content type
{
  • "_embedded": {
    },
  • "_links": {
    }
}

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "changedId": 0,
  • "channelId": 0,
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "firstWeekDay": 0,
  • "name": "string",
  • "organization": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "startOfDay": 0,
  • "status": "DRAFT",
  • "timeZone": "string",
  • "version": 0
}

deletePropertyReferenceId-plantemplate-delete

delete-plan-by-plantemplate-Id

path Parameters
id
required
string
propertyId
required
string

Responses

followPropertyReference-plantemplate-get

get-plan-by-plantemplate-Id

path Parameters
id
required
string
propertyId
required
string

Responses

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "changedId": 0,
  • "channelId": 0,
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "firstWeekDay": 0,
  • "name": "string",
  • "organization": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "startOfDay": 0,
  • "status": "DRAFT",
  • "timeZone": "string",
  • "version": 0
}

plan-entity-controller

getCollectionResource-plan-get_1

get-plan

query Parameters
page
integer >= 0
Default: 0

Zero-based page index (0..N)

size
integer >= 1
Default: 20

The size of the page to be returned

sort
Array of strings

Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

Responses

Response samples

Content type
{
  • "_embedded": {
    },
  • "_links": {
    },
  • "page": {
    }
}

postCollectionResource-plan-post

create-plan

Request Body schema: application/json
required
changedId
integer <int64>
channelId
integer <int64>
dateCreated
string <date-time>
dateUpdated
string <date-time>
endDate
string <date-time>
firstWeekDay
integer <int32>
id
integer <int64>
name
required
string
organization
string
startDate
string <date-time>
startOfDay
integer <int64>
status
required
string
Enum: "DRAFT" "COMMITTED" "CHANGED"
timeZone
string
version
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "changedId": 0,
  • "channelId": 0,
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "firstWeekDay": 0,
  • "id": 0,
  • "name": "string",
  • "organization": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "startOfDay": 0,
  • "status": "DRAFT",
  • "timeZone": "string",
  • "version": 0
}

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "changedId": 0,
  • "channelId": 0,
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "firstWeekDay": 0,
  • "name": "string",
  • "organization": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "startOfDay": 0,
  • "status": "DRAFT",
  • "timeZone": "string",
  • "version": 0
}

deleteItemResource-plan-delete

delete-plan

path Parameters
id
required
string

Responses

getItemResource-plan-get

get-plan

path Parameters
id
required
string

Responses

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "changedId": 0,
  • "channelId": 0,
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "firstWeekDay": 0,
  • "name": "string",
  • "organization": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "startOfDay": 0,
  • "status": "DRAFT",
  • "timeZone": "string",
  • "version": 0
}

patchItemResource-plan-patch

patch-plan

path Parameters
id
required
string
Request Body schema: application/json
required
changedId
integer <int64>
channelId
integer <int64>
dateCreated
string <date-time>
dateUpdated
string <date-time>
endDate
string <date-time>
firstWeekDay
integer <int32>
id
integer <int64>
name
required
string
organization
string
startDate
string <date-time>
startOfDay
integer <int64>
status
required
string
Enum: "DRAFT" "COMMITTED" "CHANGED"
timeZone
string
version
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "changedId": 0,
  • "channelId": 0,
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "firstWeekDay": 0,
  • "id": 0,
  • "name": "string",
  • "organization": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "startOfDay": 0,
  • "status": "DRAFT",
  • "timeZone": "string",
  • "version": 0
}

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "changedId": 0,
  • "channelId": 0,
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "firstWeekDay": 0,
  • "name": "string",
  • "organization": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "startOfDay": 0,
  • "status": "DRAFT",
  • "timeZone": "string",
  • "version": 0
}

putItemResource-plan-put

update-plan

path Parameters
id
required
string
Request Body schema: application/json
required
changedId
integer <int64>
channelId
integer <int64>
dateCreated
string <date-time>
dateUpdated
string <date-time>
endDate
string <date-time>
firstWeekDay
integer <int32>
id
integer <int64>
name
required
string
organization
string
startDate
string <date-time>
startOfDay
integer <int64>
status
required
string
Enum: "DRAFT" "COMMITTED" "CHANGED"
timeZone
string
version
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "changedId": 0,
  • "channelId": 0,
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "firstWeekDay": 0,
  • "id": 0,
  • "name": "string",
  • "organization": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "startOfDay": 0,
  • "status": "DRAFT",
  • "timeZone": "string",
  • "version": 0
}

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "changedId": 0,
  • "channelId": 0,
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "firstWeekDay": 0,
  • "name": "string",
  • "organization": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "startOfDay": 0,
  • "status": "DRAFT",
  • "timeZone": "string",
  • "version": 0
}

plan-search-controller

executeSearch-plan-get

query Parameters
id
integer <int64>

Responses

executeSearch-plan-get_1

query Parameters
organization
string

Responses

executeSearch-plan-get_2

query Parameters
changedId
integer <int64>

Responses

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "changedId": 0,
  • "channelId": 0,
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "firstWeekDay": 0,
  • "name": "string",
  • "organization": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "startOfDay": 0,
  • "status": "DRAFT",
  • "timeZone": "string",
  • "version": 0
}

executeSearch-plan-get_3

query Parameters
planId
integer <int64>
organization
string

Responses

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "changedId": 0,
  • "channelId": 0,
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "firstWeekDay": 0,
  • "name": "string",
  • "organization": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "startOfDay": 0,
  • "status": "DRAFT",
  • "timeZone": "string",
  • "version": 0
}

executeSearch-plan-get_4

query Parameters
id
integer <int64>

Responses

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "changedId": 0,
  • "channelId": 0,
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "firstWeekDay": 0,
  • "name": "string",
  • "organization": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "startOfDay": 0,
  • "status": "DRAFT",
  • "timeZone": "string",
  • "version": 0
}

executeSearch-plan-get_5

query Parameters
organization
string

Responses

Response samples

Content type
application/hal+json
{
  • "_embedded": {
    },
  • "_links": {
    }
}

profile-controller

listAllFormsOfMetadata_1

Responses

Response samples

Content type
application/hal+json
{
  • "_links": {
    }
}

descriptor_1_1_1

Responses

Response samples

Content type
No sample

descriptor_1_1_2

Responses

Response samples

Content type
No sample

descriptor_1_1_3

Responses

Response samples

Content type
No sample

descriptor_1_1_4

Responses

Response samples

Content type
No sample

descriptor_1_1_5

Responses

Response samples

Content type
No sample

descriptor_1_1_6

Responses

Response samples

Content type
No sample

descriptor_1_1_7

Responses

Response samples

Content type
No sample

descriptor_1_1_8

Responses

Response samples

Content type
No sample

descriptor_1_1_9

Responses

Response samples

Content type
No sample

descriptor_1_1_10

Responses

Response samples

Content type
No sample

descriptor_1_1_11

Responses

Response samples

Content type
No sample

descriptor_1_1_12

Responses

Response samples

Content type
No sample

descriptor_1_1_13

Responses

Response samples

Content type
No sample

descriptor_1_1_14

Responses

Response samples

Content type
No sample

descriptor_1_1_15

Responses

Response samples

Content type
No sample

descriptor_1_1_16

Responses

Response samples

Content type
No sample

descriptor_1_1_17

Responses

Response samples

Content type
No sample

descriptor_1_1_18

Responses

Response samples

Content type
No sample

descriptor_1_1_19

Responses

Response samples

Content type
No sample

schedule-archive-entity-controller

getCollectionResource-schedulearchive-get_1

get-schedulearchive

query Parameters
page
integer >= 0
Default: 0

Zero-based page index (0..N)

size
integer >= 1
Default: 20

The size of the page to be returned

sort
Array of strings

Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

Responses

Response samples

Content type
{
  • "_embedded": {
    },
  • "_links": {
    },
  • "page": {
    }
}

postCollectionResource-schedulearchive-post

create-schedulearchive

Request Body schema: application/json
required
dateArchived
string <date-time>
id
integer <int64>
xml
string

Responses

Request samples

Content type
application/json
{
  • "dateArchived": "2019-08-24T14:15:22Z",
  • "id": 0,
  • "xml": "string"
}

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "dateArchived": "2019-08-24T14:15:22Z",
  • "xml": "string"
}

deleteItemResource-schedulearchive-delete

delete-schedulearchive

path Parameters
id
required
string

Responses

getItemResource-schedulearchive-get

get-schedulearchive

path Parameters
id
required
string

Responses

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "dateArchived": "2019-08-24T14:15:22Z",
  • "xml": "string"
}

patchItemResource-schedulearchive-patch

patch-schedulearchive

path Parameters
id
required
string
Request Body schema: application/json
required
dateArchived
string <date-time>
id
integer <int64>
xml
string

Responses

Request samples

Content type
application/json
{
  • "dateArchived": "2019-08-24T14:15:22Z",
  • "id": 0,
  • "xml": "string"
}

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "dateArchived": "2019-08-24T14:15:22Z",
  • "xml": "string"
}

putItemResource-schedulearchive-put

update-schedulearchive

path Parameters
id
required
string
Request Body schema: application/json
required
dateArchived
string <date-time>
id
integer <int64>
xml
string

Responses

Request samples

Content type
application/json
{
  • "dateArchived": "2019-08-24T14:15:22Z",
  • "id": 0,
  • "xml": "string"
}

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "dateArchived": "2019-08-24T14:15:22Z",
  • "xml": "string"
}

schedule-changes-entity-controller

getCollectionResource-schedulechanges-get_1

get-schedulechanges

Responses

Response samples

Content type
{
  • "_embedded": {
    },
  • "_links": {
    }
}

postCollectionResource-schedulechanges-post

create-schedulechanges

Request Body schema: application/json
required
dateCreated
string <date-time>
finishDate
string <date-time>
id
integer <int64>
schedule
string
scheduleVersion
integer <int32>
startDate
string <date-time>
userName
string

Responses

Request samples

Content type
application/json
{
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "finishDate": "2019-08-24T14:15:22Z",
  • "id": 0,
  • "schedule": "string",
  • "scheduleVersion": 0,
  • "startDate": "2019-08-24T14:15:22Z",
  • "userName": "string"
}

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "finishDate": "2019-08-24T14:15:22Z",
  • "scheduleVersion": 0,
  • "startDate": "2019-08-24T14:15:22Z",
  • "userName": "string"
}

deleteItemResource-schedulechanges-delete

delete-schedulechanges

path Parameters
id
required
string

Responses

getItemResource-schedulechanges-get

get-schedulechanges

path Parameters
id
required
string

Responses

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "finishDate": "2019-08-24T14:15:22Z",
  • "scheduleVersion": 0,
  • "startDate": "2019-08-24T14:15:22Z",
  • "userName": "string"
}

patchItemResource-schedulechanges-patch

patch-schedulechanges

path Parameters
id
required
string
Request Body schema: application/json
required
dateCreated
string <date-time>
finishDate
string <date-time>
id
integer <int64>
schedule
string
scheduleVersion
integer <int32>
startDate
string <date-time>
userName
string

Responses

Request samples

Content type
application/json
{
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "finishDate": "2019-08-24T14:15:22Z",
  • "id": 0,
  • "schedule": "string",
  • "scheduleVersion": 0,
  • "startDate": "2019-08-24T14:15:22Z",
  • "userName": "string"
}

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "finishDate": "2019-08-24T14:15:22Z",
  • "scheduleVersion": 0,
  • "startDate": "2019-08-24T14:15:22Z",
  • "userName": "string"
}

putItemResource-schedulechanges-put

update-schedulechanges

path Parameters
id
required
string
Request Body schema: application/json
required
dateCreated
string <date-time>
finishDate
string <date-time>
id
integer <int64>
schedule
string
scheduleVersion
integer <int32>
startDate
string <date-time>
userName
string

Responses

Request samples

Content type
application/json
{
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "finishDate": "2019-08-24T14:15:22Z",
  • "id": 0,
  • "schedule": "string",
  • "scheduleVersion": 0,
  • "startDate": "2019-08-24T14:15:22Z",
  • "userName": "string"
}

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "finishDate": "2019-08-24T14:15:22Z",
  • "scheduleVersion": 0,
  • "startDate": "2019-08-24T14:15:22Z",
  • "userName": "string"
}

schedule-changes-search-controller

executeSearch-schedulechanges-get

query Parameters
date
string <date-time>

Responses

Response samples

Content type
application/hal+json
{
  • "_embedded": {
    },
  • "_links": {
    }
}

executeSearch-schedulechanges-get_1

query Parameters
id
integer <int64>
object (Schedule)
userName
string

Responses

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "finishDate": "2019-08-24T14:15:22Z",
  • "scheduleVersion": 0,
  • "startDate": "2019-08-24T14:15:22Z",
  • "userName": "string"
}

schedule-changes-property-reference-controller

deletePropertyReference-schedulechanges-delete

delete-schedule-by-schedulechanges-Id

path Parameters
id
required
string

Responses

followPropertyReference-schedulechanges-get_1

get-schedule-by-schedulechanges-Id

path Parameters
id
required
string

Responses

Response samples

Content type
{
  • "_links": {
    },
  • "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",
  • "deleted": true,
  • "finishDate": "2019-08-24T14:15:22Z",
  • "finiteType": true,
  • "fps": 0,
  • "graphicsProject": "string",
  • "graphicsProjectV2": "string",
  • "loopType": true,
  • "name": "string",
  • "organization": "string",
  • "playlistType": "FINITE",
  • "startDate": "2019-08-24T14:15:22Z",
  • "txdate": "string",
  • "version": 0
}

createPropertyReference-schedulechanges-patch

patch-schedule-by-schedulechanges-Id

path Parameters
id
required
string
Request Body schema:
required
object
object (Links)

Responses

Request samples

Content type
{
  • "_embedded": {
    },
  • "_links": {
    }
}

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "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",
  • "deleted": true,
  • "finishDate": "2019-08-24T14:15:22Z",
  • "finiteType": true,
  • "fps": 0,
  • "graphicsProject": "string",
  • "graphicsProjectV2": "string",
  • "loopType": true,
  • "name": "string",
  • "organization": "string",
  • "playlistType": "FINITE",
  • "startDate": "2019-08-24T14:15:22Z",
  • "txdate": "string",
  • "version": 0
}

createPropertyReference-schedulechanges-put

update-schedule-by-schedulechanges-Id

path Parameters
id
required
string
Request Body schema:
required
object
object (Links)

Responses

Request samples

Content type
{
  • "_embedded": {
    },
  • "_links": {
    }
}

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "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",
  • "deleted": true,
  • "finishDate": "2019-08-24T14:15:22Z",
  • "finiteType": true,
  • "fps": 0,
  • "graphicsProject": "string",
  • "graphicsProjectV2": "string",
  • "loopType": true,
  • "name": "string",
  • "organization": "string",
  • "playlistType": "FINITE",
  • "startDate": "2019-08-24T14:15:22Z",
  • "txdate": "string",
  • "version": 0
}

deletePropertyReferenceId-schedulechanges-delete

delete-schedule-by-schedulechanges-Id

path Parameters
id
required
string
propertyId
required
string

Responses

followPropertyReference-schedulechanges-get

get-schedule-by-schedulechanges-Id

path Parameters
id
required
string
propertyId
required
string

Responses

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "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",
  • "deleted": true,
  • "finishDate": "2019-08-24T14:15:22Z",
  • "finiteType": true,
  • "fps": 0,
  • "graphicsProject": "string",
  • "graphicsProjectV2": "string",
  • "loopType": true,
  • "name": "string",
  • "organization": "string",
  • "playlistType": "FINITE",
  • "startDate": "2019-08-24T14:15:22Z",
  • "txdate": "string",
  • "version": 0
}

schedule-entity-controller

Get schedules

Returns schedules

query Parameters
page
integer >= 0
Default: 0

Zero-based page index (0..N)

size
integer >= 1
Default: 20

The size of the page to be returned

sort
Array of strings

Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

required
object (ScheduleSearch)
organization
string

Organization Id

Responses

Response samples

Content type
{
  • "_embedded": {
    },
  • "_links": {
    },
  • "page": {
    }
}

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>
fps
number
fpsFloat
number <float>
graphicsProject
string
graphicsProjectV2
string
id
integer <int64>
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",
  • "fps": 0,
  • "fpsFloat": 0.1,
  • "graphicsProject": "string",
  • "graphicsProjectV2": "string",
  • "id": 0,
  • "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",
  • "fps": 0,
  • "graphicsProject": "string",
  • "graphicsProjectV2": "string",
  • "id": 0,
  • "name": "string",
  • "organization": "string",
  • "playlistType": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "status": "string",
  • "txdate": "string",
  • "version": 0
}

deleteItemResource-schedule-delete

delete-schedule

path Parameters
id
required
string

Responses

getItemResource-schedule-get

get-schedule

path Parameters
id
required
string

Responses

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "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",
  • "deleted": true,
  • "finishDate": "2019-08-24T14:15:22Z",
  • "finiteType": true,
  • "fps": 0,
  • "graphicsProject": "string",
  • "graphicsProjectV2": "string",
  • "loopType": true,
  • "name": "string",
  • "organization": "string",
  • "playlistType": "FINITE",
  • "startDate": "2019-08-24T14:15:22Z",
  • "txdate": "string",
  • "version": 0
}

patchItemResource-schedule-patch

patch-schedule

path Parameters
id
required
string
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>
deleted
boolean
finishDate
string <date-time>
finiteType
boolean
fps
number
graphicsProject
string
graphicsProjectV2
string
id
integer <int64>
loopType
boolean
name
string
organization
string
playlistType
string
Enum: "FINITE" "LOOP"
startDate
string <date-time>
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",
  • "deleted": true,
  • "finishDate": "2019-08-24T14:15:22Z",
  • "finiteType": true,
  • "fps": 0,
  • "graphicsProject": "string",
  • "graphicsProjectV2": "string",
  • "id": 0,
  • "loopType": true,
  • "name": "string",
  • "organization": "string",
  • "playlistType": "FINITE",
  • "startDate": "2019-08-24T14:15:22Z",
  • "txdate": "string",
  • "version": 0
}

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "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",
  • "deleted": true,
  • "finishDate": "2019-08-24T14:15:22Z",
  • "finiteType": true,
  • "fps": 0,
  • "graphicsProject": "string",
  • "graphicsProjectV2": "string",
  • "loopType": true,
  • "name": "string",
  • "organization": "string",
  • "playlistType": "FINITE",
  • "startDate": "2019-08-24T14:15:22Z",
  • "txdate": "string",
  • "version": 0
}

putItemResource-schedule-put

update-schedule

path Parameters
id
required
string
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>
deleted
boolean
finishDate
string <date-time>
finiteType
boolean
fps
number
graphicsProject
string
graphicsProjectV2
string
id
integer <int64>
loopType
boolean
name
string
organization
string
playlistType
string
Enum: "FINITE" "LOOP"
startDate
string <date-time>
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",
  • "deleted": true,
  • "finishDate": "2019-08-24T14:15:22Z",
  • "finiteType": true,
  • "fps": 0,
  • "graphicsProject": "string",
  • "graphicsProjectV2": "string",
  • "id": 0,
  • "loopType": true,
  • "name": "string",
  • "organization": "string",
  • "playlistType": "FINITE",
  • "startDate": "2019-08-24T14:15:22Z",
  • "txdate": "string",
  • "version": 0
}

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "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",
  • "deleted": true,
  • "finishDate": "2019-08-24T14:15:22Z",
  • "finiteType": true,
  • "fps": 0,
  • "graphicsProject": "string",
  • "graphicsProjectV2": "string",
  • "loopType": true,
  • "name": "string",
  • "organization": "string",
  • "playlistType": "FINITE",
  • "startDate": "2019-08-24T14:15:22Z",
  • "txdate": "string",
  • "version": 0
}

schedule-search-controller

executeSearch-schedule-get

query Parameters
channelId
integer <int64>
organization
string

Responses

Response samples

Content type
application/hal+json
{
  • "_embedded": {
    },
  • "_links": {
    }
}

executeSearch-schedule-get_1

query Parameters
scheduleId
integer <int64>
organization
string
deleted
boolean

Responses

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "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",
  • "deleted": true,
  • "finishDate": "2019-08-24T14:15:22Z",
  • "finiteType": true,
  • "fps": 0,
  • "graphicsProject": "string",
  • "graphicsProjectV2": "string",
  • "loopType": true,
  • "name": "string",
  • "organization": "string",
  • "playlistType": "FINITE",
  • "startDate": "2019-08-24T14:15:22Z",
  • "txdate": "string",
  • "version": 0
}

executeSearch-schedule-get_2

query Parameters
organization
string

Responses

Response samples

Content type
application/hal+json
{
  • "_embedded": {
    },
  • "_links": {
    }
}

executeSearch-schedule-get_3

Responses

Response samples

Content type
application/hal+json
{
  • "_embedded": {
    },
  • "_links": {
    }
}

executeSearch-schedule-get_4

query Parameters
blockId
integer <int64>
organization
string

Responses

Response samples

Content type
application/hal+json
{
  • "_embedded": {
    },
  • "_links": {
    }
}

executeSearch-schedule-get_5

query Parameters
assetIds
Array of strings
organization
string

Responses

Response samples

Content type
application/hal+json
{
  • "_embedded": {
    },
  • "_links": {
    }
}

timeline-block-entity-controller

getCollectionResource-timelineblock-get_1

get-timelineblock

Responses

Response samples

Content type
{
  • "_embedded": {
    },
  • "_links": {
    }
}

postCollectionResource-timelineblock-post

create-timelineblock

Request Body schema: application/json
required
categoryId
string
description
string
duration
required
integer <int64>
editable
boolean
events
Array of strings
id
integer <int64>
planSeriesId
integer <int64>
planned
boolean
object (BlockProgrammeDTO)
startDate
required
string <date-time>
timeline
string
title
required
string

Responses

Request samples

Content type
application/json
{
  • "categoryId": "string",
  • "description": "string",
  • "duration": 0,
  • "editable": true,
  • "events": [
    ],
  • "id": 0,
  • "planSeriesId": 0,
  • "planned": true,
  • "programme": {
    },
  • "startDate": "2019-08-24T14:15:22Z",
  • "timeline": "string",
  • "title": "string"
}

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "categoryId": "string",
  • "description": "string",
  • "duration": 0,
  • "editable": true,
  • "planSeriesId": 0,
  • "planned": true,
  • "programme": {
    },
  • "startDate": "2019-08-24T14:15:22Z",
  • "title": "string"
}

deleteItemResource-timelineblock-delete

delete-timelineblock

path Parameters
id
required
string

Responses

getItemResource-timelineblock-get

get-timelineblock

path Parameters
id
required
string

Responses

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "categoryId": "string",
  • "description": "string",
  • "duration": 0,
  • "editable": true,
  • "planSeriesId": 0,
  • "planned": true,
  • "programme": {
    },
  • "startDate": "2019-08-24T14:15:22Z",
  • "title": "string"
}

patchItemResource-timelineblock-patch

patch-timelineblock

path Parameters
id
required
string
Request Body schema: application/json
required
categoryId
string
description
string
duration
required
integer <int64>
editable
boolean
events
Array of strings
id
integer <int64>
planSeriesId
integer <int64>
planned
boolean
object (BlockProgrammeDTO)
startDate
required
string <date-time>
timeline
string
title
required
string

Responses

Request samples

Content type
application/json
{
  • "categoryId": "string",
  • "description": "string",
  • "duration": 0,
  • "editable": true,
  • "events": [
    ],
  • "id": 0,
  • "planSeriesId": 0,
  • "planned": true,
  • "programme": {
    },
  • "startDate": "2019-08-24T14:15:22Z",
  • "timeline": "string",
  • "title": "string"
}

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "categoryId": "string",
  • "description": "string",
  • "duration": 0,
  • "editable": true,
  • "planSeriesId": 0,
  • "planned": true,
  • "programme": {
    },
  • "startDate": "2019-08-24T14:15:22Z",
  • "title": "string"
}

putItemResource-timelineblock-put

update-timelineblock

path Parameters
id
required
string
Request Body schema: application/json
required
categoryId
string
description
string
duration
required
integer <int64>
editable
boolean
events
Array of strings
id
integer <int64>
planSeriesId
integer <int64>
planned
boolean
object (BlockProgrammeDTO)
startDate
required
string <date-time>
timeline
string
title
required
string

Responses

Request samples

Content type
application/json
{
  • "categoryId": "string",
  • "description": "string",
  • "duration": 0,
  • "editable": true,
  • "events": [
    ],
  • "id": 0,
  • "planSeriesId": 0,
  • "planned": true,
  • "programme": {
    },
  • "startDate": "2019-08-24T14:15:22Z",
  • "timeline": "string",
  • "title": "string"
}

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "categoryId": "string",
  • "description": "string",
  • "duration": 0,
  • "editable": true,
  • "planSeriesId": 0,
  • "planned": true,
  • "programme": {
    },
  • "startDate": "2019-08-24T14:15:22Z",
  • "title": "string"
}

timeline-block-search-controller

executeSearch-timelineblock-get

query Parameters
blockId
integer <int64>
object (Timeline)

Responses

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "categoryId": "string",
  • "description": "string",
  • "duration": 0,
  • "editable": true,
  • "planSeriesId": 0,
  • "planned": true,
  • "programme": {
    },
  • "startDate": "2019-08-24T14:15:22Z",
  • "title": "string"
}

executeSearch-timelineblock-get_1

query Parameters
object (Timeline)

Responses

Response samples

Content type
application/hal+json
{
  • "_embedded": {
    },
  • "_links": {
    }
}

executeSearch-timelineblock-get_2

query Parameters
object (Timeline)
startDateFrom
string <date-time>

Responses

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "categoryId": "string",
  • "description": "string",
  • "duration": 0,
  • "editable": true,
  • "planSeriesId": 0,
  • "planned": true,
  • "programme": {
    },
  • "startDate": "2019-08-24T14:15:22Z",
  • "title": "string"
}

timeline-block-property-reference-controller

deletePropertyReference-timelineblock-delete

delete-timelineevent-by-timelineblock-Id

path Parameters
id
required
string

Responses

followPropertyReference-timelineblock-get_1

get-timelineevent-by-timelineblock-Id

path Parameters
id
required
string

Responses

Response samples

Content type
{
  • "_embedded": {
    },
  • "_links": {
    }
}

createPropertyReference-timelineblock-patch

patch-timelineevent-by-timelineblock-Id

path Parameters
id
required
string
Request Body schema:
required
object
object (Links)

Responses

Request samples

Content type
{
  • "_embedded": {
    },
  • "_links": {
    }
}

Response samples

Content type
application/hal+json
{
  • "_embedded": {
    },
  • "_links": {
    }
}

createPropertyReference-timelineblock-put

update-timelineevent-by-timelineblock-Id

path Parameters
id
required
string
Request Body schema:
required
object
object (Links)

Responses

Request samples

Content type
{
  • "_embedded": {
    },
  • "_links": {
    }
}

Response samples

Content type
application/hal+json
{
  • "_embedded": {
    },
  • "_links": {
    }
}

deletePropertyReferenceId-timelineblock-delete

delete-timelineevent-by-timelineblock-Id

path Parameters
id
required
string
propertyId
required
string

Responses

followPropertyReference-timelineblock-get

get-timelineevent-by-timelineblock-Id

path Parameters
id
required
string
propertyId
required
string

Responses

Response samples

Content type
application/hal+json
{
  • "_embedded": {
    },
  • "_links": {
    }
}

deletePropertyReference-timelineblock-delete_1

delete-timeline-by-timelineblock-Id

path Parameters
id
required
string

Responses

followPropertyReference-timelineblock-get_2_1

get-timeline-by-timelineblock-Id

path Parameters
id
required
string

Responses

Response samples

Content type
{
  • "_links": {
    },
  • "channelId": 0,
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "organization": "string",
  • "version": 0
}

createPropertyReference-timelineblock-patch_1

patch-timeline-by-timelineblock-Id

path Parameters
id
required
string
Request Body schema:
required
object
object (Links)

Responses

Request samples

Content type
{
  • "_embedded": {
    },
  • "_links": {
    }
}

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "channelId": 0,
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "organization": "string",
  • "version": 0
}

createPropertyReference-timelineblock-put_1

update-timeline-by-timelineblock-Id

path Parameters
id
required
string
Request Body schema:
required
object
object (Links)

Responses

Request samples

Content type
{
  • "_embedded": {
    },
  • "_links": {
    }
}

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "channelId": 0,
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "organization": "string",
  • "version": 0
}

deletePropertyReferenceId-timelineblock-delete_1

delete-timeline-by-timelineblock-Id

path Parameters
id
required
string
propertyId
required
string

Responses

followPropertyReference-timelineblock-get_2

get-timeline-by-timelineblock-Id

path Parameters
id
required
string
propertyId
required
string

Responses

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "channelId": 0,
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "organization": "string",
  • "version": 0
}

timeline-event-entity-controller

getCollectionResource-timelineevent-get_1

get-timelineevent

query Parameters
page
integer >= 0
Default: 0

Zero-based page index (0..N)

size
integer >= 1
Default: 20

The size of the page to be returned

sort
Array of strings

Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

Responses

Response samples

Content type
{
  • "_embedded": {
    },
  • "_links": {
    },
  • "page": {
    }
}

postCollectionResource-timelineevent-post

create-timelineevent

Request Body schema: application/json
required
object (EventAssetDataDTO)
object (AudioTransitionDTO)
duration
integer <int64>
eventType
string
Enum: "PRIMARY" "ADVERTISEMENT" "LIVE" "PLACEHOLDER" "BLOCK" "EMERGENCY"
id
integer <int64>
ignoreIncomingScte35Signals
boolean
label
string
locked
boolean
manualEnd
boolean
manualStart
boolean
maxExtendedDuration
integer <int64>
mediaId
string
onAirTime
string <date-time>
Array of objects (PidDTO)
Array of objects (PlayoutSwitchDTO)
object (PrimarySCTESourceSwitchDTO)
object (EventProgrammeDTO)
Array of objects (SCTE35SignalDTO)
object (SCTE35TriggerDTO)
Array of objects (SecondaryEventDTO)
som
integer <int64>
Array of objects (StreamOverrideDTO)
timecodeIn
integer <int64>
timelineBlock
string
title
string
Array of objects (TwitchRPCDTO)
Array of objects (UntimedAdDTO)
version
integer <int32>
Array of objects (VoiceoverDTO)

Responses

Request samples

Content type
application/json
{
  • "assetData": {
    },
  • "audioTransition": {
    },
  • "duration": 0,
  • "eventType": "PRIMARY",
  • "id": 0,
  • "ignoreIncomingScte35Signals": true,
  • "label": "string",
  • "locked": true,
  • "manualEnd": true,
  • "manualStart": true,
  • "maxExtendedDuration": 0,
  • "mediaId": "string",
  • "onAirTime": "2019-08-24T14:15:22Z",
  • "pidOverrides": [
    ],
  • "playoutSwitches": [
    ],
  • "primarySCTESourceSwitch": {
    },
  • "programme": {
    },
  • "scte35Signals": [
    ],
  • "scte35Trigger": {
    },
  • "secondaryEvents": [
    ],
  • "som": 0,
  • "streamOverrides": [
    ],
  • "timecodeIn": 0,
  • "timelineBlock": "string",
  • "title": "string",
  • "twitchRPCList": [
    ],
  • "untimedAds": [
    ],
  • "version": 0,
  • "voiceovers": [
    ]
}

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "assetData": {
    },
  • "audioTransition": {
    },
  • "duration": 0,
  • "eventType": "PRIMARY",
  • "ignoreIncomingScte35Signals": true,
  • "label": "string",
  • "locked": true,
  • "manualEnd": true,
  • "manualStart": true,
  • "maxExtendedDuration": 0,
  • "mediaId": "string",
  • "onAirTime": "2019-08-24T14:15:22Z",
  • "pidOverrides": [
    ],
  • "playoutSwitches": [
    ],
  • "primarySCTESourceSwitch": {
    },
  • "programme": {
    },
  • "scte35Signals": [
    ],
  • "scte35Trigger": {
    },
  • "secondaryEvents": [
    ],
  • "som": 0,
  • "streamOverrides": [
    ],
  • "timecodeIn": 0,
  • "title": "string",
  • "twitchRPCList": [
    ],
  • "untimedAds": [
    ],
  • "version": 0,
  • "voiceovers": [
    ]
}

deleteItemResource-timelineevent-delete

delete-timelineevent

path Parameters
id
required
string

Responses

getItemResource-timelineevent-get

get-timelineevent

path Parameters
id
required
string

Responses

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "assetData": {
    },
  • "audioTransition": {
    },
  • "duration": 0,
  • "eventType": "PRIMARY",
  • "ignoreIncomingScte35Signals": true,
  • "label": "string",
  • "locked": true,
  • "manualEnd": true,
  • "manualStart": true,
  • "maxExtendedDuration": 0,
  • "mediaId": "string",
  • "onAirTime": "2019-08-24T14:15:22Z",
  • "pidOverrides": [
    ],
  • "playoutSwitches": [
    ],
  • "primarySCTESourceSwitch": {
    },
  • "programme": {
    },
  • "scte35Signals": [
    ],
  • "scte35Trigger": {
    },
  • "secondaryEvents": [
    ],
  • "som": 0,
  • "streamOverrides": [
    ],
  • "timecodeIn": 0,
  • "title": "string",
  • "twitchRPCList": [
    ],
  • "untimedAds": [
    ],
  • "version": 0,
  • "voiceovers": [
    ]
}

patchItemResource-timelineevent-patch

patch-timelineevent

path Parameters
id
required
string
Request Body schema: application/json
required
object (EventAssetDataDTO)
object (AudioTransitionDTO)
duration
integer <int64>
eventType
string
Enum: "PRIMARY" "ADVERTISEMENT" "LIVE" "PLACEHOLDER" "BLOCK" "EMERGENCY"
id
integer <int64>
ignoreIncomingScte35Signals
boolean
label
string
locked
boolean
manualEnd
boolean
manualStart
boolean
maxExtendedDuration
integer <int64>
mediaId
string
onAirTime
string <date-time>
Array of objects (PidDTO)
Array of objects (PlayoutSwitchDTO)
object (PrimarySCTESourceSwitchDTO)
object (EventProgrammeDTO)
Array of objects (SCTE35SignalDTO)
object (SCTE35TriggerDTO)
Array of objects (SecondaryEventDTO)
som
integer <int64>
Array of objects (StreamOverrideDTO)
timecodeIn
integer <int64>
timelineBlock
string
title
string
Array of objects (TwitchRPCDTO)
Array of objects (UntimedAdDTO)
version
integer <int32>
Array of objects (VoiceoverDTO)

Responses

Request samples

Content type
application/json
{
  • "assetData": {
    },
  • "audioTransition": {
    },
  • "duration": 0,
  • "eventType": "PRIMARY",
  • "id": 0,
  • "ignoreIncomingScte35Signals": true,
  • "label": "string",
  • "locked": true,
  • "manualEnd": true,
  • "manualStart": true,
  • "maxExtendedDuration": 0,
  • "mediaId": "string",
  • "onAirTime": "2019-08-24T14:15:22Z",
  • "pidOverrides": [
    ],
  • "playoutSwitches": [
    ],
  • "primarySCTESourceSwitch": {
    },
  • "programme": {
    },
  • "scte35Signals": [
    ],
  • "scte35Trigger": {
    },
  • "secondaryEvents": [
    ],
  • "som": 0,
  • "streamOverrides": [
    ],
  • "timecodeIn": 0,
  • "timelineBlock": "string",
  • "title": "string",
  • "twitchRPCList": [
    ],
  • "untimedAds": [
    ],
  • "version": 0,
  • "voiceovers": [
    ]
}

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "assetData": {
    },
  • "audioTransition": {
    },
  • "duration": 0,
  • "eventType": "PRIMARY",
  • "ignoreIncomingScte35Signals": true,
  • "label": "string",
  • "locked": true,
  • "manualEnd": true,
  • "manualStart": true,
  • "maxExtendedDuration": 0,
  • "mediaId": "string",
  • "onAirTime": "2019-08-24T14:15:22Z",
  • "pidOverrides": [
    ],
  • "playoutSwitches": [
    ],
  • "primarySCTESourceSwitch": {
    },
  • "programme": {
    },
  • "scte35Signals": [
    ],
  • "scte35Trigger": {
    },
  • "secondaryEvents": [
    ],
  • "som": 0,
  • "streamOverrides": [
    ],
  • "timecodeIn": 0,
  • "title": "string",
  • "twitchRPCList": [
    ],
  • "untimedAds": [
    ],
  • "version": 0,
  • "voiceovers": [
    ]
}

putItemResource-timelineevent-put

update-timelineevent

path Parameters
id
required
string
Request Body schema: application/json
required
object (EventAssetDataDTO)
object (AudioTransitionDTO)
duration
integer <int64>
eventType
string
Enum: "PRIMARY" "ADVERTISEMENT" "LIVE" "PLACEHOLDER" "BLOCK" "EMERGENCY"
id
integer <int64>
ignoreIncomingScte35Signals
boolean
label
string
locked
boolean
manualEnd
boolean
manualStart
boolean
maxExtendedDuration
integer <int64>
mediaId
string
onAirTime
string <date-time>
Array of objects (PidDTO)
Array of objects (PlayoutSwitchDTO)
object (PrimarySCTESourceSwitchDTO)
object (EventProgrammeDTO)
Array of objects (SCTE35SignalDTO)
object (SCTE35TriggerDTO)
Array of objects (SecondaryEventDTO)
som
integer <int64>
Array of objects (StreamOverrideDTO)
timecodeIn
integer <int64>
timelineBlock
string
title
string
Array of objects (TwitchRPCDTO)
Array of objects (UntimedAdDTO)
version
integer <int32>
Array of objects (VoiceoverDTO)

Responses

Request samples

Content type
application/json
{
  • "assetData": {
    },
  • "audioTransition": {
    },
  • "duration": 0,
  • "eventType": "PRIMARY",
  • "id": 0,
  • "ignoreIncomingScte35Signals": true,
  • "label": "string",
  • "locked": true,
  • "manualEnd": true,
  • "manualStart": true,
  • "maxExtendedDuration": 0,
  • "mediaId": "string",
  • "onAirTime": "2019-08-24T14:15:22Z",
  • "pidOverrides": [
    ],
  • "playoutSwitches": [
    ],
  • "primarySCTESourceSwitch": {
    },
  • "programme": {
    },
  • "scte35Signals": [
    ],
  • "scte35Trigger": {
    },
  • "secondaryEvents": [
    ],
  • "som": 0,
  • "streamOverrides": [
    ],
  • "timecodeIn": 0,
  • "timelineBlock": "string",
  • "title": "string",
  • "twitchRPCList": [
    ],
  • "untimedAds": [
    ],
  • "version": 0,
  • "voiceovers": [
    ]
}

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "assetData": {
    },
  • "audioTransition": {
    },
  • "duration": 0,
  • "eventType": "PRIMARY",
  • "ignoreIncomingScte35Signals": true,
  • "label": "string",
  • "locked": true,
  • "manualEnd": true,
  • "manualStart": true,
  • "maxExtendedDuration": 0,
  • "mediaId": "string",
  • "onAirTime": "2019-08-24T14:15:22Z",
  • "pidOverrides": [
    ],
  • "playoutSwitches": [
    ],
  • "primarySCTESourceSwitch": {
    },
  • "programme": {
    },
  • "scte35Signals": [
    ],
  • "scte35Trigger": {
    },
  • "secondaryEvents": [
    ],
  • "som": 0,
  • "streamOverrides": [
    ],
  • "timecodeIn": 0,
  • "title": "string",
  • "twitchRPCList": [
    ],
  • "untimedAds": [
    ],
  • "version": 0,
  • "voiceovers": [
    ]
}

timeline-event-search-controller

executeSearch-timelineevent-get

query Parameters
organization
string

Responses

Response samples

Content type
application/hal+json
{
  • "_embedded": {
    },
  • "_links": {
    }
}

executeSearch-timelineevent-get_1

query Parameters
eventId
integer <int64>
object (TimelineBlock)

Responses

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "assetData": {
    },
  • "audioTransition": {
    },
  • "duration": 0,
  • "eventType": "PRIMARY",
  • "ignoreIncomingScte35Signals": true,
  • "label": "string",
  • "locked": true,
  • "manualEnd": true,
  • "manualStart": true,
  • "maxExtendedDuration": 0,
  • "mediaId": "string",
  • "onAirTime": "2019-08-24T14:15:22Z",
  • "pidOverrides": [
    ],
  • "playoutSwitches": [
    ],
  • "primarySCTESourceSwitch": {
    },
  • "programme": {
    },
  • "scte35Signals": [
    ],
  • "scte35Trigger": {
    },
  • "secondaryEvents": [
    ],
  • "som": 0,
  • "streamOverrides": [
    ],
  • "timecodeIn": 0,
  • "title": "string",
  • "twitchRPCList": [
    ],
  • "untimedAds": [
    ],
  • "version": 0,
  • "voiceovers": [
    ]
}

executeSearch-timelineevent-get_2

query Parameters
object (Timeline)
endDateFrom
string <date-time>
startDateTo
string <date-time>

Responses

Response samples

Content type
application/hal+json
{
  • "_embedded": {
    },
  • "_links": {
    }
}

executeSearch-timelineevent-get_3

query Parameters
object (Timeline)
onAirTime
string <date-time>

Responses

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "assetData": {
    },
  • "audioTransition": {
    },
  • "duration": 0,
  • "eventType": "PRIMARY",
  • "ignoreIncomingScte35Signals": true,
  • "label": "string",
  • "locked": true,
  • "manualEnd": true,
  • "manualStart": true,
  • "maxExtendedDuration": 0,
  • "mediaId": "string",
  • "onAirTime": "2019-08-24T14:15:22Z",
  • "pidOverrides": [
    ],
  • "playoutSwitches": [
    ],
  • "primarySCTESourceSwitch": {
    },
  • "programme": {
    },
  • "scte35Signals": [
    ],
  • "scte35Trigger": {
    },
  • "secondaryEvents": [
    ],
  • "som": 0,
  • "streamOverrides": [
    ],
  • "timecodeIn": 0,
  • "title": "string",
  • "twitchRPCList": [
    ],
  • "untimedAds": [
    ],
  • "version": 0,
  • "voiceovers": [
    ]
}

executeSearch-timelineevent-get_4

query Parameters
object (Timeline)
endDateFrom
string <date-time>
startDateTo
string <date-time>

Responses

Response samples

Content type
application/hal+json
{
  • "_embedded": {
    },
  • "_links": {
    }
}

timeline-event-property-reference-controller

deletePropertyReference-timelineevent-delete

delete-timelineblock-by-timelineevent-Id

path Parameters
id
required
string

Responses

followPropertyReference-timelineevent-get_1

get-timelineblock-by-timelineevent-Id

path Parameters
id
required
string

Responses

Response samples

Content type
{
  • "_links": {
    },
  • "categoryId": "string",
  • "description": "string",
  • "duration": 0,
  • "editable": true,
  • "planSeriesId": 0,
  • "planned": true,
  • "programme": {
    },
  • "startDate": "2019-08-24T14:15:22Z",
  • "title": "string"
}

createPropertyReference-timelineevent-patch

patch-timelineblock-by-timelineevent-Id

path Parameters
id
required
string
Request Body schema:
required
object
object (Links)

Responses

Request samples

Content type
{
  • "_embedded": {
    },
  • "_links": {
    }
}

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "categoryId": "string",
  • "description": "string",
  • "duration": 0,
  • "editable": true,
  • "planSeriesId": 0,
  • "planned": true,
  • "programme": {
    },
  • "startDate": "2019-08-24T14:15:22Z",
  • "title": "string"
}

createPropertyReference-timelineevent-put

update-timelineblock-by-timelineevent-Id

path Parameters
id
required
string
Request Body schema:
required
object
object (Links)

Responses

Request samples

Content type
{
  • "_embedded": {
    },
  • "_links": {
    }
}

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "categoryId": "string",
  • "description": "string",
  • "duration": 0,
  • "editable": true,
  • "planSeriesId": 0,
  • "planned": true,
  • "programme": {
    },
  • "startDate": "2019-08-24T14:15:22Z",
  • "title": "string"
}

deletePropertyReferenceId-timelineevent-delete

delete-timelineblock-by-timelineevent-Id

path Parameters
id
required
string
propertyId
required
string

Responses

followPropertyReference-timelineevent-get

get-timelineblock-by-timelineevent-Id

path Parameters
id
required
string
propertyId
required
string

Responses

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "categoryId": "string",
  • "description": "string",
  • "duration": 0,
  • "editable": true,
  • "planSeriesId": 0,
  • "planned": true,
  • "programme": {
    },
  • "startDate": "2019-08-24T14:15:22Z",
  • "title": "string"
}

timeline-entity-controller

getCollectionResource-timeline-get_1

get-timeline

query Parameters
page
integer >= 0
Default: 0

Zero-based page index (0..N)

size
integer >= 1
Default: 20

The size of the page to be returned

sort
Array of strings

Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

Responses

Response samples

Content type
{
  • "_embedded": {
    },
  • "_links": {
    },
  • "page": {
    }
}

postCollectionResource-timeline-post

create-timeline

Request Body schema: application/json
required
channelId
integer <int64>
dateCreated
string <date-time>
dateUpdated
string <date-time>
id
integer <int64>
organization
string
version
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "channelId": 0,
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "id": 0,
  • "organization": "string",
  • "version": 0
}

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "channelId": 0,
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "organization": "string",
  • "version": 0
}

deleteItemResource-timeline-delete

delete-timeline

path Parameters
id
required
string

Responses

getItemResource-timeline-get

get-timeline

path Parameters
id
required
string

Responses

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "channelId": 0,
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "organization": "string",
  • "version": 0
}

patchItemResource-timeline-patch

patch-timeline

path Parameters
id
required
string
Request Body schema: application/json
required
channelId
integer <int64>
dateCreated
string <date-time>
dateUpdated
string <date-time>
id
integer <int64>
organization
string
version
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "channelId": 0,
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "id": 0,
  • "organization": "string",
  • "version": 0
}

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "channelId": 0,
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "organization": "string",
  • "version": 0
}

putItemResource-timeline-put

update-timeline

path Parameters
id
required
string
Request Body schema: application/json
required
channelId
integer <int64>
dateCreated
string <date-time>
dateUpdated
string <date-time>
id
integer <int64>
organization
string
version
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "channelId": 0,
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "id": 0,
  • "organization": "string",
  • "version": 0
}

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "channelId": 0,
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "organization": "string",
  • "version": 0
}

timeline-search-controller

executeSearch-timeline-get

query Parameters
channelId
integer <int64>
organizationId
string

Responses

executeSearch-timeline-get_1

query Parameters
organization
string

Responses

executeSearch-timeline-get_2

query Parameters
channelId
integer <int64>

Responses

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "channelId": 0,
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "organization": "string",
  • "version": 0
}

executeSearch-timeline-get_3

query Parameters
channelId
integer <int64>
organization
string

Responses

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "channelId": 0,
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "organization": "string",
  • "version": 0
}

executeSearch-timeline-get_4

query Parameters
timelineId
integer <int64>
organization
string

Responses

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "channelId": 0,
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "organization": "string",
  • "version": 0
}

executeSearch-timeline-get_5

query Parameters
organization
string

Responses

Response samples

Content type
application/hal+json
{
  • "_embedded": {
    },
  • "_links": {
    }
}