Overview

This article describes the structure and fields of task objects returned in JetPatch API responses.

It details each field's type and purpose, including URL references, task state information, error handling, and date formatting in JSON format.

When an API response includes a task object, the object includes the following fields, in JSON format:

Field	Type	Description
url	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>
resourceUrl	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.
state	string	One of:
errorData	string	In case of an error, an error description
startDate	long	Provided only when the task is complete, in java standard date.util format (number of seconds since the beginning of 1970).
endDate	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.