Ingest

Download OpenAPI specification:

Ingest Queue

Ingest Queue API

getHistoryObjects_1

You have found a cookie

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

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

Check ingest source connection Deprecated

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>
Array of objects (IngestFileNameMapping) unique
graphicsUploadSource
boolean
host
string
id
string
internal
boolean
internalUploadSource
boolean
object (JumpHostSettings)
manualListing
boolean
musicKitIntegration
boolean
name
string
nullifySubtitleTimecode
boolean
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
subtitleTimecodeOffset
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",
  • "fileNameReplacementMappings": [
    ],
  • "graphicsUploadSource": true,
  • "host": "string",
  • "id": "string",
  • "internal": true,
  • "internalUploadSource": true,
  • "jumpHostSettings": {
    },
  • "manualListing": true,
  • "musicKitIntegration": true,
  • "name": "string",
  • "nullifySubtitleTimecode": true,
  • "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",
  • "subtitleTimecodeOffset": "string",
  • "tags": [
    ],
  • "timecodeIn": 0,
  • "type": "FTP",
  • "videoConversionEnabled": true,
  • "videoConversionExtensions": [
    ]
}

Response samples

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

Ingest

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

Get journal

Get journal for item

path Parameters
id
required
string
query Parameters
organization
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

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

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

Start multipart upload on ingest source

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

Responses

Request samples

Content type
application/json
"string"

Response samples

Content type
application/json
{
  • "fileName": "string",
  • "parts": [
    ],
  • "sourceId": "string",
  • "uploadId": "string"
}

Get multipart upload url

path Parameters
uploadId
required
string
query Parameters
organization
required
string
filename
required
string
partNumber
required
integer <int32>
partSize
required
integer <int64>

Responses

Response samples

Content type
application/json
"string"

Complete multipart upload url

path Parameters
uploadId
required
string
query Parameters
organization
required
string
Request Body schema: application/json
required
fileName
string
Array of objects (UploadPart)
sourceId
string
uploadId
string

Responses

Request samples

Content type
application/json
{
  • "fileName": "string",
  • "parts": [
    ],
  • "sourceId": "string",
  • "uploadId": "string"
}

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

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
}

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