Date: Fri, 29 Mar 2024 07:26:53 +0000 (UTC) Message-ID: <750009675.11335.1711697213670@catch-kbase-p> Subject: Exported From Confluence MIME-Version: 1.0 Content-Type: multipart/related; boundary="----=_Part_11334_1552943322.1711697213669" ------=_Part_11334_1552943322.1711697213669 Content-Type: text/html; charset=UTF-8 Content-Transfer-Encoding: quoted-printable Content-Location: file:///C:/exported.html
The Background Task resource allows you to retrieve the details of a cur= rently executed or completed task. This includes information related to the= progress (% completed) of the task.
This resource supports the following methods: GET
Retrieves the status of a running or completed job. Note that after some= time completed jobs will be flushed. At this point, this method will retur= n a '404 Not Found' response.
These are the expected status codes returned by the service. In addition= , some other status codes may be returned if either an internal error occur= s or there is an authentication issue (such as an expired OAuth token).
Status | Description |
---|---|
200 - OK | Returned if the request was completed successful= ly. |
404 - NotFound | Returned if no job was found with the sepcified = identifier. |
Example of retrieving the progress status for a task that is running in = the background.
Request Headers
Key | Value | Description |
---|---|---|
Accept | application/json |
Request Parameters
Key | Value | Description |
---|---|---|
{id} | reindex-7bdba522-590a-4df4-b409-a293985124= 1b | The Unique identifier of the job (string). |
Response Headers
Key | Value | Description |
---|---|---|
Content-Type | application/json; charset=3Dutf-8 |
Response Body
{ "Complete": false, "TotalElements": 10, "ProcessedElements": 5, "StartedAt": "2011-12-31T11:00:00Z", "ProgressInPercent": 0.5, "Id": "reindex-7bdba522-590a-4df4-b409-a2939851241b", "Message": "Reticulating Splines", "Self": "http://localhost/api/backgroundtask/reindex-7bdba522-590a-4df4-b= 409-a2939851241b" }
Status Code
200 - OK
Example of retrieving the progress for a task that has finished.
Request Headers
Key | Value | Description |
---|---|---|
Accept | application/json |
Request Parameters
Key | Value | Description |
---|---|---|
{id} | reindex-7bdba522-590a-4df4-b409-a293985124= 1b | Unique identifier of the job (string) |
Response Headers
Key | Value | Description |
---|---|---|
Content-Type | application/json; charset=3Dutf-8 |
Response Body
{ "Complete": true, "TotalElements": 10, "ProcessedElements": 10, "StartedAt": "2011-12-31T12:00:00Z", "FinishedAt": "2011-12-31T12:10:14Z", "ProgressInPercent": 1.0, "Id": "reindex-7bdba522-590a-4df4-b409-a2939851241b", "Message": "Task Completed", "Self": "http://localhost/api/backgroundtask/reindex-7bdba522-590a-4df4-b= 409-a2939851241b" }
Status Code
200 - OK