Vionlabs Docs

Vionlabs Tasks API

Get Task Status

Returns the status of the processing task for the given inventory item and product version.

GET
/tasks/catalog-item/{inventory_id}/product/{product}/version/{version}
key<token>

In: query

Path Parameters

inventory_idInventory Id

Customer identifier for a movie or series item in the catalog

productProductType

Specify product name

versionVersion

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.

POST
/tasks/catalog-item/{inventory_id}/product/{product}/version/{version}
key<token>

In: query

Path Parameters

inventory_idInventory Id

Customer identifier for a movie or series item in the catalog

productProductType

Specify product name

versionVersion

Specify product version. Example: 1.0.1

priority?TaskPriority
Default"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.

DELETE
/tasks/catalog-item/{inventory_id}/product/{product}/version/{version}
key<token>

In: query

Path Parameters

inventory_idInventory Id

Customer identifier for a movie or series item in the catalog

productProductType

Specify product name

versionVersion

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.

GET
/tasks/catalog-item/{inventory_id}
key<token>

In: query

Path Parameters

inventory_idInventory Id

Customer identifier for a movie or series item 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"
    }
  ]
}