logo
API docs by Redocly

Ingest

Download OpenAPI specification:Download

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

Services

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

Ingest Queue

Ingest Queue API

Returns page of ingest queue objects

Returns page of ingest queue objects

query Parameters
required
object (Pageable)
organization
required
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
}

Returns page of ingest queue objects, by search criteria

Returns page of ingest queue objects, by search criteria

query Parameters
required
object (Pageable)
organization
required
string

Organization Id

Request Body schema: application/json
required
customPeriod
string <date-time>
fileName
string
objectState
string
Enum: "PARENT" "DERIVED"
qcStatuses
Array of strings
Items Enum: "UNKNOWN" "OK" "WARNING" "FAILED"
object
type
Array of strings
Items Enum: "VIDEO" "IMAGE" "AUDIO" "SUBTITLE" "AE_TEMPLATE" "GRAPHICS_PROJECT" "MULTI_MEDIA_CAPTION_PACKAGE" "SIDE_CAR_XML" "SCHEDULE" "UNKNOWN" "THUMBNAIL_IMAGE" "THUMBNAIL_VIDEO" "FONT"

Responses

Request samples

Content type
application/json
{
  • "customPeriod": "2019-08-24T14:15:22Z",
  • "fileName": "string",
  • "objectState": "PARENT",
  • "qcStatuses": [
    ],
  • "statuses": {
    },
  • "type": [
    ]
}

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 ingest queue item

Delete ingest queue item

query Parameters
organization
required
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
{
  • "property1": [
    ],
  • "property2": [
    ]
}

Deletes ingest queue objects, until specified date

Deletes ingest queue objects, until specified date

query Parameters
organization
required
string

Organization Id

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

Created to

Responses

Request samples

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

Response samples

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

Get incomplete ingest queue items

Get incomplete ingest queue items

query Parameters
organization
required
string

Organization Id

required
object (Pageable)

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 incomplete ingest queue items

Get incomplete ingest queue items, with search critteria

query Parameters
organization
required
string

Organization Id

required
object (Pageable)
Request Body schema: application/json
required
customPeriod
string <date-time>
fileName
string
objectState
string
Enum: "PARENT" "DERIVED"
qcStatuses
Array of strings
Items Enum: "UNKNOWN" "OK" "WARNING" "FAILED"
object
type
Array of strings
Items Enum: "VIDEO" "IMAGE" "AUDIO" "SUBTITLE" "AE_TEMPLATE" "GRAPHICS_PROJECT" "MULTI_MEDIA_CAPTION_PACKAGE" "SIDE_CAR_XML" "SCHEDULE" "UNKNOWN" "THUMBNAIL_IMAGE" "THUMBNAIL_VIDEO" "FONT"

Responses

Request samples

Content type
application/json
{
  • "customPeriod": "2019-08-24T14:15:22Z",
  • "fileName": "string",
  • "objectState": "PARENT",
  • "qcStatuses": [
    ],
  • "statuses": {
    },
  • "type": [
    ]
}

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
}

Check if object is in ingest queue

Check if object with specified fileName, md5 is in ingest queue

query Parameters
organization
required
string

Organization Id

fileName
required
string
md5
string
fileId
string
ingestSourceId
required
string

Responses

Response samples

Content type
application/json
true

Change ingest queue item priority

Change ingest queue item priority

query Parameters
organization
required
string

Organization Id

Request Body schema: application/json
required
property name*
additional property
integer <int32>

Responses

Request samples

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

Response samples

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

Save ingest source item

Save ingest source item

path Parameters
sourceId
required
string
query Parameters
organization
required
string

Organization Id

Request Body schema: application/json
required
string

Responses

Request samples

Content type
application/json
"string"

Response samples

Content type
application/json
{
  • "assetName": "string",
  • "audioTrackMapping": {
    },
  • "child": true,
  • "children": [
    ],
  • "cirrusObject": true,
  • "complete": true,
  • "completeDate": "2019-08-24T14:15:22Z",
  • "complianceRecording": true,
  • "createDate": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "emptyAsset": true,
  • "entityUpdate": "PARENT",
  • "file": {
    },
  • "fontInfo": {
    },
  • "graphicFingerPrint": "string",
  • "graphicObject": true,
  • "graphicObjectData": {
    },
  • "graphicTemplateId": "string",
  • "graphicsProjectInfo": {
    },
  • "id": "string",
  • "inTimeline": true,
  • "ingestAgentId": "string",
  • "ingestSourceId": "string",
  • "isParent": true,
  • "leaseExpires": "2019-08-24T14:15:22Z",
  • "leasedBy": "string",
  • "mediaInfo": {
    },
  • "mediaStoreObject": {
    },
  • "mediaType": "VIDEO",
  • "multimediaFileInfo": {
    },
  • "organizationId": "string",
  • "origin": {
    },
  • "parentId": "string",
  • "priority": 0,
  • "processingInfo": {
    },
  • "properties": {
    },
  • "qcInfo": {
    },
  • "recordingInfo": {
    },
  • "region": "string",
  • "retryAttempts": 0,
  • "scanOnly": true,
  • "source": {
    },
  • "sourceId": "string",
  • "status": "TEMPORARY",
  • "storeType": "S3",
  • "timelinePriority": "2019-08-24T14:15:22Z"
}

Get ingest history statistics

Get ingest history statistics

