logo
API docs by Redocly

Library

Download OpenAPI specification:Download

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

Services

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

Proxy

Proxy API

Returns a list of asset proxies with given asset name

query Parameters
assetName
required
string

Name of the proxy asset

mediaType
Array of strings
Items Enum: "VIDEO" "AUDIO" "SUBTITLE" "IMAGE" "AE_TEMPLATE" "GRAPHICS_PROJECT" "MULTI_MEDIA_CAPTION_PACKAGE" "SIDE_CAR_XML" "SCHEDULE" "COMPLIANCE_RECORDING" "UNKNOWN" "THUMBNAIL_IMAGE" "THUMBNAIL_VIDEO" "FONT"

List of media types to get

generateDownloadUrl
boolean
Default: false

Whether to generate download URL

organization
string

Organization Id

Responses

Create asset file

Creates asset fileData for proxy

query Parameters
organization
required
string
Request Body schema: application/json
required
completeDate
string <date-time>
createDate
string <date-time>
createdBy
string
object (IngestFileDTO)
id
string
ingestAgentId
string
ingestSourceId
string
Array of objects (JournalEntryDTO)
leaseExpires
string <date-time>
leasedBy
string
object (MediaInfoDTO)
object (MediaStoreObjectDTO)
mediaType
string
Enum: "VIDEO" "AUDIO" "SUBTITLE" "IMAGE" "AE_TEMPLATE" "GRAPHICS_PROJECT" "MULTI_MEDIA_CAPTION_PACKAGE" "SIDE_CAR_XML" "SCHEDULE" "COMPLIANCE_RECORDING" "UNKNOWN" "THUMBNAIL_IMAGE" "THUMBNAIL_VIDEO" "FONT"
organizationId
string
object (OriginDTO)
parentId
string
priority
integer <int32>
object (ProcessingInfoDTO)
object
object (QCInfoDTO)
object (IngestFileDTO)
status
string
Enum: "NEW" "PENDING_DOWNLOAD" "DOWNLOADING" "PENDING_QC" "QC" "PENDING_PROCESSING" "PROCESSING" "PENDING_UPLOAD" "UPLOADING" "COMPLETE" "FAILED" "CANCELED"
storageStatus
string
Enum: "AVAILABLE" "ARCHIVED" "ARCHIVING" "RETRIEVING"

Responses

Request samples

Content type
application/json
{
  • "completeDate": "2019-08-24T14:15:22Z",
  • "createDate": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "file": {
    },
  • "id": "string",
  • "ingestAgentId": "string",
  • "ingestSourceId": "string",
  • "journal": [
    ],
  • "leaseExpires": "2019-08-24T14:15:22Z",
  • "leasedBy": "string",
  • "mediaInfo": {
    },
  • "mediaStoreObject": {
    },
  • "mediaType": "VIDEO",
  • "organizationId": "string",
  • "origin": {
    },
  • "parentId": "string",
  • "priority": 0,
  • "processingInfo": {
    },
  • "properties": {
    },
  • "qcInfo": {
    },
  • "source": {
    },
  • "status": "NEW",
  • "storageStatus": "AVAILABLE"
}

Get asset file

Returns asset fileData

path Parameters
proxyId
required
string

File id

query Parameters
organization
string

Organization Id

Responses

Download asset file

Downloads asset fileData

path Parameters
proxyId
required
string

File id

fileName
required
string

File name

query Parameters
organization
string

Organization Id

Responses

Proxies request to actual underlying asset location proxy file

path Parameters
proxyId
required
string

New file data object

query Parameters
organization
string

Organization Id

Responses

Request url to media store

Returns redirect response to media store

path Parameters
proxyId
required
string
query Parameters
organization
string

Organization Id

Responses

Graphics

Graphics objects

Search graphics objects

Returns list of graphics objects according sorting and paging parameters

query Parameters
exclude
Array of strings
required
object (GraphicObjectSearch)
size
long

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

organization
string

Organization Id

Responses

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
}

Creates graphic object record in library

Creates graphic object record in library

query Parameters
organization
required
string
Request Body schema: application/json
required
required
object (GraphicObjectData)
dateCreated
string <date-time>
dateUpdated
string <date-time>
required
object (IngestFileDTO)
fingerprint
string
id
string
required
object (MediaStoreObjectDTO)
name
string
organization
string
processingId
string
templateId
string
version
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "fileData": {
    },
  • "fingerprint": "string",
  • "id": "string",
  • "mediaStoreObject": {
    },
  • "name": "string",
  • "organization": "string",
  • "processingId": "string",
  • "templateId": "string",
  • "version": 0
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "fileData": {
    },
  • "fingerprint": "string",
  • "id": "string",
  • "mediaStoreObject": {
    },
  • "name": "string",
  • "organization": "string",
  • "processingId": "string",
  • "templateId": "string",
  • "version": 0
}

Bulk delete objects

Deletes specified objects

query Parameters
organization
string

Organization Id

Request Body schema: application/json
required
Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

Content type
application/json
[
  • {
    }
]

Download object (url or data) CSV file

Returns CSV file containing URLs or data list

query Parameters
fileName
required
string

File name

organization
string

Organization Id

Responses

Response samples

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

Request object url CSV file generation

Returns link to job in location header

query Parameters
organization
string

Organization Id

Request Body schema: application/json
required
Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

Content type
application/json
{
  • "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"
}

Generates HTML5 preview for graphics object

query Parameters
url
required
string

HTML5 URL

width
required
integer <int32>

Width of preview

height
required
integer <int32>

Height of preview

organization
required
string

Organization Id

Responses

Response samples

Content type
application/json
{ }

Search graphics objects

Returns list of assets according to sorting and paging parameters

query Parameters
exclude
Array of strings
size
long

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

organization
string

Organization Id

Request Body schema: application/json
required
dateCreatedFrom
string <date-time>
dateCreatedTo
string <date-time>
dateUpdatedFrom
string <date-time>
dateUpdatedTo
string <date-time>
object (IngestFileSearch)
ids
Array of strings
name
string
type
string
Enum: "IMAGE" "VIDEO" "AUDIO" "AE_TEMPLATE" "TEXT" "DATA" "GROUP" "ROLLING_TEXT" "MAIN_STREAM" "TRANSFORMATION" "AE_GRAPHICS" "LIVE_PICTURE_IN_PICTURE" "HTML5" "PICTURE_IN_PICTURE"

Responses

Request samples

Content type
application/json
{
  • "dateCreatedFrom": "2019-08-24T14:15:22Z",
  • "dateCreatedTo": "2019-08-24T14:15:22Z",
  • "dateUpdatedFrom": "2019-08-24T14:15:22Z",
  • "dateUpdatedTo": "2019-08-24T14:15:22Z",
  • "fileData": {
    },
  • "ids": [
    ],
  • "name": "string",
  • "type": "IMAGE"
}

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
}

Performs graphic object validation

Returns graphic object validation

query Parameters
objectName
required
string
organization
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "fileData": {
    },
  • "fingerprint": "string",
  • "id": "string",
  • "mediaStoreObject": {
    },
  • "name": "string",
  • "organization": "string",
  • "processingId": "string",
  • "templateId": "string",
  • "version": 0
}

Delete graphics object

Deletes specified graphics object

path Parameters
id
required
string

Graphics object id

query Parameters
organization
string

Organization Id

Responses

Response samples

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

Get graphics object

Returns graphics object found by id

path Parameters
id
required
string

Graphics object id

query Parameters
organization
string

Organization Id

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "fileData": {
    },
  • "fingerprint": "string",
  • "id": "string",
  • "mediaStoreObject": {
    },
  • "name": "string",
  • "organization": "string",
  • "processingId": "string",
  • "templateId": "string",
  • "version": 0
}

Download graphics object

path Parameters
id
required
string

Object id

query Parameters
organization
string

Organization Id

Responses

Response samples

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

Request object url

Returns link to object media store

path Parameters
id
required
string

Object id

query Parameters
organization
string

Organization Id

Responses

Response samples

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

Request object url

Returns link to proxyUrl

path Parameters
id
required
string

Object id

query Parameters
organization
string

Organization Id

Responses

Response samples

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

Search graphics projects

Returns list of graphics projects according sorting and paging parameters

query Parameters
exclude
Array of strings
size
long

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

organization
string

Organization Id

Responses

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
}

Create graphics project

Creates new graphics project

Request Body schema: application/json
required
dateCreated
string <date-time>
dateUpdated
string <date-time>
Array of objects (GraphicsProjectElementDTO)
object (IngestFileDTO)
graphicsProjectId
string
object (MediaStoreObjectDTO)
name
string
version
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "elements": [
    ],
  • "file": {
    },
  • "graphicsProjectId": "string",
  • "mediaStoreObject": {
    },
  • "name": "string",
  • "version": 0
}

Search graphics projects

Returns list of assets according to sorting and paging parameters

query Parameters
exclude
Array of strings
size
long

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

organization
string

Organization Id

Responses

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

Deletes specified graphics project

path Parameters
graphicsProjectName
required
string

Graphics project name

query Parameters
organization
string

Organization Id

Responses

Get graphics project

Returns graphics project found by name

path Parameters
graphicsProjectName
required
string

Graphics project name

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",
  • "elements": [
    ],
  • "file": {
    },
  • "graphicsProjectId": "string",
  • "mediaStoreObject": {
    },
  • "name": "string",
  • "version": 0
}

Generate graphics project media store URL

Returns graphics project media store URL

path Parameters
graphicsProjectName
required
string

Graphics name

query Parameters
organization
string

Organization Id

Responses

Validate graphics project

Returns graphics project validation result

path Parameters
graphicsProjectName
required
string

Graphics project name

query Parameters
organization
string

Organization Id

Responses

Response samples

Content type
application/json
{
  • "graphicsProject": {
    },
  • "graphicsProjectName": "string",
  • "status": "OK"
}

Font

Font API

Get font families

query Parameters
organization
string

Organization Id

Responses

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
}

Bulk delete font families

Deletes specified font families

query Parameters
organization
string

Organization Id

Request Body schema: application/json
required
Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Creates record of font

query Parameters
organization
required
string
Request Body schema: application/json
required
bold
boolean
dateCreated
string <date-time>
dateUpdated
string <date-time>
deletable
boolean
extension
string
family
string
format
string
id
string
object (IngestFileDTO)
italic
boolean
object (MediaStoreObjectDTO)
name
string
organization
string
queueObjectId
string
size
integer <int64>
style
string
version
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "bold": true,
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "deletable": true,
  • "extension": "string",
  • "family": "string",
  • "format": "string",
  • "id": "string",
  • "ingestFileDTO": {
    },
  • "italic": true,
  • "mediaStoreObjectDTO": {
    },
  • "name": "string",
  • "organization": "string",
  • "queueObjectId": "string",
  • "size": 0,
  • "style": "string",
  • "version": 0
}

Response samples

Content type
application/json
{
  • "bold": true,
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "deletable": true,
  • "extension": "string",
  • "family": "string",
  • "format": "string",
  • "id": "string",
  • "ingestFileDTO": {
    },
  • "italic": true,
  • "mediaStoreObjectDTO": {
    },
  • "name": "string",
  • "organization": "string",
  • "queueObjectId": "string",
  • "size": 0,
  • "style": "string",
  • "version": 0
}

