Library

Download OpenAPI specification:Download

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" "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>
name
string
object (AssetSystemFieldsDTO)
Array of objects (TagDTO) unique

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "assetId": "string",
  • "assetSize": 0,
  • "completeAssetSize": 0,
  • "customFields": {
    },
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "fileCount": 0,
  • "fileData": [
    ],
  • "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
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)
object (AssetMetadataSearch)
name
string
object (QCInfoSearch)
object (AssetSystemFieldsSearch)
tags
Array of strings unique

Responses

Request samples

Content type
application/json
{
  • "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": {
    },
  • "metadata": {
    },
  • "name": "string",
  • "qcInfo": {
    },
  • "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": [
    ]
}

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,
  • "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
assetIds
Array of strings unique
assetName
string
assetSizeFrom
integer <int64>
assetSizeTo
integer <int64>