query Parameters
organization
required
string

Responses

Response samples

Content type
application/json
{
  • "audios": 0,
  • "completed": 0,
  • "failed": 0,
  • "graphicsProjects": 0,
  • "multimediaCaptionPackages": 0,
  • "subtitles": 0,
  • "unknown": 0,
  • "videos": 0
}

Get ingest live statistics

Get ingest live statistics

query Parameters
organization
required
string

Responses

Response samples

Content type
application/json
{
  • "downloading": 0,
  • "pending": 0,
  • "pendingDownload": 0,
  • "pendingProcessing": 0,
  • "pendingQc": 0,
  • "pendingUpload": 0,
  • "processing": 0,
  • "qc": 0,
  • "uploading": 0
}

Returns ingest queue object by id

Returns ingest queue object by id

path Parameters
id
required
string
query Parameters
organization
string

Organization Id

Responses

Response samples

Content type
application/json
{
  • "assetName": "string",
  • "audioTrackMapping": {
    },
  • "child": true,
  • "children": [
    ],
  • "cirrusObject": true,
  • "complete": true,
  • "completeDate": "2019-08-24T14:15:22Z",
  • "complianceRecording": true,
  • "createDate": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "emptyAsset": true,
  • "entityUpdate": "PARENT",
  • "file": {
    },
  • "fontInfo": {
    },
  • "graphicFingerPrint": "string",
  • "graphicObject": true,
  • "graphicObjectData": {
    },
  • "graphicTemplateId": "string",
  • "graphicsProjectInfo": {
    },
  • "id": "string",
  • "inTimeline": true,
  • "ingestAgentId": "string",
  • "ingestSourceId": "string",
  • "isParent": true,
  • "leaseExpires": "2019-08-24T14:15:22Z",
  • "leasedBy": "string",
  • "mediaInfo": {
    },
  • "mediaStoreObject": {
    },
  • "mediaType": "VIDEO",
  • "multimediaFileInfo": {
    },
  • "organizationId": "string",
  • "origin": {
    },
  • "parentId": "string",
  • "priority": 0,
  • "processingInfo": {
    },
  • "properties": {
    },
  • "qcInfo": {
    },
  • "recordingInfo": {
    },
  • "region": "string",
  • "retryAttempts": 0,
  • "scanOnly": true,
  • "source": {
    },
  • "sourceId": "string",
  • "status": "TEMPORARY",
  • "storeType": "S3",
  • "timelinePriority": "2019-08-24T14:15:22Z"
}

Download ingest queue item

Download ingest queue item

path Parameters
id
required
string
query Parameters
organization
required
string

Organization Id

Responses

Response samples

Content type
application/json
{ }

Returns ingest object url

Returns ingest object url

path Parameters
objectId
required
string
query Parameters
organization
required
string

Organization Id

Responses

Response samples

Content type
application/json
{ }

Returns page of derived ingest objects

Returns page of derived ingest objects

path Parameters
sourceId
required
string
query Parameters
required
object (Pageable)
organization
required
string

Organization Id

Responses

Response samples

Content type
application/json
{ }

Ingest Status

Ingest Status API

Get ingest queue status

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Check ingest source connection

query Parameters
organization
required
string

Organization Id

Request Body schema: application/json
required
accessKey
string
cirrusSource
boolean
containerName
string
dateCreated
string <date-time>
dateUpdated
string <date-time>
emptyAssetsSource
boolean
enabled
boolean
expiration
string <date-time>
graphicsUploadSource
boolean
host
string
id
string
internal
boolean
manualListing
boolean
musicKitIntegration
boolean
name
string
passwordChanged
boolean
pollingFrequency
integer <int64>
port
integer <int32>
priority
integer <int32>
privateKey
string
privateKeyChanged
boolean
object
readOnly
boolean
region
string
scanOnly
boolean
scheduleAutoApplyEnabled
boolean
scheduleFileMask
string
scheduleTransformationScriptId
string
scheduledMissingOnly
boolean
secretKey
string
secretKeyChanged
boolean
sideCarFileMask
string
sideCarXmlTransformationScriptId
string
sourcePassword
string
sourcePath
string
sourceUserName
string
storefrontRegion
string
subtitleEncoding
string
Array of objects (TagDTO) unique
timecodeIn
integer <int64>
type
string
Enum: "FTP" "S3" "SFTP" "TELIA_S3" "ALIBABA" "AZURE" "S3_GENERIC" "S3_PAIRED" "DOT_STUDIO"
videoConversionEnabled
boolean
videoConversionExtensions
Array of strings unique

Responses

Request samples

Content type
application/json
{
  • "accessKey": "string",
  • "cirrusSource": true,
  • "containerName": "string",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "emptyAssetsSource": true,
  • "enabled": true,
  • "expiration": "2019-08-24T14:15:22Z",
  • "graphicsUploadSource": true,
  • "host": "string",
  • "id": "string",
  • "internal": true,
  • "manualListing": true,
  • "musicKitIntegration": true,
  • "name": "string",
  • "passwordChanged": true,
  • "pollingFrequency": 0,
  • "port": 0,
  • "priority": 0,
  • "privateKey": "string",
  • "privateKeyChanged": true,
  • "properties": {
    },
  • "readOnly": true,
  • "region": "string",
  • "scanOnly": true,
  • "scheduleAutoApplyEnabled": true,
  • "scheduleFileMask": "string",
  • "scheduleTransformationScriptId": "string",
  • "scheduledMissingOnly": true,
  • "secretKey": "string",
  • "secretKeyChanged": true,
  • "sideCarFileMask": "string",
  • "sideCarXmlTransformationScriptId": "string",
  • "sourcePassword": "string",
  • "sourcePath": "string",
  • "sourceUserName": "string",
  • "storefrontRegion": "string",
  • "subtitleEncoding": "string",
  • "tags": [
    ],
  • "timecodeIn": 0,
  • "type": "FTP",
  • "videoConversionEnabled": true,
  • "videoConversionExtensions": [
    ]
}

