Live2VOD for Organization

Get Task

Get a L2V task with the taskID.

get/v2/{org}/channels/{channel-id}/tasks/{task-id}

Request

  • Base URL: https://api.istreamplanet.com
  • URL: https://api.istreamplanet.com/v2/{org}/channels/{channel-id}/tasks/{task-id}
  • Auth: authcode (defined in the document in a form this page cannot read) and m2m (defined in the document in a form this page cannot read)

Path parameters

orgstring required

Organization name

channel-idstring required

Unique channel identifier

task-idstring required

Task ID for a l2v request

Response

OK

$schemastring uri

A URL to the JSON Schema for this object.

createdstring date-time required

when the task was created in RFC3339Nano format

doneboolean required

indicates if the task is done or not

endedstring date-time required

when the task ended in RFC3339Nano format

errorstring required

error message if any for this task

failure_countinteger required

number of times the task failed

idstring required

ID for the task

paramsstring required

params sent to task

progressnumber double required

the progress of the task

region'US_WEST' | 'US_EAST'

Region represents the general geolocation the task is in.

statusstring required

status for the task

succeededboolean required

indicates if the task succeeded or not

typeinteger required

type of task

weightinteger required

priority

workerVersionstring required

the version of the worker for this task

worker_idinteger required

the id of the worker for the task

Example response

{
  "$schema": "https://api.istreamplanet.com/schemas/GetTaskResponseBody.json",
  "created": "2006-01-02T15:04:05.9999Z",
  "ended": "2006-01-02T15:04:05.9999Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.