async_status/{{id}}

GET

Returns a status update for an asynchronous task.

Auth. Required:

Yes

Roles Required:

“admin” or “operations”

Permissions Required:

ASYNC-STATUS:READ

Response Type:

Object

Request Structure

Table 449 Request Path Parameters

Name	Required	Description
id	yes	The integral, unique identifier for the desired asynchronous job status. This will be provided when the asynchronous job is started.

Response Structure

id:

The integral, unique identifier for the asynchronous job status.

status:

The status of the asynchronous job. This will be PENDING, SUCCEEDED, or FAILED.

start_time:

The time the asynchronous job was started.

end_time:

The time the asynchronous job completed. This will be null if it has not completed yet.

message:

A message about the job status.

#1121 Response Example

HTTP/1.1 200 OK
Content-Type: application/json

{ "response":
    {
        "id":1,
        "status":"PENDING",
        "start_time":"2021-02-18T17:13:56.352261Z",
        "end_time":null,
        "message":"Async job has started."
    }
}