Task

Task
Task

Info about a task

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

id

string
description
Optional

description

string
description_id
Optional

description_id

string
entity
Optional

The entity this task is executed upon

string
entity_name
Optional

entity_name

string
status
Required

status

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

error

object
result
Optional

Information about the task result if the task status is SUCCESS

integer As int32 As int32
progress
Optional

Current progress of the task

string As date-time As date-time
queued_time
Optional

queued_time

string As date-time As date-time
start_time
Optional

start_time

string As date-time As date-time
complete_time
Optional

complete_time

Property Of
Used By