Delete font

Deletes specified font

path Parameters
fontFamilyId
required
string

fontFamilyId

query Parameters
organization
string

Organization Id

Responses

Get font family

path Parameters
fontFamilyId
required
string

fontFamilyId

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",
  • "deletable": true,
  • "fonts": [
    ],
  • "id": "string",
  • "name": "string",
  • "organization": "string",
  • "size": 0,
  • "version": 0
}

Download font family zipped

path Parameters
fontFamilyId
required
string

fontFamilyId

query Parameters
organization
string

Organization Id

Responses

Delete font

Deletes specified font

path Parameters
fontFamilyId
required
string

fontFamilyId

fontId
required
string

fontId

query Parameters
organization
string

Organization Id

Responses

Get font families

path Parameters
fontFamilyId
required
string

fontFamilyId

fontId
required
string

fontId

query Parameters
organization
string

Organization Id

Responses

Response samples

Content type
application/json
{
  • "bold": true,
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "deletable": true,
  • "extension": "string",
  • "family": "string",
  • "format": "string",
  • "id": "string",
  • "ingestFileDTO": {
    },
  • "italic": true,
  • "mediaStoreObjectDTO": {
    },
  • "name": "string",
  • "organization": "string",
  • "queueObjectId": "string",
  • "size": 0,
  • "style": "string",
  • "version": 0
}

Download font

path Parameters
fontFamilyId
required
string

fontFamilyId

fontId
required
string

fontId

query Parameters
organization
string

Organization Id

Responses

Asset

Asset resource. Contains API for asset related functionality.

Search assets

Returns list of assets according to specified search, sorting and paging parameters

query Parameters
exclude
Array of strings

Fields to be excluded from result

include
Array of strings

Enter playbackCount as included field to retrieve playback count info in the result

name
string

Substring of asset name

dateCreatedFrom
long

Asset creation date from (Unix Epoch time in milliseconds)

dateCreatedTo
long

Asset creation date to (Unix Epoch time in milliseconds)

dateUpdatedFrom
long

Asset update date from (Unix Epoch time in milliseconds)

dateUpdatedTo
long

Asset update date to (Unix Epoch time in milliseconds)

fileCountFrom
long

Asset number of files from

fileCountTo
long

Asset number of files to

metadata.audioTrackCountFrom
long

Asset count of audio tracks from

metadata.audioTrackCountTo
long

Asset count of audio tracks to

metadata.subtitleFileCountFrom
long

Asset count of subtitles from

metadata.subtitleFileCountTo
long

Asset count of subtitles to

qcInfo.qcStatuses
string

Asset overall status (OK|UNKNOWN|FAILED|WARNING)

assetIds
string

Set of assetIds

tags
string

Set of tags assigned to asset

excludingTags
string

Set of tags not assigned to asset

fileData.videoExists
boolean

Asset contains video file

fileData.createDateFrom
long

Asset file ingest start date from (Unix Epoch time in milliseconds)

fileData.createDateTo
long

Asset file ingest start date to (Unix Epoch time in milliseconds)

fileData.completeDateFrom
long

Asset file ingest finish date from (Unix Epoch time in milliseconds)

fileData.completeDateTo
long

Asset file ingest finish date to (Unix Epoch time in milliseconds)

fileData.file.fileName
string

Substring of asset essence fileName

fileData.file.fileSizeFrom
long

Asset essence file size from

fileData.file.fileSizeTo
long

Asset essence file size from

fileData.mediaInfo.durationFrom
long

Asset essence file duration from

fileData.mediaInfo.durationTo
long

Asset essence file duration to

fileData.mediaType
string

Asset essence file media type (VIDEO|AUDIO|SUBTITLE|GRAPHICS_PROJECT|UNKNOWN)

systemFields.seriesName
string

Case insensitive asset series name

systemFields.partOfSeries
boolean

Asset is/isn't part of series

customFields
string

Case insensitive custom metadata field search. Empty value field will be checked for existence in asset. Example: customFields[field1]=value&customFields[field2]=

size
long

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

organization
string

Organization Id

Responses

Response samples

Content type
application/json
[
  • {
    }
]

createAsset

query Parameters
organization
required
string
Request Body schema: application/json
required
object
duration
integer <int64>
folderId
string
name
string
object (AssetSystemFieldsDTO)
Array of objects (TagDTO) unique

Responses

Request samples

Content type
application/json
{
  • "customFields": {
    },
  • "duration": 0,
  • "folderId": "string",
  • "name": "string",
  • "systemFields": {
    },
  • "tags": [
    ]
}

Response samples

Content type
application/json
{
  • "assetId": "string",
  • "assetSize": 0,
  • "completeAssetSize": 0,
  • "customFields": {
    },
  • "dateApplied": "2019-08-24T14:15:22Z",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "fileCount": 0,
  • "fileData": [
    ],
  • "folderId": "string",
  • "metadata": {
    },
  • "name": "string",
  • "playbackCount": 0,
  • "qcInfo": {
    },
  • "sourceAssetData": {
    },
  • "storageType": "ARCHIVED",
  • "systemFields": {
    },
  • "tags": [
    ],
  • "version": 0
}

Performs asset cleanup job

Removes all assets that are not used in any playlist or channel

Responses

Response samples

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

Create asset custom fields

Returns location of asset custom fields

query Parameters
assetName
required
string
organization
required
string
Request Body schema: application/json
required
property name*
additional property
string

Responses

Request samples

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

Response samples

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

Bulk delete assets

Deletes specified assets

query Parameters
organization
string

Organization Id

Request Body schema: application/json
required
Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

Content type
application/json
[
  • {
    }
]

devLogOff

Responses

Response samples

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

devLogOn

Responses

Response samples

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

Download asset (url or data) CSV file

Returns CSV file containing URLs or data list

query Parameters
fileName
required
string

File name

organization
string

Organization Id

Responses

Response samples

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

Asset search export

Returns CSV file of assets according to specified search and sorting parameters

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

organization
string

Organization Id

Request Body schema: application/json
required
allFolders
boolean
assetIds
Array of strings unique
assetName
string
assetSizeFrom
integer <int64>
assetSizeTo
integer <int64>
object (CombinedSearch)
object
dateCreatedFrom
string <date-time>
dateCreatedTo
string <date-time>
dateUpdatedFrom
string <date-time>
dateUpdatedTo
string <date-time>
excludingTags
Array of strings unique
object
fieldOrder
Array of strings
fileCountFrom
integer <int32>
fileCountTo
integer <int32>
object (FileDataSearch)
folderId
string
object (AssetMetadataSearch)
name
string
object (QCInfoSearch)
searchInSubFolders
boolean
object (AssetSystemFieldsSearch)
tags
Array of strings unique

Responses

Request samples

Content type
application/json
{
  • "allFolders": true,
  • "assetIds": [
    ],
  • "assetName": "string",
  • "assetSizeFrom": 0,
  • "assetSizeTo": 0,
  • "combinedSearch": {
    },
  • "customFields": {
    },
  • "dateCreatedFrom": "2019-08-24T14:15:22Z",
  • "dateCreatedTo": "2019-08-24T14:15:22Z",
  • "dateUpdatedFrom": "2019-08-24T14:15:22Z",
  • "dateUpdatedTo": "2019-08-24T14:15:22Z",
  • "excludingTags": [
    ],
  • "fieldNames": {
    },
  • "fieldOrder": [
    ],
  • "fileCountFrom": 0,
  • "fileCountTo": 0,
  • "fileData": {
    },
  • "folderId": "string",
  • "metadata": {
    },
  • "name": "string",
  • "qcInfo": {
    },
  • "searchInSubFolders": true,
  • "systemFields": {
    },
  • "tags": [
    ]
}

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

Request asset url CSV file generation

Returns link to job in location header

query Parameters
organization
string

Organization Id

Request Body schema: application/json
Array
string

Responses

Request samples

Content type
application/json
[
  • "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"
}

Download asset (url or data) CSV file Deprecated

Returns CSV file containing URLs or data list

path Parameters
fileName
required
string

File name

query Parameters
organization
string

Organization Id

Responses

Response samples

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

Create file data

Creates file data for specified asset

query Parameters
assetName
required
string
organization
required
string
Request Body schema: application/json
required
completeDate
string <date-time>
createDate
string <date-time>
createdBy
string
object (IngestFileDTO)
id
string
ingestAgentId
string
ingestSourceId
string
Array of objects (JournalEntryDTO)
leaseExpires
string <date-time>
leasedBy
string
object (MediaInfoDTO)
object (MediaStoreObjectDTO)
mediaType
string
Enum: "VIDEO" "AUDIO" "SUBTITLE" "IMAGE" "AE_TEMPLATE" "GRAPHICS_PROJECT" "MULTI_MEDIA_CAPTION_PACKAGE" "SIDE_CAR_XML" "SCHEDULE" "COMPLIANCE_RECORDING" "UNKNOWN" "THUMBNAIL_IMAGE" "THUMBNAIL_VIDEO" "FONT"
organizationId
string
object (OriginDTO)
parentId
string
priority
integer <int32>
object (ProcessingInfoDTO)
object
object (QCInfoDTO)
object (IngestFileDTO)
status
string
Enum: "NEW" "PENDING_DOWNLOAD" "DOWNLOADING" "PENDING_QC" "QC" "PENDING_PROCESSING" "PROCESSING" "PENDING_UPLOAD" "UPLOADING" "COMPLETE" "FAILED" "CANCELED"
storageStatus
string
Enum: "AVAILABLE" "ARCHIVED" "ARCHIVING" "RETRIEVING"

Responses

Request samples

Content type
application/json
{
  • "completeDate": "2019-08-24T14:15:22Z",
  • "createDate": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "file": {
    },
  • "id": "string",
  • "ingestAgentId": "string",
  • "ingestSourceId": "string",
  • "journal": [
    ],
  • "leaseExpires": "2019-08-24T14:15:22Z",
  • "leasedBy": "string",
  • "mediaInfo": {
    },
  • "mediaStoreObject": {
    },
  • "mediaType": "VIDEO",
  • "organizationId": "string",
  • "origin": {
    },
  • "parentId": "string",
  • "priority": 0,
  • "processingInfo": {
    },
  • "properties": {
    },
  • "qcInfo": {
    },
  • "source": {
    },
  • "status": "NEW",
  • "storageStatus": "AVAILABLE"
}

Response samples

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

Bulk update asset folder

Returns list of assets

Request Body schema: application/json
required
assetIds
Array of strings
folderId
string

Responses

Request samples

