Request Parameters
Parameter
|
Description
|
Mandatory
|
id
|
Group identifier.
This parameter can be defined in the request several times to update components on stations of several groups at a time.
|
yes
|
Request Example
http://192.168.1.1:9080/api/groups/reboot.ds?id=4&message=reboot%20now
Response Documents Structure
•XML response. •JSON response. XML Response Structure
<drweb-avdesk-api api_version="4.1.3" timestamp="1403763797"
server="192.168.1.1" srv_version="10.01.0.201707130" status="true">
<stations total="3">
<station id="d071625c-d21d-b211-9bc4-bc02713bf843" status="delayed"/>
<station id="70200e02-d21d-b211-8a39-a00ca2f8be36" status="delayed"/>
<station id="e8702ab1-a176-4aef-8660-f01851fcae80" status="initiated"/>
</stations>
</drweb-avdesk-api>
|
Description of XML Response Parameters
The <station /> element contains information on specific stations on which components update has been launched.
The <station /> element attributes:
Attribute
|
Description
|
id
|
Station identifier
|
status
|
The state of update process. May take the following values:
•delayed—update is delayed, •failed—update is failed, •initiated—update is initiated. |
JSON Response Structure
{ "head": {
"status": true,
"timestamp": 1395389925,
"api": {
"version": 40103
},
"server": {
"name": "192.168.1.1",
"version": 1000201707130,
"uuid": "50171907-d21d-b211-b3fd-cc152f024d8c"
}
},
"data": {
"total": 0,
"list": {
"10001": "delayed"
}
}
}
|
Description of JSON Response Parameters
The data contains information on all stations on which components update has been launched.
The data block elements:
Field name
|
Description
|
total
|
Total number of stations on which components update has been launched.
|
•The list block contains information on specific stations on which components update has been launched. The list block elements:
Field name
|
Description
|
Identifier of a station on which the update launched
|
The state of update process. May take the following values:
•delayed—update is delayed, •failed—update is failed, •initiated—update is initiated. |
|