ON THIS PAGE
GET /config/extension_management/extension_export_tasks/{task_id}
SUMMARY Retrieves the tasks status based on the task_id.
Retrieves the tasks status based on the task_id.
MIME Type |
---|
application/json |
Parameter | Type | Optionality | Data Type | MIME Type | Description |
---|---|---|---|---|---|
task_id |
path |
Required |
Number (Integer) |
text/plain |
null |
fields |
query |
Optional |
String |
text/plain |
Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets and multiple fields in the same object are separated by commas. |
HTTP Response Code | Unique Code | Description |
---|---|---|
200 |
The requested task status has been retrieved. |
|
404 |
22604 |
The task status for status_id cannot be found. |
422 |
22606 |
A supplied numeric parameter was not positive. |
500 |
22602 |
An error has occurred while trying to retrieve the task status. |
Response Description
- id - Number - The ID of the task status.
- name - String - The name of the task status.
- status - String - A string that represents the current state of the task status.
- message - String - A message regarding the current state of the task.
- progress - Number - The current progress of the task
- minimum - Number - The minimum progress of the task.
- maximum - Number - The maximum progress of the task.
- created_by - String - The username of the user who created the task.
- cancelled_by - String - The username of the user who cancelled the task.
- created - Number - The date/time at which this task was created, represented as number of milliseconds since Unix epoch.
- started - Number - The date/time at which this task was started, represented as number of milliseconds since Unix epoch.
- modified - Number - The date/time at which this task was last modified, represented as number of milliseconds since Unix epoch.
- completed - Number - The date/time at which this task was completed, represented as number of milliseconds since Unix epoch.
- result_url - String - The url where the result can be viewed.
- cancel_requested - Boolean - True if cancel has been requested.
- child_tasks - Array - Array of child task id's that are executed asynchronously from this task.
- task_components - Array - Array of task components that are executed sequentially.
Response Sample
{ "progress": 0, "result_url": "", "cancelled_by": "", "status": "COMPLETED", "task_components": null, "modified": 1440891517961, "id": 102, "message": "Completed Extension uninstallation task for extension id 56", "created_by": "admin", "created": 1440891514006, "maximum": 0, "cancel_requested": false, "name": "Extension uninstallation task", "child_tasks": null, "started": 1440891514041, "completed": 1440891515224 }