Content type
application/json
{
  • "assetIds": [
    ],
  • "folderId": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Invalidate all asset cache

query Parameters
organization
required
string

Responses

Response samples

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

Create asset metadata

Returns location of asset metadata

query Parameters
assetName
required
string
organization
required
string
Request Body schema: application/json
required
aspectRatio
string
audioTrackCount
integer <int32>
audioTrackLanguages
Array of strings
durationInFrames
integer
durationInMilliseconds
integer <int64>
firstFrameTime
integer <int64>
fps
number <float>
resolution
string
subtitleFileCount
integer <int32>
subtitleLanguages
Array of strings
videoCodec
string

Responses

Request samples

Content type
application/json
{
  • "aspectRatio": "string",
  • "audioTrackCount": 0,
  • "audioTrackLanguages": [
    ],
  • "durationInFrames": 0,
  • "durationInMilliseconds": 0,
  • "firstFrameTime": 0,
  • "fps": 0.1,
  • "resolution": "string",
  • "subtitleFileCount": 0,
  • "subtitleLanguages": [
    ],
  • "videoCodec": "string"
}

Response samples

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

Generate asset preview multimedia playlist

Returns .m3u8 file for asset preview

query Parameters
assetName
required
string

Asset name

organization
string

Organization Id

Responses

Response samples

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

Bulk override asset QC Status

query Parameters
organization
string

Organization Id

Request Body schema: application/json
required
assetIds
Array of strings
assetNames
Array of strings
rule
string
status
string
Enum: "UNKNOWN" "FAILED" "WARNING" "OK"
text
string

Responses

Request samples

Content type
application/json
{
  • "assetIds": [
    ],
  • "assetNames": [
    ],
  • "rule": "string",
  • "status": "UNKNOWN",
  • "text": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Recalculate QC Info running all rules for organization assets

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

Get scheduled asset file names

Returns map of asset file names

query Parameters
organization
required
string

Responses

Response samples

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

Search assets

Returns list of assets according to specified search, sorting and paging parameters

query Parameters
exclude
Array of strings

Fields to be excluded from the result

include
Array of strings

Enter playbackCount as included field to retrieve playback count info in the result

size
long

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

organization
string

Organization Id

Request Body schema: application/json
required
allFolders
boolean
assetIds
Array of strings unique
assetName
string
assetSizeFrom
integer <int64>
assetSizeTo
integer <int64>
object (CombinedSearch)
object
dateCreatedFrom
string <date-time>
dateCreatedTo
string <date-time>
dateUpdatedFrom
string <date-time>
dateUpdatedTo
string <date-time>
excludingTags
Array of strings unique
fileCountFrom
integer <int32>
fileCountTo
integer <int32>
object (FileDataSearch)
folderId
string
object (AssetMetadataSearch)
name
string
object (QCInfoSearch)
searchInSubFolders
boolean
object (AssetSystemFieldsSearch)
tags
Array of strings unique

Responses

Request samples

Content type
application/json
{
  • "allFolders": true,
  • "assetIds": [
    ],
  • "assetName": "string",
  • "assetSizeFrom": 0,
  • "assetSizeTo": 0,
  • "combinedSearch": {
    },
  • "customFields": {
    },
  • "dateCreatedFrom": "2019-08-24T14:15:22Z",
  • "dateCreatedTo": "2019-08-24T14:15:22Z",
  • "dateUpdatedFrom": "2019-08-24T14:15:22Z",
  • "dateUpdatedTo": "2019-08-24T14:15:22Z",
  • "excludingTags": [
    ],
  • "fileCountFrom": 0,
  • "fileCountTo": 0,
  • "fileData": {
    },
  • "folderId": "string",
  • "metadata": {
    },
  • "name": "string",
  • "qcInfo": {
    },
  • "searchInSubFolders": true,
  • "systemFields": {
    },
  • "tags": [
    ]
}

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
}

Search assets

Returns map of asset name and custom fields map

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

Get assets grouped by series

Returns list of asset series

query Parameters
required
object (Pageable)
term
string

Series name to match

organization
string

Organization Id

Responses

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
}

Get assets Deprecated

Returns assets found by search criteria

query Parameters
organization
required
string

Responses

Response samples

Content type
application/json
{
  • "audios": 0,
  • "fonts": 0,
  • "graphicsObjects": 0,
  • "graphicsProjects": 0,
  • "multimediaCaptionPackages": 0,
  • "subtitles": 0,
  • "totalAssetSize": 0,
  • "totalAssets": 0,
  • "totalComplianceRecordingSize": 0,
  • "totalComplianceRecordings": 0,
  • "videos": 0
}

Synchronizes assets from external library by removing/adding them to Nimbus database

query Parameters
organization
string

Organization Id

Responses

Response samples

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

Synchronizes asset versions

query Parameters
organization
required
string
Request Body schema: application/json
required
additional property
object (AssetSyncDTO)

Responses

Request samples

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

Response samples

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

Create system fields

Returns location of asset system fields

query Parameters
assetName
required
string
organization
required
string
Request Body schema: application/json
required
eom
integer <int64>
epgRelevant
boolean
episodeNumber
integer <int32>
houseId
string
object (RecordingInfo)
seasonNumber
integer <int32>
seriesName
string
som
integer <int64>
splitPartOffsets
Array of integers <int64> [ items <int64 > ]
timecodeIn
integer <int64>
title
string
trimmable
boolean

Responses

Request samples

Content type
application/json
{
  • "eom": 0,
  • "epgRelevant": true,
  • "episodeNumber": 0,
  • "houseId": "string",
  • "recordingInfo": {
    },
  • "seasonNumber": 0,
  • "seriesName": "string",
  • "som": 0,
  • "splitPartOffsets": [
    ],
  • "timecodeIn": 0,
  • "title": "string",
  • "trimmable": true
}

Response samples

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

Search asset series

Returns list of asset series

query Parameters
seriesName
string

Substring of asset series name

organization
string

Organization Id

Responses

Response samples

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

Tag multiple assets

query Parameters
organization
string

Organization Id

Request Body schema: application/json
required
additional property
object (BulkAssetTags)

Responses

Request samples

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

Response samples

Content type
application/json
[
  • {
    }
]

Tag asset

Sets tags for asset

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

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

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

Removes tag from all assets in organization Deprecated

Removes tag from all assets in organization

path Parameters
tag
required
string
query Parameters
organization
required
string

Responses

Response samples

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

retrieveAllAssetFromArchive

query Parameters
organization
required
string

Responses

Response samples

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

Validate asset

Returns asset validation result

query Parameters
assetName
required
string

Asset name

organization
string

Organization Id

Responses

Response samples

Content type
application/json
{
  • "asset": {
    },
  • "assetName": "string",
  • "audioFileNumber": 0,
  • "imageFileNumber": 0,
  • "noCache": true,
  • "status": "OK",
  • "storageType": "ARCHIVED",
  • "subtitleFileNumber": 0,
  • "videoFileNumber": 0
}

Delete asset

Deletes specified asset

path Parameters
assetId
required
string

Asset Id

query Parameters
organization
string

Organization Id

Responses

Response samples

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

Get asset

Returns asset found by id

path Parameters
assetId
required
string

Asset Id

query Parameters
organization
string

Organization Id

Responses

Response samples

Content type
application/json
{
  • "assetId": "string",
  • "assetSize": 0,
  • "customFields": {
    },
  • "dateApplied": "2019-08-24T14:15:22Z",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "fileCount": 0,
  • "fileData": [
    ],
  • "metadata": {
    },
  • "name": "string",
  • "qcInfo": {
    },
  • "sourceAssetData": {
    },
  • "storageType": "ARCHIVED",
  • "systemFields": {
    },
  • "tags": [
    ],
  • "version": 0
}

Get asset custom metadata fields

Returns asset custom metadata fields

path Parameters
assetId
required
string

Asset Id

query Parameters
organization
string

Organization Id

Responses

Response samples

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

Update asset custom metadata fields

path Parameters
assetId
required
string

Asset Id

query Parameters
version
required
integer <int32>

Current asset version. Required for parallel update conflict resolution

organization
string

Organization Id

Request Body schema: application/json
required
property name*
additional property
string

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "assetId": "string",
  • "assetSize": 0,
  • "completeAssetSize": 0,
  • "customFields": {
    },
  • "dateApplied": "2019-08-24T14:15:22Z",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "fileCount": 0,
  • "fileData": [
    ],
  • "folderId": "string",
  • "metadata": {
    },
  • "name": "string",
  • "playbackCount": 0,
  • "qcInfo": {
    },
  • "sourceAssetData": {
    },
  • "storageType": "ARCHIVED",
  • "systemFields": {
    },
  • "tags": [
    ],
  • "version": 0
}

Delete asset file

Deletes specified asset files

path Parameters
assetId
required
string

Asset Id

query Parameters
organization
string

Organization Id

Request Body schema: application/json
required
Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

Content type
application/json
{
  • "assetId": "string",
  • "assetSize": 0,
  • "completeAssetSize": 0,
  • "customFields": {
    },
  • "dateApplied": "2019-08-24T14:15:22Z",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "fileCount": 0,
  • "fileData": [
    ],
  • "folderId": "string",
  • "metadata": {
    },
  • "name": "string",
  • "playbackCount": 0,
  • "qcInfo": {
    },
  • "sourceAssetData": {
    },
  • "storageType": "ARCHIVED",
  • "systemFields": {
    },
  • "tags": [
    ],
  • "version": 0
}

Get asset file

Returns asset file data

path Parameters
assetId
required
string

Asset Id

fileDataId
required
string

File Id

query Parameters
organization
string

Organization Id

Responses

Response samples

Content type
application/json
{
  • "completeDate": "2019-08-24T14:15:22Z",
  • "createDate": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "file": {
    },
  • "id": "string",
  • "ingestAgentId": "string",
  • "ingestSourceId": "string",
  • "journal": [
    ],
  • "leaseExpires": "2019-08-24T14:15:22Z",
  • "leasedBy": "string",
  • "mediaInfo": {
    },
  • "mediaStoreObject": {
    },
  • "mediaType": "VIDEO",
  • "organizationId": "string",
  • "origin": {
    },
  • "parentId": "string",
  • "priority": 0,
  • "processingInfo": {
    },
  • "properties": {
    },
  • "qcInfo": {
    },
  • "source": {
    },
  • "status": "NEW",
  • "storageStatus": "AVAILABLE"
}

Download asset file

Returns asset file data from media store

path Parameters
assetId
required
string

Asset Id

fileDataId
required
string

File data id

query Parameters
fileName
required
string

File name

organization
string

Organization Id

Responses

Response samples

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

Get asset file url

Returns asset file url from media store

path Parameters
assetId
required
string

Asset Id

fileDataId
required
string

File id

query Parameters
organization
string

Organization Id

Responses

Response samples

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

Update asset folder

Returns asset

path Parameters
assetId
required
string

Asset Id

query Parameters
version
required
integer <int32>

Current asset version. Required for parallel update conflict resolution

Request Body schema: application/json
required
string

Responses

Request samples

Content type
application/json
"string"

Response samples

Content type
application/json
{
  • "assetId": "string",
  • "assetSize": 0,
  • "completeAssetSize": 0,
  • "customFields": {
    },
  • "dateApplied": "2019-08-24T14:15:22Z",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "fileCount": 0,
  • "fileData": [
    ],
  • "folderId": "string",
  • "metadata": {
    },
  • "name": "string",
  • "playbackCount": 0,
  • "qcInfo": {
    },
  • "sourceAssetData": {
    },
  • "storageType": "ARCHIVED",
  • "systemFields": {
    },
  • "tags": [
    ],
  • "version": 0
}

Get asset metadata

Returns asset metadata

path Parameters
assetId
required
string