Response samples

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

Ingest

Ingest API

Reset all failed derived items

query Parameters
organization
string

Responses

Response samples

Content type
application/json
{
  • "assetName": "string",
  • "audioTrackMapping": {
    },
  • "child": true,
  • "children": [
    ],
  • "cirrusObject": true,
  • "complete": true,
  • "completeDate": "2019-08-24T14:15:22Z",
  • "complianceRecording": true,
  • "createDate": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "emptyAsset": true,
  • "entityUpdate": "PARENT",
  • "file": {
    },
  • "fontInfo": {
    },
  • "graphicFingerPrint": "string",
  • "graphicObject": true,
  • "graphicObjectData": {
    },
  • "graphicTemplateId": "string",
  • "graphicsProjectInfo": {
    },
  • "id": "string",
  • "inTimeline": true,
  • "ingestAgentId": "string",
  • "ingestSourceId": "string",
  • "isParent": true,
  • "leaseExpires": "2019-08-24T14:15:22Z",
  • "leasedBy": "string",
  • "mediaInfo": {
    },
  • "mediaStoreObject": {
    },
  • "mediaType": "VIDEO",
  • "multimediaFileInfo": {
    },
  • "organizationId": "string",
  • "origin": {
    },
  • "parentId": "string",
  • "priority": 0,
  • "processingInfo": {
    },
  • "properties": {
    },
  • "qcInfo": {
    },
  • "recordingInfo": {
    },
  • "region": "string",
  • "retryAttempts": 0,
  • "scanOnly": true,
  • "source": {
    },
  • "sourceId": "string",
  • "status": "TEMPORARY",
  • "storeType": "S3",
  • "timelinePriority": "2019-08-24T14:15:22Z"
}

Reserve and retrieve object for processing

query Parameters
workerId
required
string
processedOrganizations
Array of strings unique
clusterId
string
playlistsOnly
boolean
Default: false

Responses

Response samples

Content type
application/json
{
  • "customFields": [
    ],
  • "ingestSource": {
    },
  • "mediaStoreInfo": {
    },
  • "qcRules": [
    ],
  • "queueObject": {
    },
  • "scheduleTransformationScript": {
    },
  • "settings": {
    },
  • "sideCarTransformationScript": {
    }
}

Reserve and retrieve derived object for processing

query Parameters
workerId
required
string
processedOrganizations
Array of strings unique
clusterId
string

Responses

Response samples

Content type
application/json
{
  • "customFields": [
    ],
  • "ingestSource": {
    },
  • "mediaStoreInfo": {
    },
  • "qcRules": [
    ],
  • "queueObject": {
    },
  • "scheduleTransformationScript": {
    },
  • "settings": {
    },
  • "sideCarTransformationScript": {
    }
}

Reserve and retrieve object for processing

query Parameters
workerId
required
string
processedOrganizations
Array of strings unique
clusterId
string

Responses

Response samples

Content type
application/json
{
  • "customFields": [
    ],
  • "ingestSource": {
    },
  • "mediaStoreInfo": {
    },
  • "qcRules": [
    ],
  • "queueObject": {
    },
  • "scheduleTransformationScript": {
    },
  • "settings": {
    },
  • "sideCarTransformationScript": {
    }
}

Release items

query Parameters
workerId
required
string

Responses

Response samples

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

Delete item

path Parameters
id
required
string
query Parameters
organization
required
string

Responses

Response samples

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

Update custom fields

path Parameters
id
required
string
query Parameters
workerId
required
string
organization
required
string
assetName
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": [
    ]
}

Delete derived items

path Parameters
id
required
string

Responses

Response samples

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

Get derived items

path Parameters
id
required
string
query Parameters
organization
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create derived object

