Getting the Task Status
Use this API to retrieve the task status using the task ID. In the response, you can view the task type, the task status, the user who created the task, and the time taken for the task.
The API parameters are listed in Table 1: Get Task by ID.
Parameters | Name | Required | Description |
---|---|---|---|
Headers | ContentType |
Yes | Format must be "Content-Type:application/json". |
Headers | Authorization |
Yes | Contains information about the authentication access token. Format must be "Bearer 'access token'". |
Path | Id |
Yes | Contains the task ID. |
Request
GET {connector}/tasks/{id}
Response
{
"id": 7,
"type": "<task type>",
"status": "completed",
"createdBy": "username",
"created": "2021-06-03T11:49:11.391Z",
"profile": "<tenant>+<profile>",
"progress": "300 / 300 (300 processed, 0 failed)",
"finished": "2021-06-03T12:05:45.705Z",
"duration": "0d 0h 16m 34s",
"expires": "2021-06-08T12:05:45.705Z"
}