Asset Id

query Parameters
organization
string

Organization Id

Responses

Response samples

Content type
application/json
{
  • "aspectRatio": "string",
  • "audioTrackCount": 0,
  • "audioTrackLanguages": [
    ],
  • "durationInFrames": 0,
  • "durationInMilliseconds": 0,
  • "firstFrameTime": 0,
  • "fps": 0.1,
  • "resolution": "string",
  • "subtitleFileCount": 0,
  • "subtitleLanguages": [
    ],
  • "videoCodec": "string"
}

Get asset playback statistics

Returns asset playback statistics

path Parameters
assetId
required
string

Asset Id

query Parameters
organization
string

Organization Id

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Generate asset preview multimedia playlist

Returns .m3u8 file for asset preview

path Parameters
assetId
required
string

Asset Id

query Parameters
organization
string

Organization Id

Responses

Response samples

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

Override asset QC Status

path Parameters
assetId
required
string

Asset Id

query Parameters
organization
string

Organization Id

Request Body schema: application/json
required
rule
string
status
string
Enum: "UNKNOWN" "FAILED" "WARNING" "OK"
text
string

Responses

Request samples

Content type
application/json
{
  • "rule": "string",
  • "status": "UNKNOWN",
  • "text": "string"
}

Response samples

Content type
application/json
{
  • "assetId": "string",
  • "assetSize": 0,
  • "completeAssetSize": 0,
  • "customFields": {
    },
  • "dateApplied": "2019-08-24T14:15:22Z",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "fileCount": 0,
  • "fileData": [
    ],
  • "folderId": "string",
  • "metadata": {
    },
  • "name": "string",
  • "playbackCount": 0,
  • "qcInfo": {
    },
  • "sourceAssetData": {
    },
  • "storageType": "ARCHIVED",
  • "systemFields": {
    },
  • "tags": [
    ],
  • "version": 0
}

Rename asset. Renaming will not affect playlist and channels. Asset name used in events will not change.

path Parameters
assetId
required
string

Asset Id

query Parameters
organization
string

Organization Id

Request Body schema: application/json
required
string

New asset name

Responses

Request samples

Content type
application/json
"string"

Response samples

Content type
application/json
{
  • "assetId": "string",
  • "assetSize": 0,
  • "completeAssetSize": 0,
  • "customFields": {
    },
  • "dateApplied": "2019-08-24T14:15:22Z",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "fileCount": 0,
  • "fileData": [
    ],
  • "folderId": "string",
  • "metadata": {
    },
  • "name": "string",
  • "playbackCount": 0,
  • "qcInfo": {
    },
  • "sourceAssetData": {
    },
  • "storageType": "ARCHIVED",
  • "systemFields": {
    },
  • "tags": [
    ],
  • "version": 0
}

Split asset in virtual copies

path Parameters
assetId
required
string

Asset Id

query Parameters
organization
string

Organization Id

Request Body schema: application/json
required
partSuffix
string
Array of objects (SplitSegmentDTO)

Responses

Request samples

Content type
application/json
{
  • "partSuffix": "string",
  • "segments": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Perorm asset explicit content check

Starts explicit content check using AWS Rekognition, Returns job id

path Parameters
assetId
required
string
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 asset system metadata fields

Returns asset system metadata fields

path Parameters
assetId
required
string

Asset Id

query Parameters
organization
string

Organization Id

Responses

Response samples

Content type
application/json
{
  • "eom": 0,
  • "epgRelevant": true,
  • "episodeNumber": 0,
  • "houseId": "string",
  • "recordingInfo": {
    },
  • "seasonNumber": 0,
  • "seriesName": "string",
  • "som": 0,
  • "splitPartOffsets": [
    ],
  • "timecodeIn": 0,
  • "title": "string",
  • "trimmable": true
}

Update asset system fields

path Parameters
assetId
required
string

Asset Id

query Parameters
version
required
integer <int32>

Current asset version. Required for parallel update conflict resolution

organization
string

Organization Id

Request Body schema: application/json
required
eom
integer <int64>
epgRelevant
boolean
episodeNumber
integer <int32>
houseId
string
object (RecordingInfo)
seasonNumber
integer <int32>
seriesName
string
som
integer <int64>
splitPartOffsets
Array of integers <int64> [ items <int64 > ]
timecodeIn
integer <int64>
title
string
trimmable
boolean

Responses

Request samples

Content type
application/json
{
  • "eom": 0,
  • "epgRelevant": true,
  • "episodeNumber": 0,
  • "houseId": "string",
  • "recordingInfo": {
    },
  • "seasonNumber": 0,
  • "seriesName": "string",
  • "som": 0,
  • "splitPartOffsets": [
    ],
  • "timecodeIn": 0,
  • "title": "string",
  • "trimmable": true
}

Response samples

Content type
application/json
{
  • "assetId": "string",
  • "assetSize": 0,
  • "completeAssetSize": 0,
  • "customFields": {
    },
  • "dateApplied": "2019-08-24T14:15:22Z",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "fileCount": 0,
  • "fileData": [
    ],
  • "folderId": "string",
  • "metadata": {
    },
  • "name": "string",
  • "playbackCount": 0,
  • "qcInfo": {
    },
  • "sourceAssetData": {
    },
  • "storageType": "ARCHIVED",
  • "systemFields": {
    },
  • "tags": [
    ],
  • "version": 0
}

Tag asset

Sets tags for asset

path Parameters
assetId
required
string

Asset Id

query Parameters
version
required
integer <int32>

Current asset version. Required for parallel update conflict resolution

organization
string

Organization Id

Request Body schema: application/json
required
Array
name
string

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "assetId": "string",
  • "assetSize": 0,
  • "completeAssetSize": 0,
  • "customFields": {
    },
  • "dateApplied": "2019-08-24T14:15:22Z",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "fileCount": 0,
  • "fileData": [
    ],
  • "folderId": "string",
  • "metadata": {
    },
  • "name": "string",
  • "playbackCount": 0,
  • "qcInfo": {
    },
  • "sourceAssetData": {
    },
  • "storageType": "ARCHIVED",
  • "systemFields": {
    },
  • "tags": [
    ],
  • "version": 0
}

Get asset image thumbnail

Returns .jpg file for asset thumbnail

path Parameters
assetId
required
string

Asset Id

query Parameters
organization
string

Organization Id

Responses

Response samples

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

Get asset image thumbnail

Returns .jpg file for asset thumbnail

path Parameters
assetId
required
string

Asset Id

query Parameters
organization
string

Organization Id

Responses

Response samples

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

Update asset custom metadata fields and system metadata fields

path Parameters
assetId
required
string

Asset Id

query Parameters
version
required
integer <int32>

Current asset version. Required for parallel update conflict resolution

organization
string

Organization Id

Request Body schema: application/json
required
object
object (AssetSystemFieldsDTO)

Responses

Request samples

Content type
application/json
{
  • "customFields": {
    },
  • "systemFields": {
    }
}

Response samples

Content type
application/json
{
  • "assetId": "string",
  • "assetSize": 0,
  • "completeAssetSize": 0,
  • "customFields": {
    },
  • "dateApplied": "2019-08-24T14:15:22Z",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "fileCount": 0,
  • "fileData": [
    ],
  • "folderId": "string",
  • "metadata": {
    },
  • "name": "string",
  • "playbackCount": 0,
  • "qcInfo": {
    },
  • "sourceAssetData": {
    },
  • "storageType": "ARCHIVED",
  • "systemFields": {
    },
  • "tags": [
    ],
  • "version": 0
}

createFileDataOld Deprecated

path Parameters
assetName
required
string
query Parameters
organization
required
string
Request Body schema: application/json
required
completeDate
string <date-time>
createDate
string <date-time>
createdBy
string
object (IngestFileDTO)
id
string
ingestAgentId
string
ingestSourceId
string
Array of objects (JournalEntryDTO)
leaseExpires
string <date-time>
leasedBy
string
object (MediaInfoDTO)
object (MediaStoreObjectDTO)
mediaType
string
Enum: "VIDEO" "AUDIO" "SUBTITLE" "IMAGE" "AE_TEMPLATE" "GRAPHICS_PROJECT" "MULTI_MEDIA_CAPTION_PACKAGE" "SIDE_CAR_XML" "SCHEDULE" "COMPLIANCE_RECORDING" "UNKNOWN" "THUMBNAIL_IMAGE" "THUMBNAIL_VIDEO" "FONT"
organizationId
string
object (OriginDTO)
parentId
string
priority
integer <int32>
object (ProcessingInfoDTO)
object
object (QCInfoDTO)
object (IngestFileDTO)
status
string
Enum: "NEW" "PENDING_DOWNLOAD" "DOWNLOADING" "PENDING_QC" "QC" "PENDING_PROCESSING" "PROCESSING" "PENDING_UPLOAD" "UPLOADING" "COMPLETE" "FAILED" "CANCELED"
storageStatus
string
Enum: "AVAILABLE" "ARCHIVED" "ARCHIVING" "RETRIEVING"

Responses

Request samples

Content type
application/json
{
  • "completeDate": "2019-08-24T14:15:22Z",
  • "createDate": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "file": {
    },
  • "id": "string",
  • "ingestAgentId": "string",
  • "ingestSourceId": "string",
  • "journal": [
    ],
  • "leaseExpires": "2019-08-24T14:15:22Z",
  • "leasedBy": "string",
  • "mediaInfo": {
    },
  • "mediaStoreObject": {
    },
  • "mediaType": "VIDEO",
  • "organizationId": "string",
  • "origin": {
    },
  • "parentId": "string",
  • "priority": 0,
  • "processingInfo": {
    },
  • "properties": {
    },
  • "qcInfo": {
    },
  • "source": {
    },
  • "status": "NEW",
  • "storageStatus": "AVAILABLE"
}

Response samples

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

downloadFileByName Deprecated

path Parameters
assetName
required
string
fileDataId
required
string
fileName
required
string
query Parameters
organization
required
string

Responses

Response samples

Content type
application/json
{ }

appendAssetTagsOld Deprecated

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

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

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

validateAssetOld Deprecated

path Parameters
assetName
required
string
query Parameters
organization
required
string

Responses

Response samples

Content type
application/json
{
  • "asset": {
    },
  • "assetName": "string",
  • "audioFileNumber": 0,
  • "imageFileNumber": 0,
  • "noCache": true,
  • "status": "OK",
  • "storageType": "ARCHIVED",
  • "subtitleFileNumber": 0,
  • "videoFileNumber": 0
}

Job

Job API

Find jobs

Returns list of jobs by specified search parameters

query Parameters
organization
Array of strings

Organization Id

providerId
string

Provider Id

finished
boolean

Job finished or not

type
string

Job type (ASSET_CSV|GP_CSV|MCP_CSV|ASSET_QC_REFRESH)

status
string

Job status list

userId
string

Job user name

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get job

Returns queued job

path Parameters
jobId
required
string

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

Folders

Folder resource. Contains API for asset folder related functionality.

Get root folders

Returns root folders

query Parameters
organization
required
string
required
object (Sort)
fullTree
boolean
Default: false

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create root folder

Creates root folder