path Parameters
id
required
string
query Parameters
workerId
required
string
organization
required
string
Request Body schema: application/json
required
assetName
string
object (AudioTrackMapping)
child
boolean
Array of objects (BaseObject)
cirrusObject
boolean
complete
boolean
completeDate
string <date-time>
complianceRecording
boolean
createDate
string <date-time>
createdBy
string
emptyAsset
boolean
entityUpdate
string
Enum: "PARENT" "CHILD"
object (IngestFile)
object (FontInfo)
graphicFingerPrint
string
graphicObject
boolean
object (GraphicObjectData)
graphicTemplateId
string
object (GraphicsProjectInfo)
id
string
inTimeline
boolean
ingestAgentId
string
ingestSourceId
string
isParent
boolean
leaseExpires
string <date-time>
leasedBy
string
object (MediaInfo)
object (MediaStoreObject)
mediaType
string
Enum: "VIDEO" "IMAGE" "AUDIO" "SUBTITLE" "AE_TEMPLATE" "GRAPHICS_PROJECT" "MULTI_MEDIA_CAPTION_PACKAGE" "SIDE_CAR_XML" "SCHEDULE" "UNKNOWN" "THUMBNAIL_IMAGE" "THUMBNAIL_VIDEO" "FONT"
object (MultimediaFileInfo)
organizationId
string
object (Origin)
parentId
string
priority
integer <int32>
object (ProcessingInfo)
object
object (QCInfo)
object (RecordingInfo)
region
string
retryAttempts
integer <int32>
scanOnly
boolean
object (IngestFile)
sourceId
string
status
string
Enum: "TEMPORARY" "NEW" "PENDING_DOWNLOAD" "DOWNLOADING" "PENDING_QC" "QC" "PENDING_PROCESSING" "PROCESSING" "PENDING_UPLOAD" "UPLOADING" "COMPLETE" "FAILED" "CANCELED"
storeType
string
Enum: "S3" "BRIGHTCOVE" "FTP" "SERVERS_COM" "TELIA_S3" "ALIBABA" "S3_GENERIC" "AZURE" "WASABI" "S3_PAIRED" "S3_EXTERNAL" "DOTSTUDIO_PRO"
timelinePriority
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "assetName": "string",
  • "audioTrackMapping": {
    },
  • "child": true,
  • "children": [
    ],
  • "cirrusObject": true,
  • "complete": true,
  • "completeDate": "2019-08-24T14:15:22Z",
  • "complianceRecording": true,
  • "createDate": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "emptyAsset": true,
  • "entityUpdate": "PARENT",
  • "file": {
    },
  • "fontInfo": {
    },
  • "graphicFingerPrint": "string",
  • "graphicObject": true,
  • "graphicObjectData": {
    },
  • "graphicTemplateId": "string",
  • "graphicsProjectInfo": {
    },
  • "id": "string",
  • "inTimeline": true,
  • "ingestAgentId": "string",
  • "ingestSourceId": "string",
  • "isParent": true,
  • "leaseExpires": "2019-08-24T14:15:22Z",
  • "leasedBy": "string",
  • "mediaInfo": {
    },
  • "mediaStoreObject": {
    },
  • "mediaType": "VIDEO",
  • "multimediaFileInfo": {
    },
  • "organizationId": "string",
  • "origin": {
    },
  • "parentId": "string",
  • "priority": 0,
  • "processingInfo": {
    },
  • "properties": {
    },
  • "qcInfo": {
    },
  • "recordingInfo": {
    },
  • "region": "string",
  • "retryAttempts": 0,
  • "scanOnly": true,
  • "source": {
    },
  • "sourceId": "string",
  • "status": "TEMPORARY",
  • "storeType": "S3",
  • "timelinePriority": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{ }

Extract audio from ingest item

path Parameters
id
required
string
query Parameters
organization
string

Responses

Response samples

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

Update file info

path Parameters
id
required
string
query Parameters
workerId
required
string
organization
required
string
Request Body schema: application/json
required
baseName
string
crc32
integer <int64>
encoding
string
extension
string
fileId
string
fileName
string
filePath
string
fileSize
integer <int64>
fileTimestamp
integer <int64>
md5
string

Responses

Request samples

Content type
application/json
{
  • "baseName": "string",
  • "crc32": 0,
  • "encoding": "string",
  • "extension": "string",
  • "fileId": "string",
  • "fileName": "string",
  • "filePath": "string",
  • "fileSize": 0,
  • "fileTimestamp": 0,
  • "md5": "string"
}

Response samples

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

Finalize ingest item

path Parameters
id
required
string
query Parameters
workerId
required
string
organization
required
string
Request Body schema: application/json
required
string

Responses

Request samples

Content type
application/json
"string"

Response samples

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

Finalize compliance recording

path Parameters
id
required
string
query Parameters
workerId
required
string
organization
required
string
Request Body schema: application/json
required
channelId
string
channelName
string
endTime
string <date-time>
outputName
string
playoutId
string
playoutName
string
startTime
string <date-time>

Responses

Request samples

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

Response samples

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

Finalize derived item

path Parameters
id
required
string
query Parameters
workerId
required
string
organization
required
string
Request Body schema: application/json
required
string

Responses

Request samples

Content type
application/json
"string"

Response samples

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

Finalize font

path Parameters
id
required
string
query Parameters
workerId
required
string
organization
required
string
Request Body schema: application/json
required
family
string
format
string
name
string
style
string

Responses

Request samples

Content type
application/json
{
  • "family": "string",
  • "format": "string",
  • "name": "string",
  • "style": "string"
}

Response samples

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

Finalize graphic object data

path Parameters
id
required
string
query Parameters
workerId
required
string
organization
required
string
Request Body schema: application/json
required
bitDepth
integer <int32>
chromaSubSampling
string
colorSpace
string
compressionMode
string
durationInMilliseconds
integer <int64>
format
string
height
integer <int32>
Array of objects (GraphicObjectProperties) unique
thumbnail
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"
width
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "bitDepth": 0,
  • "chromaSubSampling": "string",
  • "colorSpace": "string",
  • "compressionMode": "string",
  • "durationInMilliseconds": 0,
  • "format": "string",
  • "height": 0,
  • "properties": [
    ],
  • "thumbnail": "string",
  • "type": "IMAGE",
  • "width": 0
}

