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": 0,
    "start_time": 0,
    "complete_time": 0
}
string
id
Required

The ID of the task.

string
description
Optional

The description of the task.

string
description_id
Optional

The ID of the description of the task.

string
entity
Optional

Entity the task is executed upon.

string
entity_name
Optional

Name of the entity the task is executed upon.

string
status
Required

The status of the task.

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

The information about the task result if the task status is SUCCESS.

integer As int32 As int32
progress
Optional
Constraints: minimum: 0 maximum: 100

The progress of the task, in percentage number.

integer As int64 As int64
queued_time
Optional

The queued time of the task, in milliseconds.

integer As int64 As int64
start_time
Optional

The start time of the task, in milliseconds.

integer As int64 As int64
complete_time
Optional

The complete time of the task, in milliseconds.

Property Of
Used By