query Parameters
organization
required
string
Request Body schema: application/json
required
dateCreated
string <date-time>
dateUpdated
string <date-time>
id
string
name
string
organization
string
parentId
string
rootId
string

Responses

Request samples

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

Response samples

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

Get folder string paths

Returns folder paths

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": "string",
  • "property2": "string"
}

Get folder

Returns folder

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

Delete folder

Deletes folder

path Parameters
folderId
required
string
query Parameters
organization
required
string
deleteAssets
boolean
Default: false

Responses

Response samples

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

Get folder

Returns folder

path Parameters
folderId
required
string
query Parameters
organization
required
string

Responses

Response samples

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

Create sub folder

Creates sub folder

path Parameters
folderId
required
string
query Parameters
organization
required
string
Request Body schema: application/json
required
dateCreated
string <date-time>
dateUpdated
string <date-time>
id
string
name
string
organization
string
parentId
string
rootId
string

Responses

Request samples

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

Response samples

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

Update folder

Updates folder

path Parameters
folderId
required
string
query Parameters
organization
required
string
Request Body schema: application/json
required
dateCreated
string <date-time>
dateUpdated
string <date-time>
id
string
name
string
organization
string
parentId
string
rootId
string

Responses

Request samples

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

Response samples

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

Move folder

Moves folder

path Parameters
folderId
required
string
query Parameters
organization
required
string

Responses

Response samples

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

Move folder

Moves folder

path Parameters
folderId
required
string
newParentFolderId
required
string
query Parameters
organization
required
string

Responses

Response samples

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

Get folder tree from root to given folder

Returns folder

path Parameters
folderId
required
string
query Parameters
organization
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get sub folders

Returns sub folders

path Parameters
folderId
required
string
query Parameters
organization
required
string
fullTree
boolean
Default: false

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Stratus

Stratus API

Search library assets

query Parameters
term
string
size
long

Number of items per page (defaults to 20)

page
integer

Page number (defaults to 0)

organization
string

Organization Id

Responses

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
}

Validate asset

Returns asset validation result

query Parameters
organization
string

Organization Id

Responses

Response samples

Content type
application/json
{
  • "totalAssetSize": 0,
  • "totalAssets": 0
}

Validate asset

Returns asset validation result

query Parameters
assetId
required
string

Asset Id

organization
string

Organization Id

Responses

Response samples

Content type
application/json
{
  • "asset": {
    },
  • "assetName": "string",
  • "audioFileNumber": 0,
  • "imageFileNumber": 0,
  • "noCache": true,
  • "status": "OK",
  • "storageType": "ARCHIVED",
  • "subtitleFileNumber": 0,
  • "videoFileNumber": 0
}

Search library assets with uploads

query Parameters
term
string
size
long

Number of items per page (defaults to 20)

page
integer

Page number (defaults to 0)

organization
string

Organization Id

Responses

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
}

Get asset by ID

path Parameters
assetId
required
string
query Parameters
organization
string

Organization Id

Responses

Response samples

Content type
application/json
{
  • "assetId": "string",
  • "assetSize": 0,
  • "customFields": {
    },
  • "dateApplied": "2019-08-24T14:15:22Z",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "fileCount": 0,
  • "fileData": [
    ],
  • "metadata": {
    },
  • "name": "string",
  • "qcInfo": {
    },
  • "sourceAssetData": {
    },
  • "storageType": "ARCHIVED",
  • "systemFields": {
    },
  • "tags": [
    ],
  • "version": 0
}

Get asset custom fields by ID

path Parameters
assetId
required
string
query Parameters
organization
string

Organization Id

Responses

Response samples

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

Update stratus asset title

path Parameters
assetId
required
string

Asset Id

query Parameters
version
required
integer <int32>

Asset version

organization
string

Organization Id

Request Body schema: application/json
required
property name*
additional property
string

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "assetId": "string",
  • "assetSize": 0,
  • "customFields": {
    },
  • "dateApplied": "2019-08-24T14:15:22Z",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "fileCount": 0,
  • "fileData": [
    ],
  • "metadata": {
    },
  • "name": "string",
  • "qcInfo": {
    },
  • "sourceAssetData": {
    },
  • "storageType": "ARCHIVED",
  • "systemFields": {
    },
  • "tags": [
    ],
  • "version": 0
}

Multimedia Caption

Multimedia Caption API

Search multimedia packages

Returns list of multimedia packages according sorting and paging parameters

query Parameters
exclude
Array of strings
size
long

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

organization
string

Organization Id

Responses

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
}

Create multimedia package

Creates multimedia package

query Parameters
organization
required
string
Request Body schema: application/json
required
dateCreated
string <date-time>
dateUpdated
string <date-time>
object (IngestFileDTO)
object (MediaStoreObjectDTO)
Array of objects (IngestFileDTO)
name
string
packageId
string
version
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "file": {
    },
  • "mediaStoreObject": {
    },
  • "multimediaFiles": [
    ],
  • "name": "string",
  • "packageId": "string",
  • "version": 0
}

Response samples

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

Generate multimedia package media store URL

Returns multimedia package media store URL

path Parameters
multimediaPackageId
required
string

Package name

query Parameters
organization
string

Organization Id

Responses

Response samples

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

Delete multimedia package

Deletes specified multimedia package

path Parameters
packageName
required
string

Package name

query Parameters
organization
string

Organization Id

Responses

Response samples

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

Get multimedia caption package

Returns multimedia caption package found by name

path Parameters
packageName
required
string

Package name

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",
  • "file": {
    },
  • "mediaStoreObject": {
    },
  • "multimediaFiles": [
    ],
  • "name": "string",
  • "packageId": "string",
  • "version": 0
}

Validate multimedia package

Returns multimedia package validation result

path Parameters
packageName
required
string

multimedia package name

query Parameters
organization
string

Organization Id

Responses

Response samples

Content type
application/json
{
  • "multimediaCaptionPackage": {
    },
  • "multimediaPackageName": "string",
  • "status": "OK"
}

Compliance recording resource

Compliance recording resource

Search Compliance recordings

Returns list of Compliance recordings according to specified search, sorting and paging parameters

query Parameters
exclude
Array of strings

Fields to be excluded from result

name
string

Substring of recording name

playoutName
string

Substring of playout name

playoutId
string

Playout Id

channelName
string

Substring of channel name

channelId
string

Channel id

outputName
string

Substring of output name

periodFrom
long

Recording period from (Unix Epoch time in milliseconds)

periodTo
long

Recording period to (Unix Epoch time in milliseconds)

size
long

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

organization
string

Organization Id

Responses

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

Deletes specified Compliance recordings

query Parameters
organization
string

Organization Id

Request Body schema: application/json
required
Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

Content type
application/json
[
  • {
    }
]

Delete Compliance recordings

Deletes all Compliance recordings

query Parameters
organization
required
string

Responses

Response samples

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

Request compliance url CSV file generation

Returns link to job in location header

query Parameters
organization
string

Organization Id

Request Body schema: application/json
required
Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

Content type
application/json
{
  • "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"
}

Create compliance recording

Creates compliance recording

query Parameters
organization
required
string
Request Body schema: application/json
required
channelId
string
channelName
string
object (QueueObjectDTO)
name
string
outputName
string
playoutId
string
playoutName
string
startTime
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "channelId": "string",
  • "channelName": "string",
  • "fileData": {
    },
  • "name": "string",
  • "outputName": "string",
  • "playoutId": "string",
  • "playoutName": "string",
  • "startTime": "2019-08-24T14:15:22Z"
}

Response samples

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

Search Compliance recordings

Returns list of Compliance recordings according to specified search, sorting and paging parameters

query Parameters
exclude
Array of strings

Fields to be excluded from result

size
long

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

organization
string

Organization Id

Request Body schema: application/json
required
channelId
string
channelName
string
name
string
outputName
string
periodFrom
string <date-time>
periodTo
string <date-time>
playoutId
string
playoutName
string

Responses

Request samples

Content type
application/json
{
  • "channelId": "string",
  • "channelName": "string",
  • "name": "string",
  • "outputName": "string",
  • "periodFrom": "2019-08-24T14:15:22Z",
  • "periodTo": "2019-08-24T14:15:22Z",
  • "playoutId": "string",
  • "playoutName": "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 Compliance recording

Deletes specified Compliance recording

path Parameters
recordingId
required
string

Compliance recording Id

query Parameters
organization
string

Organization Id

Responses

Response samples

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

Get compliance recording

Returns compliance recording found by id

path Parameters
recordingId
required
string

Compliance recording Id

query Parameters
organization
string

Organization Id

Responses

Response samples

Content type
application/json
{
  • "channelId": "string",
  • "channelName": "string",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z",
  • "fileData": [
    ],
  • "id": "string",
  • "metadata": {
    },
  • "name": "string",
  • "outputName": "string",
  • "playoutId": "string",
  • "playoutName": "string",
  • "startTime": "2019-08-24T14:15:22Z",
  • "version": 0
}

Generate Compliance recording preview multimedia playlist

Returns .m3u8 file for recording preview

path Parameters
recordingId
required
string

Compliance recording id

query Parameters
organization
string

Organization Id

Responses

Response samples

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

Graphics Project V2

Graphics Project V2

Search graphics projects

Returns list of graphics projects according sorting and paging parameters

query Parameters
exclude
Array of strings
required
object (GraphicsProjectSearch)
size
long

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

organization
string

Organization Id

Responses

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
}

Create graphics project

Creates graphics project

query Parameters
organization
string

Organization Id

Request Body schema: application/json
required
Array of objects (Channel)
dateCreated
string <date-time>
dateUpdated
string <date-time>
Array of objects (GraphicElementDTO)
height
integer <int32>
id
string
name
string
organization
string
Array of objects (Playout)
serviceProviderId
string
version
integer <int32>
width
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "channels": [
    ],
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "elements": [
    ],
  • "height": 0,
  • "id": "string",
  • "name": "string",
  • "organization": "string",
  • "playouts": [
    ],
  • "serviceProviderId": "string",
  • "version": 0,
  • "width": 0
}

Response samples

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

Get AdWise graphics project template

Returns AdWise graphics project

Responses

Response samples

Content type
application/json
{
  • "active": true,
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "elements": [
    ],
  • "height": 0,
  • "id": "string",
  • "name": "string",
  • "organization": "string",
  • "version": 0,
  • "width": 0
}

Copy from existing project

Returns AdWise graphics project

query Parameters
projectId
required
string
organization
required
string

Responses

Response samples

Content type
application/json
{
  • "active": true,
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "elements": [
    ],
  • "height": 0,
  • "id": "string",
  • "name": "string",
  • "organization": "string",
  • "version": 0,
  • "width": 0
}

Get AdWise graphics project template by id

Returns AdWise graphics project

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "active": true,
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "elements": [
    ],
  • "height": 0,
  • "id": "string",
  • "name": "string",
  • "organization": "string",
  • "version": 0,
  • "width": 0
}

Activate adwise template

Returns AdWise graphics project

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "active": true,
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "elements": [
    ],
  • "height": 0,
  • "id": "string",
  • "name": "string",
  • "organization": "string",
  • "version": 0,
  • "width": 0
}

Get AdWise graphics project template

Returns AdWise graphics project