Response samples

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

Finalize graphics project

path Parameters
id
required
string
query Parameters
workerId
required
string
organization
required
string
Request Body schema: application/json
required
Array of objects (GraphicsProjectElement)
name
string

Responses

Request samples

Content type
application/json
{
  • "entries": [
    ],
  • "name": "string"
}

Response samples

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

Finalize multimedia package

path Parameters
id
required
string
query Parameters
workerId
required
string
organization
required
string
Request Body schema: application/json
required
Array of objects (IngestFile)
name
string

Responses

Request samples

Content type
application/json
{
  • "multimediaFiles": [
    ],
  • "name": "string"
}

Response samples

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

Finalize schedule

path Parameters
id
required
string
query Parameters
workerId
required
string
organization
required
string
Request Body schema: application/json
required
data
Array of strings <byte> [ items <byte > ]
fileName
string
fps
number <float>
scriptId
string

Responses

Request samples

Content type
application/json
{
  • "data": [
    ],
  • "fileName": "string",
  • "fps": 0.1,
  • "scriptId": "string"
}

Response samples

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

Finish item processing

path Parameters
id
required
string
query Parameters
workerId
required
string
organization
required
string
remoteCleaned
required
boolean

Responses

Response samples

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

Get journal

Get journal for item

path Parameters
id
required
string
query Parameters
organization
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Update journal

path Parameters
id
required
string
query Parameters
workerId
required
string
organization
required
string
Request Body schema: application/json
required
Array
actor
string
entryType
string
Enum: "CREATE" "READ" "UPDATE" "DELETE"
expirationDate
string <date-time>
id
string
itemId
string
message
string
organizationId
string
reason
string
timeStamp
integer <int64>

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

Append to journal

path Parameters
id
required
string
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
{
  • "code": 0,
  • "messages": [
    ]
}

Update media info

path Parameters
id
required
string
query Parameters
workerId
required
string
organization
required
string
Request Body schema: application/json
required
audioBitDepth
integer <int64>
object (AudioLoudnessInfo)
Array of objects (AudioMapping) unique
Array of objects (AudioStream)
Array of objects (ChapterStream)
duration
integer <int64>
fileExtension
string
fileName
string
fileSize
integer <int64>
firstFrameTime
integer <int64>
format
string
frameCount
integer
frameRate
number
Array of objects (ImageStream)
languageCode
string
Array of objects (MenuStream)
Array of objects (OtherStream)
overallBitrate
integer <int64>
streamId
integer <int32>
streamOrder
integer <int32>
subtitleMedia
boolean
Array of objects (TextStream)
timecodeIn
integer <int64>
title
string
Array of objects (VideoStream)

Responses

Request samples

Content type
application/json
{
  • "audioBitDepth": 0,
  • "audioLoudnessInfo": {
    },
  • "audioMappings": [
    ],
  • "audioStreams": [
    ],
  • "chapterStreams": [
    ],
  • "duration": 0,
  • "fileExtension": "string",
  • "fileName": "string",
  • "fileSize": 0,
  • "firstFrameTime": 0,
  • "format": "string",
  • "frameCount": 0,
  • "frameRate": 0,
  • "imageStreams": [
    ],
  • "languageCode": "string",
  • "menuStreams": [
    ],
  • "otherStreams": [
    ],
  • "overallBitrate": 0,
  • "streamId": 0,
  • "streamOrder": 0,
  • "subtitleMedia": true,
  • "textStreams": [
    ],
  • "timecodeIn": 0,
  • "title": "string",
  • "videoStreams": [
    ]
}

Response samples

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

Update media info data

path Parameters
id
required
string
query Parameters
workerId
required
string
organization
required
string
Request Body schema: application/json
required
string
Enum: "VIDEO" "IMAGE" "AUDIO" "SUBTITLE" "AE_TEMPLATE" "GRAPHICS_PROJECT" "MULTI_MEDIA_CAPTION_PACKAGE" "SIDE_CAR_XML" "SCHEDULE" "UNKNOWN" "THUMBNAIL_IMAGE" "THUMBNAIL_VIDEO" "FONT"

Responses

Request samples

Content type
application/json
"VIDEO"

Response samples

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

Update media store data

path Parameters
id
required
string
query Parameters
workerId
required
string
organization
required
string
Request Body schema: application/json
required
containerName
string
objectName
string
objectURL
string
publicRead
boolean

Responses

Request samples

Content type
application/json
{
  • "containerName": "string",
  • "objectName": "string",
  • "objectURL": "string",
  • "publicRead": true
}

Response samples

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

Update metadata

path Parameters
id
required
string
query Parameters
workerId
required
string
organization
required
string
assetName
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": [
    ]
}

Update processing info

path Parameters
id
required
string
query Parameters
workerId
required
string
organization
required
string
Request Body schema: application/json
required
actor
string
bytesDone
integer <int64>
completedTasks
Array of strings unique
Items Enum: "FTP_TRANSFER" "MEDIA_STORE_UPLOAD" "MEDIA_STORE_DOWNLOAD" "TRANSCODING" "CREATING_DERIVED_OBJECTS" "QC" "POST_TRANSCODE_QC" "LIBRARY_TRANSFER" "FTP_CLEANUP" "PENDING" "DONE" "MEDIA_STORE_TRANSFER"
expires
integer <int64>
percentDone
integer <int32>
started
string <date-time>
type
string
Enum: "FTP_TRANSFER" "MEDIA_STORE_TRANSFER" "TRANSCODING" "NORMALIZING" "QC" "LIBRARY_TRANSFER" "UNDEFINED"

