GET /updateRepositories/firmware/status
Use this method to return the status for a repository task.
Authentication
Authentication with username and password is required.
Request URL
GET https://{management_server_IP}/updateRepositories/firmware/status
Query parameters
| Parameters | Required / Optional | Description |
|---|---|---|
| taskType=EXPORTREPOSITORY | Required | Type of repository task for which to retrieve status. This can be the following value.
|
| taskid={task_id} | Required | Job (task) ID that is returned by the PUT /updateRepositories/firmware?action=export method for collecting (exporting) firmware updates and UpdateXpress System Packs (UXSPs) in a .zip file. If 0 is specified, the status for all running tasks is returned. |
The following example returns the status for a specific export job.
GET https://192.0.2.0/updateRepositories/firmware/status?tasktype=EXPORTREPOSITORY&taskid=12
Request body
None
Response codes
| Code | Description | Comments |
|---|---|---|
| 200 | OK | The request completed successfully. |
| 400 | Bad Request | A query parameter or request attribute is missing or not valid, or the operation is not supported. A descriptive error message is returned in the response body. |
| 403 | Forbidden | The orchestrator server was prevented from fulfilling the request. A descriptive error message is returned in the response body. Ensure that you have privileges to perform the request. |
| 409 | Conflict | There is a conflict with the current state of the resource. A descriptive error message is returned in the response body. |
| 500 | Internal Server Error | An internal error occurred. A descriptive error message is returned in the response body. |
Response body
| Attributes | Type | Description | ||
|---|---|---|---|---|
| current | String | Name of the ZIP file | ||
| downloadednum | Integer | Number of firmware-update and UXSPs that is currently exported Tip After the export is complete, the download number is the same as the total. | ||
| downloadedsize | Integer | Size of the .zip file that is currently exported Tip After the export is complete, the download size is the same as the total size. | ||
| progress | Integer | Percentage complete of the bulk management job. This can be one of the following values
| ||
| state | String | This can be one of the following values.
| ||
| taskIds | String | ID of the task that collected the files. | ||
| total | Integer | Total number of firmware-update and UXSPs in the .zip file | ||
| totalsize | Integer | Total size of the .zip file | ||
| updates | Array | |||
| errorMsg | Array | Information about one or more messages. | ||
| messages | Array | Message. | ||
| id | String | The message identifier of a returned message. | ||
| text | String | Message text associated with the message identifier. | ||
| result | String | The results of the request . This can be one of the following values.
| ||
The following example is returned if the request is successful.
{
"current": "repository20181112011742.zip",
"downloadednum": 0,
"downloadedsize": 8298,
"progress": 100,
"state": "complete",
"taskIds": "",
"total": 0,
"totalsize": 8298,
"updates": [],
"errorMsg": {
"result": "informational",
"messages": [{
"id": "FQXHMUP2500I",
"text": "Repository operation completed successfully."
}]
}
}
Give documentation feedback