When an API response includes a task object, the object includes the following fields, in JSON format:
Field |
Type |
Description |
---|---|---|
|
URL |
The resource URL for the task, to be used for checking task status. The provided URL is referred to in this guide as <task-url> |
|
URL |
Where relevant, the resource URL of the object upon which the task is performed. For some requests, may be defined only when the task is completed; for some requests, may no longer exist once the task is completed. |
|
string |
One of:
|
|
string |
In case of an error, an error description |
|
long |
Provided only when the task is complete, in java standard date.util format (number of seconds since the beginning of 1970. |
|
long |
For example:
Content-Type: vnd.intigua.vmanager.Task+json
{
"url":"/vmanage-server/rest/rest-api/tasks/activity_194",
"resourceUrl":"/servers/81/connector",
"state":"inprogress"
}
The response also includes an ETag, for subsequently tracking task progress.
Comments
0 comments
Please sign in to leave a comment.