Responses

Request samples

Content type
application/json
{
  • "actor": "string",
  • "bytesDone": 0,
  • "completedTasks": [
    ],
  • "expires": 0,
  • "percentDone": 0,
  • "started": "2019-08-24T14:15:22Z",
  • "type": "FTP_TRANSFER"
}

Response samples

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

Update QC info

path Parameters
id
required
string
query Parameters
workerId
required
string
organization
required
string
Request Body schema: application/json
required
qcStatus
string
Enum: "UNKNOWN" "OK" "WARNING" "FAILED"
Array of objects (QCRuleMessage)

Responses

Request samples

Content type
application/json
{
  • "qcStatus": "UNKNOWN",
  • "ruleMessages": [
    ]
}

Response samples

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

Append to QC info

path Parameters
id
required
string
query Parameters
organization
required
string
Request Body schema: application/json
required
Array
rule
string
status
string
Enum: "UNKNOWN" "OK" "WARNING" "FAILED"
text
string

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

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

Release item

path Parameters
id
required
string
query Parameters
workerId
required
string
organization
required
string

Responses

Response samples

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

Change item status

path Parameters
id
required
string
query Parameters
workerId
required
string
organization
required
string
Request Body schema: application/json
required
string
Enum: "TEMPORARY" "NEW" "PENDING_DOWNLOAD" "DOWNLOADING" "PENDING_QC" "QC" "PENDING_PROCESSING" "PROCESSING" "PENDING_UPLOAD" "UPLOADING" "COMPLETE" "FAILED" "CANCELED"

Responses

Request samples

Content type
application/json
"TEMPORARY"

Response samples

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

Update system fields

path Parameters
id
required
string
query Parameters
workerId
required
string
organization
required
string
assetName
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": [
    ]
}

Update tags

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

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

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

Update derived media store data

path Parameters
parentId
required
string
id
required
string
query Parameters
workerId
required
string
organization
required
string
Request Body schema: application/json
required
containerName
string
objectName
string
objectURL
string
publicRead
boolean

Responses

Request samples

Content type
application/json
{
  • "containerName": "string",
  • "objectName": "string",
  • "objectURL": "string",
  • "publicRead": true
}

Response samples

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

Update derived object status

path Parameters
parentId
required
string
id
required
string
query Parameters
workerId
required
string
organization
required
string
Request Body schema: application/json
required
string
Enum: "TEMPORARY" "NEW" "PENDING_DOWNLOAD" "DOWNLOADING" "PENDING_QC" "QC" "PENDING_PROCESSING" "PROCESSING" "PENDING_UPLOAD" "UPLOADING" "COMPLETE" "FAILED" "CANCELED"

Responses

Request samples

Content type
application/json
"TEMPORARY"

Response samples

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

Reset all derived items

path Parameters
sourceId
required
string
query Parameters
organization
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Reset derived item

path Parameters
sourceId
required
string
id
required
string
query Parameters
organization
string

Responses

Response samples

Content type
application/json
{
  • "assetName": "string",
  • "audioTrackMapping": {
    },
  • "child": true,
  • "children": [
    ],
  • "cirrusObject": true,
  • "complete": true,
  • "completeDate": "2019-08-24T14:15:22Z",
  • "complianceRecording": true,
  • "createDate": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "emptyAsset": true,
  • "entityUpdate": "PARENT",
  • "file": {
    },
  • "fontInfo": {
    },
  • "graphicFingerPrint": "string",
  • "graphicObject": true,
  • "graphicObjectData": {
    },
  • "graphicTemplateId": "string",
  • "graphicsProjectInfo": {
    },
  • "id": "string",
  • "inTimeline": true,
  • "ingestAgentId": "string",
  • "ingestSourceId": "string",
  • "isParent": true,
  • "leaseExpires": "2019-08-24T14:15:22Z",
  • "leasedBy": "string",
  • "mediaInfo": {
    },
  • "mediaStoreObject": {
    },
  • "mediaType": "VIDEO",
  • "multimediaFileInfo": {
    },
  • "organizationId": "string",
  • "origin": {
    },
  • "parentId": "string",
  • "priority": 0,
  • "processingInfo": {
    },
  • "properties": {
    },
  • "qcInfo": {
    },
  • "recordingInfo": {
    },
  • "region": "string",
  • "retryAttempts": 0,
  • "scanOnly": true,
  • "source": {
    },
  • "sourceId": "string",
  • "status": "TEMPORARY",
  • "storeType": "S3",
  • "timelinePriority": "2019-08-24T14:15:22Z"
}

Reset ingest item

path Parameters
sourceId
required
string
query Parameters
organization
string

Responses

Response samples