path Parameters
id
required
string
elementId
required
string

Responses

Response samples

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

Updates adwise template preview image

Updates adwsise template element preview image

path Parameters
id
required
string
elementId
required
string
query Parameters
organization
string

Organization Id

Request Body schema: image/png
required
Array
string <byte>

Responses

Response samples

Content type
application/json
{ }

Get AdWise graphics project templates

Returns AdWise graphics projects

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Download exported Graphics Project file

Download exported Graphics Project file

query Parameters
fileName
required
string

File name

organization
string

Organization Id

Responses

Response samples

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

Search graphics projects

Returns list of graphics projects according sorting and paging parameters

query Parameters
exclude
Array of strings
required
object (GraphicsProjectSearch)
size
long

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

organization
string

Organization Id

Responses

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
}

Create graphics project draft

Creates graphics project draft

query Parameters
organization
string

Organization Id

Request Body schema: application/json
required
Array of objects (Channel)
dateCommitted
string <date-time>
dateCreated
string <date-time>
dateUpdated
string <date-time>
Array of objects (GraphicElementDTO)
graphicProjectId
string
height
integer <int32>
id
string
jsonType
string
name
string
organization
string
Array of objects (Playout)
serviceProviderId
string
status
string
Enum: "DRAFT" "CHANGED" "COMMITTED"
version
integer <int32>
width
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "channels": [
    ],
  • "dateCommitted": "2019-08-24T14:15:22Z",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "elements": [
    ],
  • "graphicProjectId": "string",
  • "height": 0,
  • "id": "string",
  • "jsonType": "string",
  • "name": "string",
  • "organization": "string",
  • "playouts": [
    ],
  • "serviceProviderId": "string",
  • "status": "DRAFT",
  • "version": 0,
  • "width": 0
}

Response samples

Content type
application/json
{
  • "channels": [
    ],
  • "dateCommitted": "2019-08-24T14:15:22Z",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "elements": [
    ],
  • "graphicProjectId": "string",
  • "height": 0,
  • "id": "string",
  • "jsonType": "string",
  • "name": "string",
  • "organization": "string",
  • "playouts": [
    ],
  • "serviceProviderId": "string",
  • "status": "DRAFT",
  • "version": 0,
  • "width": 0
}

Search graphics projects

Returns list of assets according to sorting and paging parameters

query Parameters
exclude
Array of strings
size
long

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

organization
string

Organization Id

Request Body schema: application/json
required
dateCreatedFrom
string <date-time>
dateCreatedTo
string <date-time>
dateUpdatedFrom
string <date-time>
dateUpdatedTo
string <date-time>
term
string

Responses

Request samples

Content type
application/json
{
  • "dateCreatedFrom": "2019-08-24T14:15:22Z",
  • "dateCreatedTo": "2019-08-24T14:15:22Z",
  • "dateUpdatedFrom": "2019-08-24T14:15:22Z",
  • "dateUpdatedTo": "2019-08-24T14:15:22Z",
  • "term": "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 graphics project

Deletes specified graphics project

path Parameters
id
required
string

Graphics project draft id

query Parameters
organization
string

Organization Id

Responses

Response samples

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

Get graphics project draft

Returns graphics project draft found by id

path Parameters
id
required
string

Graphics project draft id

query Parameters
organization
string

Organization Id

Responses

Response samples

Content type
application/json
{
  • "channels": [
    ],
  • "dateCommitted": "2019-08-24T14:15:22Z",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "elements": [
    ],
  • "graphicProjectId": "string",
  • "height": 0,
  • "id": "string",
  • "jsonType": "string",
  • "name": "string",
  • "organization": "string",
  • "playouts": [
    ],
  • "serviceProviderId": "string",
  • "status": "DRAFT",
  • "version": 0,
  • "width": 0
}

Update graphics project draft

Update graphics project draft

path Parameters
id
required
string
query Parameters
organization
string

Organization Id

Request Body schema: application/json
required
Array of objects (Channel)
dateCommitted
string <date-time>
dateCreated
string <date-time>
dateUpdated
string <date-time>
Array of objects (GraphicElementDTO)
graphicProjectId
string
height
integer <int32>
id
string
jsonType
string
name
string
organization
string
Array of objects (Playout)
serviceProviderId
string
status
string
Enum: "DRAFT" "CHANGED" "COMMITTED"
version
integer <int32>
width
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "channels": [
    ],
  • "dateCommitted": "2019-08-24T14:15:22Z",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "elements": [
    ],
  • "graphicProjectId": "string",
  • "height": 0,
  • "id": "string",
  • "jsonType": "string",
  • "name": "string",
  • "organization": "string",
  • "playouts": [
    ],
  • "serviceProviderId": "string",
  • "status": "DRAFT",
  • "version": 0,
  • "width": 0
}

Response samples

Content type
application/json
{
  • "channels": [
    ],
  • "dateCommitted": "2019-08-24T14:15:22Z",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "elements": [
    ],
  • "graphicProjectId": "string",
  • "height": 0,
  • "id": "string",
  • "jsonType": "string",
  • "name": "string",
  • "organization": "string",
  • "playouts": [
    ],
  • "serviceProviderId": "string",
  • "status": "DRAFT",
  • "version": 0,
  • "width": 0
}

Commit graphics project draft

Creates graphics project or updates existing and sends updated version to playouts

path Parameters
id
required
string
query Parameters
organization
string

Organization Id

Responses

Response samples

Content type
application/json
{
  • "channels": [
    ],
  • "dateCommitted": "2019-08-24T14:15:22Z",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "elements": [
    ],
  • "graphicProjectId": "string",
  • "height": 0,
  • "id": "string",
  • "jsonType": "string",
  • "name": "string",
  • "organization": "string",
  • "playouts": [
    ],
  • "serviceProviderId": "string",
  • "status": "DRAFT",
  • "version": 0,
  • "width": 0
}

Duplicate graphics project.

Duplicates specified graphics project

path Parameters
id
required
string
query Parameters
organization
string

Organization Id

Responses

Response samples

Content type
application/json
{
  • "channels": [
    ],
  • "dateCommitted": "2019-08-24T14:15:22Z",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "elements": [
    ],
  • "graphicProjectId": "string",
  • "height": 0,
  • "id": "string",
  • "jsonType": "string",
  • "name": "string",
  • "organization": "string",
  • "playouts": [
    ],
  • "serviceProviderId": "string",
  • "status": "DRAFT",
  • "version": 0,
  • "width": 0
}

Create graphics project draft element

Create graphics project draft element

path Parameters
id
required
string
query Parameters
organization
string

Organization Id

Request Body schema: application/json
required
Array of objects (AnimationDTO)
assetId
string
audio
boolean
object (GraphicAudioPropertiesDTO)
object (BackgroundDTO)
backgroundColor
string
color
string
content
string
contentType
string
Enum: "RSS" "CUSTOM" "ASSET_TITLE"
object (Crawling)
object (Dimensions)

Object dimensions

duration
integer <int64>
fontFamilyId
string
fontFamilyName
string
fontId
string
fontName
string
groupId
string
object (GroupMemberDTO)

Group member

id
string
lineHeight
integer <int32>
liveInputId
string
loop
boolean
mediaId
string
name
string
objectId
string
opacity
number <float>
object (OutlineDTO)
object (Position)

Element position

previewImage
string

Element preview image in base64

Array of objects (GraphicObjectProperties) unique
object (ShadowDTO)
src
string
stratusObject
boolean
textBold
boolean
textFont
string
textFontSize
integer <int32>
textHorizontalAlign
string
Enum: "ALIGN_LEFT" "ALIGN_CENTER" "ALIGN_RIGHT" "ALIGN_JUSTIFY"
textItalic
boolean
textOutline
boolean
textShadow
boolean
textVerticalAlign
string
Enum: "ALIGN_TOP" "ALIGN_MIDDLE" "ALIGN_BOTTOM"
type
string
Enum: "TEXT" "IMAGE" "VIDEO" "ROLLING_TEXT" "MAIN_STREAM" "TRANSFORMATION" "AE_GRAPHICS" "GROUP" "HTML5" "PICTURE_IN_PICTURE" "SUBTITLES" "LIVE_PICTURE_IN_PICTURE" "CRAWLING_TEXT"

Responses

Request samples

Content type
application/json
{
  • "animations": [
    ],
  • "assetId": "string",
  • "audio": true,
  • "audioProperties": {
    },
  • "background": {
    },
  • "backgroundColor": "string",
  • "color": "string",
  • "content": "string",
  • "contentType": "RSS",
  • "crawling": {
    },
  • "dimensions": {
    },
  • "duration": 0,
  • "fontFamilyId": "string",
  • "fontFamilyName": "string",
  • "fontId": "string",
  • "fontName": "string",
  • "groupId": "string",
  • "groupMember": {
    },
  • "id": "string",
  • "lineHeight": 0,
  • "liveInputId": "string",
  • "loop": true,
  • "mediaId": "string",
  • "name": "string",
  • "objectId": "string",
  • "opacity": 0.1,
  • "outline": {
    },
  • "position": {
    },
  • "previewImage": "string",
  • "properties": [
    ],
  • "shadow": {
    },
  • "src": "string",
  • "stratusObject": true,
  • "textBold": true,
  • "textFont": "string",
  • "textFontSize": 0,
  • "textHorizontalAlign": "ALIGN_LEFT",
  • "textItalic": true,
  • "textOutline": true,
  • "textShadow": true,
  • "textVerticalAlign": "ALIGN_TOP",
  • "type": "TEXT"
}

Response samples

Content type
application/json
{
  • "animations": [
    ],
  • "assetId": "string",
  • "audio": true,
  • "audioProperties": {
    },
  • "background": {
    },
  • "backgroundColor": "string",
  • "color": "string",
  • "content": "string",
  • "contentType": "RSS",
  • "crawling": {
    },
  • "dimensions": {
    },
  • "duration": 0,
  • "fontFamilyId": "string",
  • "fontFamilyName": "string",
  • "fontId": "string",
  • "fontName": "string",
  • "groupId": "string",
  • "groupMember": {
    },
  • "id": "string",
  • "lineHeight": 0,
  • "liveInputId": "string",
  • "loop": true,
  • "mediaId": "string",
  • "name": "string",
  • "objectId": "string",
  • "opacity": 0.1,
  • "outline": {
    },
  • "position": {
    },
  • "previewImage": "string",
  • "properties": [
    ],
  • "shadow": {
    },
  • "src": "string",
  • "stratusObject": true,
  • "textBold": true,
  • "textFont": "string",
  • "textFontSize": 0,
  • "textHorizontalAlign": "ALIGN_LEFT",
  • "textItalic": true,
  • "textOutline": true,
  • "textShadow": true,
  • "textVerticalAlign": "ALIGN_TOP",
  • "type": "TEXT"
}

Update graphics project draft elements

Update graphics project draft elements

path Parameters
id
required
string
query Parameters
organization
string

Organization Id

Request Body schema: application/json
required
Array
Array of objects (AnimationDTO)
assetId
string
audio
boolean
object (GraphicAudioPropertiesDTO)
object (BackgroundDTO)
backgroundColor
string
color
string
content
string
contentType
string
Enum: "RSS" "CUSTOM" "ASSET_TITLE"
object (Crawling)
object (Dimensions)

