Task

Task
Task

Information about a task

JSON Example
{
    "id": "string",
    "description": "string",
    "description_id": "string",
    "entity": "string",
    "entity_name": "string",
    "status": "string",
    "error": {
        "message": "string",
        "details": "string"
    },
    "result": {},
    "progress": 0,
    "queued_time": "string",
    "start_time": "string",
    "complete_time": "string"
}
string
id
Optional

id

string
description
Optional

Description of the task

string
description_id
Optional

Description ID of the task

string
entity
Optional

The entity upon which this task is executed

string
entity_name
Optional

Entity name

string
status
Optional

status

Possible values are : QUEUED, RUNNING, SUCCESS, ERROR, CANCELLED,
TaskError
error
Optional

Detailed information of the error if the task status is ERROR.

object
result
Optional

Information about the task result if the task status is SUCCESS

integer As int32 As int32
progress
Optional

progress

string As date-time As date-time
queued_time
Optional

Queued time

string As date-time As date-time
start_time
Optional

Start time of the task

string As date-time As date-time
complete_time
Optional

Complete time of the task

Property Of
Used By