Content type
application/json
{
  • "assetName": "string",
  • "audioTrackMapping": {
    },
  • "child": true,
  • "children": [
    ],
  • "cirrusObject": true,
  • "complete": true,
  • "completeDate": "2019-08-24T14:15:22Z",
  • "complianceRecording": true,
  • "createDate": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "emptyAsset": true,
  • "entityUpdate": "PARENT",
  • "file": {
    },
  • "fontInfo": {
    },
  • "graphicFingerPrint": "string",
  • "graphicObject": true,
  • "graphicObjectData": {
    },
  • "graphicTemplateId": "string",
  • "graphicsProjectInfo": {
    },
  • "id": "string",
  • "inTimeline": true,
  • "ingestAgentId": "string",
  • "ingestSourceId": "string",
  • "isParent": true,
  • "leaseExpires": "2019-08-24T14:15:22Z",
  • "leasedBy": "string",
  • "mediaInfo": {
    },
  • "mediaStoreObject": {
    },
  • "mediaType": "VIDEO",
  • "multimediaFileInfo": {
    },
  • "organizationId": "string",
  • "origin": {
    },
  • "parentId": "string",
  • "priority": 0,
  • "processingInfo": {
    },
  • "properties": {
    },
  • "qcInfo": {
    },
  • "recordingInfo": {
    },
  • "region": "string",
  • "retryAttempts": 0,
  • "scanOnly": true,
  • "source": {
    },
  • "sourceId": "string",
  • "status": "TEMPORARY",
  • "storeType": "S3",
  • "timelinePriority": "2019-08-24T14:15:22Z"
}

Job

Job API

Find jobs

Returns list of jobs by specified search parameters

query Parameters
organization
string

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

Ingest Sources

Ingest Sources API

Refresh all ingest sources

Refresh all ingest sources for organization

query Parameters
organization
required
string

Organization Id

Responses

Response samples

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

Mark ingest source listing successful

path Parameters
id
required
string
query Parameters
organization
required
string

Organization Id

Request Body schema: application/json
required
code
integer <int32>
messages
Array of strings

Responses

Request samples

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

Response samples

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

List ingest source files

List ingest source files for source id

path Parameters
id
required
string
query Parameters
organization
required
string

Organization Id

size
integer

Number of items per page (defaults to 20)

page
integer

Page number (defaults to 0)

continuationToken
string

Token from previous page response. Used for S3 compatible sources

Responses

Response samples

Content type
application/json
{
  • "files": [
    ],
  • "next": {
    }
}

Retrieves ingest source status

path Parameters
id
required
string
query Parameters
organization
required
string

Organization Id

Responses

Response samples

Content type
application/json
{
  • "failedAttempts": 0,
  • "id": "11222333",
  • "ingestSourceId": "1122333",
  • "lastAttempt": 1594137600000,
  • "nextAttempt": 1594137600000,
  • "status": "PENDING_CHECK"
}

Mark ingest source listing successful

path Parameters
id
required
string
query Parameters
organization
required
string

Organization Id

Responses

Response samples

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

Get upload URL for ingest item

Get upload URL for ingest item with source id

path Parameters
id
required
string
query Parameters
organization
required
string

Organization Id

Request Body schema: application/json
required
string

Responses

Request samples

Content type
application/json
"string"

Response samples

Content type
application/json
"string"

Refresh ingest source making it immediately available for listing

path Parameters
sourceId
required
string
query Parameters
organization
required
string

Organization Id

Responses

Response samples

Content type
application/json
{
  • "failedAttempts": 0,
  • "id": "11222333",
  • "ingestSourceId": "1122333",
  • "lastAttempt": 1594137600000,
  • "nextAttempt": 1594137600000,
  • "status": "PENDING_CHECK"
}

Ingest Queue v2

Ingest Queue API v2

Submit new items to ingest queue

path Parameters
sourceId
required
string
query Parameters
organization
required
string
Request Body schema: application/json
required
Array
checksum
string
fileId
string
fileName
string
fileSize
integer <int64>
path
string
timestamp
string <date-time>

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{ }

Render Queue

Render Queue API

Get render queue

Returns paged render queue

query Parameters
required
object (Pageable)

Organization Id

organization
required
string

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

query Parameters
organization
required
string

Organization Id

Request Body schema: application/json
required
Array of objects (RenderAssetData) unique
composition
string
Enum: "PREVIEW" "RENDER"
dateCreated
string <date-time>
dateUpdated
string <date-time>
fingerPrint
string
id
string
object (MediaStoreInfo)
object (MediaStoreObjectDTO)
organization
string
priority
integer <int32>
object (ProcessingInfo)
status
string
Enum: "PENDING" "PROCESSING" "COMPLETED" "FAILED"
object (RenderAssetData)

Responses

Request samples

Content type
application/json
{
  • "assets": [
    ],
  • "composition": "PREVIEW",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "fingerPrint": "string",
  • "id": "string",
  • "mediaStoreInfo": {
    },
  • "mediaStoreObject": {
    },
  • "organization": "string",
  • "priority": 0,
  • "processingInfo": {
    },
  • "status": "PENDING",
  • "templateData": {
    }
}

Response samples

Content type
application/json
{
  • "assets": [
    ],
  • "composition": "PREVIEW",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "fingerPrint": "string",
  • "id": "string",
  • "mediaStoreInfo": {
    },
  • "mediaStoreObject": {
    },
  • "organization": "string",
  • "priority": 0,
  • "processingInfo": {
    },
  • "status": "PENDING",
  • "templateData": {
    }
}

Delete render objects

query Parameters
organization
required
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
{
  • "empty": true
}

Get next render object

Returns next render object to process

query Parameters
workerId
required
string