Object dimensions

duration
integer <int64>
fontFamilyId
string
fontFamilyName
string
fontId
string
fontName
string
groupId
string
object (GroupMemberDTO)

Group member

id
string
lineHeight
integer <int32>
liveInputId
string
loop
boolean
mediaId
string
name
string
objectId
string
opacity
number <float>
object (OutlineDTO)
object (Position)

Element position

previewImage
string

Element preview image in base64

Array of objects (GraphicObjectProperties) unique
object (ShadowDTO)
src
string
stratusObject
boolean
textBold
boolean
textFont
string
textFontSize
integer <int32>
textHorizontalAlign
string
Enum: "ALIGN_LEFT" "ALIGN_CENTER" "ALIGN_RIGHT" "ALIGN_JUSTIFY"
textItalic
boolean
textOutline
boolean
textShadow
boolean
textVerticalAlign
string
Enum: "ALIGN_TOP" "ALIGN_MIDDLE" "ALIGN_BOTTOM"
type
string
Enum: "TEXT" "IMAGE" "VIDEO" "ROLLING_TEXT" "MAIN_STREAM" "TRANSFORMATION" "AE_GRAPHICS" "GROUP" "HTML5" "PICTURE_IN_PICTURE" "SUBTITLES" "LIVE_PICTURE_IN_PICTURE" "CRAWLING_TEXT"

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "channels": [
    ],
  • "dateCommitted": "2019-08-24T14:15:22Z",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "elements": [
    ],
  • "graphicProjectId": "string",
  • "height": 0,
  • "id": "string",
  • "jsonType": "string",
  • "name": "string",
  • "organization": "string",
  • "playouts": [
    ],
  • "serviceProviderId": "string",
  • "status": "DRAFT",
  • "version": 0,
  • "width": 0
}

Modify Graphic Elements

Creates, updates, deletes multiple Graphic Elements for draft project

path Parameters
id
required
string
query Parameters
organization
required
string
Request Body schema: application/json
required
Array of objects (GraphicElementDTO)
deleted
Array of strings
Array of objects (GraphicElementDTO)

Responses

Request samples

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

Response samples

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

Delete graphics project draft element

Delete graphics project draft element

path Parameters
id
required
string
elementId
required
string
query Parameters
organization
string

Organization Id

Responses

Response samples

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

Update graphics project draft element

Update graphics project draft element

path Parameters
id
required
string
elementId
required
string
query Parameters
organization
string

Organization Id

Request Body schema: application/json
required
Array of objects (AnimationDTO)
assetId
string
audio
boolean
object (GraphicAudioPropertiesDTO)
object (BackgroundDTO)
backgroundColor
string
color
string
content
string
contentType
string
Enum: "RSS" "CUSTOM" "ASSET_TITLE"
object (Crawling)
object (Dimensions)

Object dimensions

duration
integer <int64>
fontFamilyId
string
fontFamilyName
string
fontId
string
fontName
string
groupId
string
object (GroupMemberDTO)

Group member

id
string
lineHeight
integer <int32>
liveInputId
string
loop
boolean
mediaId
string
name
string
objectId
string
opacity
number <float>
object (OutlineDTO)
object (Position)

Element position

previewImage
string

Element preview image in base64

Array of objects (GraphicObjectProperties) unique
object (ShadowDTO)
src
string
stratusObject
boolean
textBold
boolean
textFont
string
textFontSize
integer <int32>
textHorizontalAlign
string
Enum: "ALIGN_LEFT" "ALIGN_CENTER" "ALIGN_RIGHT" "ALIGN_JUSTIFY"
textItalic
boolean
textOutline
boolean
textShadow
boolean
textVerticalAlign
string
Enum: "ALIGN_TOP" "ALIGN_MIDDLE" "ALIGN_BOTTOM"
type
string
Enum: "TEXT" "IMAGE" "VIDEO" "ROLLING_TEXT" "MAIN_STREAM" "TRANSFORMATION" "AE_GRAPHICS" "GROUP" "HTML5" "PICTURE_IN_PICTURE" "SUBTITLES" "LIVE_PICTURE_IN_PICTURE" "CRAWLING_TEXT"

Responses

Request samples

Content type
application/json
{
  • "animations": [
    ],
  • "assetId": "string",
  • "audio": true,
  • "audioProperties": {
    },
  • "background": {
    },
  • "backgroundColor": "string",
  • "color": "string",
  • "content": "string",
  • "contentType": "RSS",
  • "crawling": {
    },
  • "dimensions": {
    },
  • "duration": 0,
  • "fontFamilyId": "string",
  • "fontFamilyName": "string",
  • "fontId": "string",
  • "fontName": "string",
  • "groupId": "string",
  • "groupMember": {
    },
  • "id": "string",
  • "lineHeight": 0,
  • "liveInputId": "string",
  • "loop": true,
  • "mediaId": "string",
  • "name": "string",
  • "objectId": "string",
  • "opacity": 0.1,
  • "outline": {
    },
  • "position": {
    },
  • "previewImage": "string",
  • "properties": [
    ],
  • "shadow": {
    },
  • "src": "string",
  • "stratusObject": true,
  • "textBold": true,
  • "textFont": "string",
  • "textFontSize": 0,
  • "textHorizontalAlign": "ALIGN_LEFT",
  • "textItalic": true,
  • "textOutline": true,
  • "textShadow": true,
  • "textVerticalAlign": "ALIGN_TOP",
  • "type": "TEXT"
}

Response samples

Content type
application/json
{
  • "animations": [
    ],
  • "assetId": "string",
  • "audio": true,
  • "audioProperties": {
    },
  • "background": {
    },
  • "backgroundColor": "string",
  • "color": "string",
  • "content": "string",
  • "contentType": "RSS",
  • "crawling": {
    },
  • "dimensions": {
    },
  • "duration": 0,
  • "fontFamilyId": "string",
  • "fontFamilyName": "string",
  • "fontId": "string",
  • "fontName": "string",
  • "groupId": "string",
  • "groupMember": {
    },
  • "id": "string",
  • "lineHeight": 0,
  • "liveInputId": "string",
  • "loop": true,
  • "mediaId": "string",
  • "name": "string",
  • "objectId": "string",
  • "opacity": 0.1,
  • "outline": {
    },
  • "position": {
    },
  • "previewImage": "string",
  • "properties": [
    ],
  • "shadow": {
    },
  • "src": "string",
  • "stratusObject": true,
  • "textBold": true,
  • "textFont": "string",
  • "textFontSize": 0,
  • "textHorizontalAlign": "ALIGN_LEFT",
  • "textItalic": true,
  • "textOutline": true,
  • "textShadow": true,
  • "textVerticalAlign": "ALIGN_TOP",
  • "type": "TEXT"
}

Import graphics project

Import graphics project

query Parameters
organization
string

Organization Id

Request Body schema: application/json
file
required
string <binary>

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "channels": [
    ],
  • "dateCommitted": "2019-08-24T14:15:22Z",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "elements": [
    ],
  • "graphicProjectId": "string",
  • "height": 0,
  • "id": "string",
  • "jsonType": "string",
  • "name": "string",
  • "organization": "string",
  • "playouts": [
    ],
  • "serviceProviderId": "string",
  • "status": "DRAFT",
  • "version": 0,
  • "width": 0
}

Search graphics projects

Returns list of assets according to sorting and paging parameters

query Parameters
exclude
Array of strings
size
long

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

organization
string

Organization Id

Request Body schema: application/json
required
dateCreatedFrom
string <date-time>
dateCreatedTo
string <date-time>
dateUpdatedFrom
string <date-time>
dateUpdatedTo
string <date-time>
term
string

Responses

Request samples

Content type
application/json
{
  • "dateCreatedFrom": "2019-08-24T14:15:22Z",
  • "dateCreatedTo": "2019-08-24T14:15:22Z",
  • "dateUpdatedFrom": "2019-08-24T14:15:22Z",
  • "dateUpdatedTo": "2019-08-24T14:15:22Z",
  • "term": "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
}

Export Graphics Project

Exports Graphics Project

path Parameters
graphicsId
required
string
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"
}

Validate graphics project

Returns graphics project validation result

path Parameters
graphicsProjectName
required
string

Graphics project name

query Parameters
organization
string

Organization Id

Responses

Response samples

Content type
application/json
{
  • "graphicsProject": {
    },
  • "graphicsProjectName": "string",
  • "status": "OK"
}

Delete graphics project

Deletes specified graphics project

path Parameters
id
required
string

Graphics project id

query Parameters
organization
string

Organization Id

Responses

Response samples

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

Get graphics project

Returns graphics project found by name

path Parameters
id
required
string

Graphics project id

query Parameters
organization
string

Organization Id

Responses

Response samples

Content type
application/json
{
  • "channels": [
    ],
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "elements": [
    ],
  • "height": 0,
  • "id": "string",
  • "name": "string",
  • "organization": "string",
  • "playouts": [
    ],
  • "serviceProviderId": "string",
  • "version": 0,
  • "width": 0
}

Update graphics project

Update graphics project

path Parameters
id
required
string
query Parameters
organization
string

Organization Id

Request Body schema: application/json
required
Array of objects (Channel)
dateCreated
string <date-time>
dateUpdated
string <date-time>
Array of objects (GraphicElementDTO)
height
integer <int32>
id
string
name
string
organization
string
Array of objects (Playout)
serviceProviderId
string
version
integer <int32>
width
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "channels": [
    ],
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "elements": [
    ],
  • "height": 0,
  • "id": "string",
  • "name": "string",
  • "organization": "string",
  • "playouts": [
    ],
  • "serviceProviderId": "string",
  • "version": 0,
  • "width": 0
}

Response samples

Content type
application/json
{
  • "channels": [
    ],
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "elements": [
    ],
  • "height": 0,
  • "id": "string",
  • "name": "string",
  • "organization": "string",
  • "playouts": [
    ],
  • "serviceProviderId": "string",
  • "version": 0,
  • "width": 0
}

Create graphics project element

Create graphics project element

path Parameters
id
required
string
query Parameters
organization
string

Organization Id

Request Body schema: application/json
required
Array of objects (AnimationDTO)
assetId
string
audio
boolean
object (GraphicAudioPropertiesDTO)
object (BackgroundDTO)
backgroundColor
string
color
string
content
string
contentType
string
Enum: "RSS" "CUSTOM" "ASSET_TITLE"
object (Crawling)
object (Dimensions)

Object dimensions

duration
integer <int64>
fontFamilyId
string
fontFamilyName
string
fontId
string
fontName
string
groupId
string
object (GroupMemberDTO)

Group member

id
string
lineHeight
integer <int32>
liveInputId
string
loop
boolean
mediaId
string
name
string
objectId
string
opacity
number <float>
object (OutlineDTO)
object (Position)

Element position

previewImage
string

Element preview image in base64

