Asynchronous Tasks

Please make sure to read the Introduction to the REST API before starting to use it.

This page describes all rest endpoints which are related to asynchronous tasks. Asynchronous tasks are used in various endpoints of our REST API in order to start long-running tasks in Backbone. This resource can be used in order to get the status of these tasks and the result.

Method	URL	Description
GET	/async-tasks/{taskId}	Returns status information about the asynchronous task. If finished, it also includes the result.

Detailed description

Get Status

GET /async-tasks/{taskId}

Returns status information about the asynchronous task. If finished, it also includes the result. Please note that you can only return information for tasks started with the same user.

URL Parameter	Description	Default	Required
taskId	The task id of the asynchronous task. This is returned by the endpoints which start an asynchronous task.	-

Note: If the calling user does not have system administration permissions, you need to provide an additional HTTP header containing the project

HTTP Header	Description	Default	Required
prj	The project key of a project this user has project administration rights for.	-	-

Example Response

The endpoint will return an object containing the details about the asynchronous task.

CODE

{
    "id": "53A90124015DAC398C292BBD70979338",
    "completionTimestamp": "Aug 04, 2017 -- 09:51 AM",
    "startTimestamp": "Aug 04, 2017 -- 09:51 AM",
    "result": true,
    "finished": true,
    "cancelled": false,
    "hasFailed": false,
    "failureMessage": null,
    "progress": 0,
    "message": "Successfully stopped the integration.",
    "resourceLocation": null
}