Get Task Status Using GET

Get Task Status Using GET

In general, to get the status of any long running operations, the operation must have been initiated through the vRealize Operations Manager REST API. This API returns the status of a specific task that was initiated via the REST API
with the exception of tasks that get created when any Remediation Action is performed via the api/actions endpoint.

Request
URI
GET
https://{api_host}/api/tasks/{id}
COPY
Path Parameters
string
id
Required

The id of the task


Authentication
This operation uses the following authentication methods.
Responses
200

Task status with the specified identifier

Returns task-status of type(s) application/json
{
    "createdTime": 0,
    "description": "string",
    "errorMessages": [
        "string"
    ],
    "lastUpdateTime": 0,
    "links": [
        {
            "description": "string",
            "href": "string",
            "name": "string",
            "rel": "string"
        }
    ],
    "statusMessage": "string",
    "taskId": "string",
    "taskState": "string"
}
integer As int64 As int64
createdTime
Optional

Task status creation time, in milliseconds (since midnight January 1, 1970)

string
description
Optional

A description for the task

array of string
errorMessages
Optional

List of error messages that occurred

integer As int64 As int64
lastUpdateTime
Optional

Task status last update time, in milliseconds (since midnight January 1, 1970)

array of link
links
Optional

links

string
statusMessage
Optional

Optional status message

string As uuid As uuid
taskId
Optional

The task identifier

string
taskState
Optional

The state of the task

Possible values are : INITIATED, STOPPED, RUNNING, FINISHED, ERROR, ABORTED, UNKNOWN,

404

No Task is found with the specified identifier

Operation doesn't return any data structure