Array of objects (GraphicObjectProperties) unique
object (ShadowDTO)
src
string
stratusObject
boolean
textBold
boolean
textFont
string
textFontSize
integer <int32>
textHorizontalAlign
string
Enum: "ALIGN_LEFT" "ALIGN_CENTER" "ALIGN_RIGHT" "ALIGN_JUSTIFY"
textItalic
boolean
textOutline
boolean
textShadow
boolean
textVerticalAlign
string
Enum: "ALIGN_TOP" "ALIGN_MIDDLE" "ALIGN_BOTTOM"
type
string
Enum: "TEXT" "IMAGE" "VIDEO" "ROLLING_TEXT" "MAIN_STREAM" "TRANSFORMATION" "AE_GRAPHICS" "GROUP" "HTML5" "PICTURE_IN_PICTURE" "SUBTITLES" "LIVE_PICTURE_IN_PICTURE" "CRAWLING_TEXT"

Responses

Request samples

Content type
application/json
{
  • "animations": [
    ],
  • "assetId": "string",
  • "audio": true,
  • "audioProperties": {
    },
  • "background": {
    },
  • "backgroundColor": "string",
  • "color": "string",
  • "content": "string",
  • "contentType": "RSS",
  • "crawling": {
    },
  • "dimensions": {
    },
  • "duration": 0,
  • "fontFamilyId": "string",
  • "fontFamilyName": "string",
  • "fontId": "string",
  • "fontName": "string",
  • "groupId": "string",
  • "groupMember": {
    },
  • "id": "string",
  • "lineHeight": 0,
  • "liveInputId": "string",
  • "loop": true,
  • "mediaId": "string",
  • "name": "string",
  • "objectId": "string",
  • "opacity": 0.1,
  • "outline": {
    },
  • "position": {
    },
  • "previewImage": "string",
  • "properties": [
    ],
  • "shadow": {
    },
  • "src": "string",
  • "stratusObject": true,
  • "textBold": true,
  • "textFont": "string",
  • "textFontSize": 0,
  • "textHorizontalAlign": "ALIGN_LEFT",
  • "textItalic": true,
  • "textOutline": true,
  • "textShadow": true,
  • "textVerticalAlign": "ALIGN_TOP",
  • "type": "TEXT"
}

Response samples

Content type
application/json
{
  • "animations": [
    ],
  • "assetId": "string",
  • "audio": true,
  • "audioProperties": {
    },
  • "background": {
    },
  • "backgroundColor": "string",
  • "color": "string",
  • "content": "string",
  • "contentType": "RSS",
  • "crawling": {
    },
  • "dimensions": {
    },
  • "duration": 0,
  • "fontFamilyId": "string",
  • "fontFamilyName": "string",
  • "fontId": "string",
  • "fontName": "string",
  • "groupId": "string",
  • "groupMember": {
    },
  • "id": "string",
  • "lineHeight": 0,
  • "liveInputId": "string",
  • "loop": true,
  • "mediaId": "string",
  • "name": "string",
  • "objectId": "string",
  • "opacity": 0.1,
  • "outline": {
    },
  • "position": {
    },
  • "previewImage": "string",
  • "properties": [
    ],
  • "shadow": {
    },
  • "src": "string",
  • "stratusObject": true,
  • "textBold": true,
  • "textFont": "string",
  • "textFontSize": 0,
  • "textHorizontalAlign": "ALIGN_LEFT",
  • "textItalic": true,
  • "textOutline": true,
  • "textShadow": true,
  • "textVerticalAlign": "ALIGN_TOP",
  • "type": "TEXT"
}

Update graphics project elements

Update graphics project elements

path Parameters
id
required
string
query Parameters
organization
string

Organization Id

Request Body schema: application/json
required
Array
Array of objects (AnimationDTO)
assetId
string
audio
boolean
object (GraphicAudioPropertiesDTO)
object (BackgroundDTO)
backgroundColor
string
color
string
content
string
contentType
string
Enum: "RSS" "CUSTOM" "ASSET_TITLE"
object (Crawling)
object (Dimensions)

Object dimensions

duration
integer <int64>
fontFamilyId
string
fontFamilyName
string
fontId
string
fontName
string
groupId
string
object (GroupMemberDTO)

Group member

id
string
lineHeight
integer <int32>
liveInputId
string
loop
boolean
mediaId
string
name
string
objectId
string
opacity
number <float>
object (OutlineDTO)
object (Position)

Element position

previewImage
string

Element preview image in base64

Array of objects (GraphicObjectProperties) unique
object (ShadowDTO)
src
string
stratusObject
boolean
textBold
boolean
textFont
string
textFontSize
integer <int32>
textHorizontalAlign
string
Enum: "ALIGN_LEFT" "ALIGN_CENTER" "ALIGN_RIGHT" "ALIGN_JUSTIFY"
textItalic
boolean
textOutline
boolean
textShadow
boolean
textVerticalAlign
string
Enum: "ALIGN_TOP" "ALIGN_MIDDLE" "ALIGN_BOTTOM"
type
string
Enum: "TEXT" "IMAGE" "VIDEO" "ROLLING_TEXT" "MAIN_STREAM" "TRANSFORMATION" "AE_GRAPHICS" "GROUP" "HTML5" "PICTURE_IN_PICTURE" "SUBTITLES" "LIVE_PICTURE_IN_PICTURE" "CRAWLING_TEXT"

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "channels": [
    ],
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "elements": [
    ],
  • "height": 0,
  • "id": "string",
  • "name": "string",
  • "organization": "string",
  • "playouts": [
    ],
  • "serviceProviderId": "string",
  • "version": 0,
  • "width": 0
}

Modify Graphic Elements

Creates, updates, deletes multiple Graphic Elements

path Parameters
id
required
string
query Parameters
organization
required
string
Request Body schema: application/json
required
Array of objects (GraphicElementDTO)
deleted
Array of strings
Array of objects (GraphicElementDTO)

Responses

Request samples

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

Response samples

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

Delete graphics project element

Delete graphics project element

path Parameters
id
required
string
elementId
required
string
query Parameters
organization
string

Organization Id

Responses

Response samples

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

Update graphics project element

Update graphics project element

path Parameters
id
required
string
elementId
required
string
query Parameters
organization
string

Organization Id

Request Body schema: application/json
required
Array of objects (AnimationDTO)
assetId
string
audio
boolean
object (GraphicAudioPropertiesDTO)
object (BackgroundDTO)
backgroundColor
string
color
string
content
string
contentType
string
Enum: "RSS" "CUSTOM" "ASSET_TITLE"
object (Crawling)
object (Dimensions)

Object dimensions

duration
integer <int64>
fontFamilyId
string
fontFamilyName
string
fontId
string
fontName
string
groupId
string
object (GroupMemberDTO)

Group member

id
string
lineHeight
integer <int32>
liveInputId
string
loop
boolean
mediaId
string
name
string
objectId
string
opacity
number <float>
object (OutlineDTO)
object (Position)

Element position

previewImage
string

Element preview image in base64

Array of objects (GraphicObjectProperties) unique
object (ShadowDTO)
src
string
stratusObject
boolean
textBold
boolean
textFont
string
textFontSize
integer <int32>
textHorizontalAlign
string
Enum: "ALIGN_LEFT" "ALIGN_CENTER" "ALIGN_RIGHT" "ALIGN_JUSTIFY"
textItalic
boolean
textOutline
boolean
textShadow
boolean
textVerticalAlign
string
Enum: "ALIGN_TOP" "ALIGN_MIDDLE" "ALIGN_BOTTOM"
type
string
Enum: "TEXT" "IMAGE" "VIDEO" "ROLLING_TEXT" "MAIN_STREAM" "TRANSFORMATION" "AE_GRAPHICS" "GROUP" "HTML5" "PICTURE_IN_PICTURE" "SUBTITLES" "LIVE_PICTURE_IN_PICTURE" "CRAWLING_TEXT"

Responses

Request samples

Content type
application/json
{
  • "animations": [
    ],
  • "assetId": "string",
  • "audio": true,
  • "audioProperties": {
    },
  • "background": {
    },
  • "backgroundColor": "string",
  • "color": "string",
  • "content": "string",
  • "contentType": "RSS",
  • "crawling": {
    },
  • "dimensions": {
    },
  • "duration": 0,
  • "fontFamilyId": "string",
  • "fontFamilyName": "string",
  • "fontId": "string",
  • "fontName": "string",
  • "groupId": "string",
  • "groupMember": {
    },
  • "id": "string",
  • "lineHeight": 0,
  • "liveInputId": "string",
  • "loop": true,
  • "mediaId": "string",
  • "name": "string",
  • "objectId": "string",
  • "opacity": 0.1,
  • "outline": {
    },
  • "position": {
    },
  • "previewImage": "string",
  • "properties": [
    ],
  • "shadow": {
    },
  • "src": "string",
  • "stratusObject": true,
  • "textBold": true,
  • "textFont": "string",
  • "textFontSize": 0,
  • "textHorizontalAlign": "ALIGN_LEFT",
  • "textItalic": true,
  • "textOutline": true,
  • "textShadow": true,
  • "textVerticalAlign": "ALIGN_TOP",
  • "type": "TEXT"
}

Response samples

Content type
application/json
{
  • "animations": [
    ],
  • "assetId": "string",
  • "audio": true,
  • "audioProperties": {
    },
  • "background": {
    },
  • "backgroundColor": "string",
  • "color": "string",
  • "content": "string",
  • "contentType": "RSS",
  • "crawling": {
    },
  • "dimensions": {
    },
  • "duration": 0,
  • "fontFamilyId": "string",
  • "fontFamilyName": "string",
  • "fontId": "string",
  • "fontName": "string",
  • "groupId": "string",
  • "groupMember": {
    },
  • "id": "string",
  • "lineHeight": 0,
  • "liveInputId": "string",
  • "loop": true,
  • "mediaId": "string",
  • "name": "string",
  • "objectId": "string",
  • "opacity": 0.1,
  • "outline": {
    },
  • "position": {
    },
  • "previewImage": "string",
  • "properties": [
    ],
  • "shadow": {
    },
  • "src": "string",
  • "stratusObject": true,
  • "textBold": true,
  • "textFont": "string",
  • "textFontSize": 0,
  • "textHorizontalAlign": "ALIGN_LEFT",
  • "textItalic": true,
  • "textOutline": true,
  • "textShadow": true,
  • "textVerticalAlign": "ALIGN_TOP",
  • "type": "TEXT"
}

Get graphics project element preview image

Gets graphics project element preview image

path Parameters
id
required
string
elementId
required
string
query Parameters
organization
string

Organization Id

Responses

Response samples

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

Updates graphics project element preview image

Updates graphics project element preview image

path Parameters
id
required
string
elementId
required
string
query Parameters
version
required
integer <int32>
organization
string

Organization Id

Request Body schema: image/png
required
Array
string <byte>

Responses

Response samples

Content type
application/json
{ }

Library common resource

Library common resource

Returns library statistics

query Parameters
organization
string

Organization Id

Responses

Response samples

Content type
application/json
{
  • "audios": 0,
  • "fonts": 0,
  • "graphicsObjects": 0,
  • "graphicsProjects": 0,
  • "multimediaCaptionPackages": 0,
  • "subtitles": 0,
  • "totalAssetSize": 0,
  • "totalAssets": 0,
  • "totalComplianceRecordingSize": 0,
  • "totalComplianceRecordings": 0,
  • "videos": 0
}