Vionlabs Tasks API
Vionlabs API for creating, retrieving and deactivating processing tasks for catalog assets and product versions. Tasks are used to orchestrate processing and expose the current state of requested work across the system. To fully understand how tasks relate to catalog items and product results, developers and integrators should consult the relevant section of the Vionlabs developer documentation.
Get Task Status
Returns the status of the processing task for the given inventory item and product version.
In: header
Path Parameters
Customer's identifier for an asset in the catalog
Specify product name
Specify product version. Example: 1.0.1
Response Body
curl -X GET "https://loading/tasks/catalog-item/string/product/adbreaks/version/string"{
"status": "pending",
"error": "string",
"_links": {
"property1": {
"href": "string",
"method": "string"
},
"property2": {
"href": "string",
"method": "string"
}
}
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}Create Task
Creates a processing task for the given inventory item and product version.
In: header
Path Parameters
Customer's identifier for an asset in the catalog
Specify product name
Specify product version. Example: 1.0.1
"low"Response Body
curl -X POST "https://loading/tasks/catalog-item/string/product/adbreaks/version/string" \ -H "Content-Type: application/json" \ -d '{ "priority": "low" }'{
"status": "pending",
"error": "string",
"_links": {
"property1": {
"href": "string",
"method": "string"
},
"property2": {
"href": "string",
"method": "string"
}
}
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}Deactivate Task
Deactivate a processing task for the given inventory item and product version.
In: header
Path Parameters
Customer's identifier for an asset in the catalog
Specify product name
Specify product version. Example: 1.0.1
Response Body
curl -X DELETE "https://loading/tasks/catalog-item/string/product/adbreaks/version/string"{
"status": "pending",
"error": "string",
"_links": {
"property1": {
"href": "string",
"method": "string"
},
"property2": {
"href": "string",
"method": "string"
}
}
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}Get Task Status
Returns the status of the processing task for the given inventory item.
In: header
Path Parameters
Customer's identifier for an asset in the catalog
Response Body
curl -X GET "https://loading/tasks/catalog-item/string"[
{
"task_status": {
"status": "pending",
"error": "string"
},
"product": "string",
"version": "string"
}
]{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}