GET /tasks/locks
Use this method to return information about all job (task) locks for all managed devices.
Authentication
Authentication with username and password is required.
Request URL
GET https://{management_server_IP}/tasks/locks
Query parameters
None
Request body
None
Response codes
| Code | Description | Comments |
|---|---|---|
| 200 | OK | The request completed successfully. |
| 401 | Unauthorized | The user cannot be authenticated. Authentication has not been provided or has failed. 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. |
| 500 | Internal Server Error | An internal error occurred. A descriptive error message is returned in the response body. |
Response body
The response body is an array of one or more JSON objects with the following attributes. Each object represents a specific device. Each device can also contain a JSON array of jobs that have a lock on that device.
If a device has been locked by a previous operation, but does not currently possess any locks, it will show an empty JSON array of jobs. If a device has not yet been locked by a job, the device will not show up in the list.
| Attributes | Type | Description | |||
|---|---|---|---|---|---|
| jobs | Array of objects | Information about each job lock | |||
| id | Integer | Job ID of each job that has a lock on the device | |||
| uuid | String | UUID of the device that has been locked by a job | |||
The following example is returned if the request is successful.
[{
"jobs": [
{"id": 3},
{"id":7},
{"id": 12}
],
"uuid": "AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA"
},
...,
{
"jobs": [
{"id": 3},
{"id": 5},
{"id": 34}
],
"uuid": "BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB"
}]
Give documentation feedback