Responses

Response samples

Content type
application/json
{
  • "assets": [
    ],
  • "composition": "PREVIEW",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "fingerPrint": "string",
  • "id": "string",
  • "mediaStoreInfo": {
    },
  • "mediaStoreObject": {
    },
  • "organization": "string",
  • "priority": 0,
  • "processingInfo": {
    },
  • "status": "PENDING",
  • "templateData": {
    }
}

Search for render objects

query Parameters
required
object (Pageable)

Organization Id

organization
required
string
Request Body schema: application/json
required
compositions
Array of strings unique
Items Enum: "PREVIEW" "RENDER"
customPeriod
string <date-time>
statuses
Array of strings unique
Items Enum: "PENDING" "PROCESSING" "COMPLETED" "FAILED"

Responses

Request samples

Content type
application/json
{
  • "compositions": [
    ],
  • "customPeriod": "2019-08-24T14:15:22Z",
  • "statuses": [
    ]
}

Response samples

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

Delete render object

Deletes render object

path Parameters
id
required
string
query Parameters
organization
required
string

Organization Id

Responses

Response samples

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

Get render object

Returns render object

path Parameters
id
required
string
query Parameters
organization
required
string

Organization Id

Responses

Response samples

Content type
application/json
{
  • "assets": [
    ],
  • "composition": "PREVIEW",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "fingerPrint": "string",
  • "id": "string",
  • "mediaStoreInfo": {
    },
  • "mediaStoreObject": {
    },
  • "organization": "string",
  • "priority": 0,
  • "processingInfo": {
    },
  • "status": "PENDING",
  • "templateData": {
    }
}

Update render object

Updates render object

path Parameters
id
required
string
query Parameters
organization
required
string

Organization Id

Request Body schema: application/json
required
Array of objects (RenderAssetData) unique
composition
string
Enum: "PREVIEW" "RENDER"
dateCreated
string <date-time>
dateUpdated
string <date-time>
fingerPrint
string
id
string
object (MediaStoreInfo)
object (MediaStoreObjectDTO)
organization
string
priority
integer <int32>
object (ProcessingInfo)
status
string
Enum: "PENDING" "PROCESSING" "COMPLETED" "FAILED"
object (RenderAssetData)

Responses

Request samples

Content type
application/json
{
  • "assets": [
    ],
  • "composition": "PREVIEW",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "fingerPrint": "string",
  • "id": "string",
  • "mediaStoreInfo": {
    },
  • "mediaStoreObject": {
    },
  • "organization": "string",
  • "priority": 0,
  • "processingInfo": {
    },
  • "status": "PENDING",
  • "templateData": {
    }
}

Response samples

Content type
application/json
{
  • "assets": [
    ],
  • "composition": "PREVIEW",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "fingerPrint": "string",
  • "id": "string",
  • "mediaStoreInfo": {
    },
  • "mediaStoreObject": {
    },
  • "organization": "string",
  • "priority": 0,
  • "processingInfo": {
    },
  • "status": "PENDING",
  • "templateData": {
    }
}

Fail processing

Fails processing of render object

path Parameters
id
required
string
query Parameters
workerId
required
string

Responses

Response samples

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

Finalize processing

Finalizes processing of render object

path Parameters
id
required
string
query Parameters
workerId
required
string
Request Body schema: application/json
required
bucketName
string
objectName
string
publicRead
boolean
ttl
integer <int64>
url
string

Responses

Request samples

Content type
application/json
{
  • "bucketName": "string",
  • "objectName": "string",
  • "publicRead": true,
  • "ttl": 0,
  • "url": "string"
}

Response samples

Content type
application/json
{
  • "assets": [
    ],
  • "composition": "PREVIEW",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "fingerPrint": "string",
  • "id": "string",
  • "mediaStoreInfo": {
    },
  • "mediaStoreObject": {
    },
  • "organization": "string",
  • "priority": 0,
  • "processingInfo": {
    },
  • "status": "PENDING",
  • "templateData": {
    }
}

Update processing info

Updates processing info for render object

path Parameters
id
required
string
query Parameters
workerId
required
string
Request Body schema: application/json
required
actor
string
bytesDone
integer <int64>
completedTasks
Array of strings unique
Items Enum: "FTP_TRANSFER" "MEDIA_STORE_UPLOAD" "MEDIA_STORE_DOWNLOAD" "TRANSCODING" "CREATING_DERIVED_OBJECTS" "QC" "POST_TRANSCODE_QC" "LIBRARY_TRANSFER" "FTP_CLEANUP" "PENDING" "DONE" "MEDIA_STORE_TRANSFER"
expires
integer <int64>
percentDone
integer <int32>
started
string <date-time>
type
string
Enum: "FTP_TRANSFER" "MEDIA_STORE_TRANSFER" "TRANSCODING" "NORMALIZING" "QC" "LIBRARY_TRANSFER" "UNDEFINED"

Responses

Request samples

Content type
application/json
{
  • "actor": "string",
  • "bytesDone": 0,
  • "completedTasks": [
    ],
  • "expires": 0,
  • "percentDone": 0,
  • "started": "2019-08-24T14:15:22Z",
  • "type": "FTP_TRANSFER"
}

Response samples

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

Release object

Releases render object

path Parameters
id
required
string
query Parameters
workerId
required
string

Responses

Response samples

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