|
Request Parameter
Parameter
|
Description
|
Mandatory
|
id
|
Group ID.
This parameter can be repeated any number of times per request to update components on stations in multiple groups at a time.
|
yes
|
Request Example
https://192.168.1.1:9081/api/groups/update-components.ds?id=123123123
|
XML and JSON response structure examples are described below.
XML Response Structure
<drweb-es-api api_version="4.3.2" timestamp="1582521923" server="192.168.1.1" srv_version="13.00.1.202310121" 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-es-api>
|
Description of XML Response Parameters
The <stations /> element contains information about component update initiated on stations in groups specified in the request.
The <stations /> element attribute:
Attribute
|
Description
|
total
|
Total number of stations in a response
|
•The <station /> element contains information about component update initiated on a specific station.
The <station /> element attributes:
Attribute
|
Description
|
id
|
Station ID
|
status
|
Initiated component update status:
•delayed—update was delayed,
•failed—update failed,
•initiated—update was initiated. |
JSON Response Structure
{ "head": {
"status": true,
"timestamp": 1582522006,
"api": {
"version": 40302,
"versionString": "4.3.2"},
"server": {
"name": "192.168.1.1",
"version": "13.00.1.202310121",
"uuid": "27671337-e0b0-4f60-aeb0-ab1f2ca47f77"}},
"data": {
"total": 3,
"list": {
"d071625c-d21d-b211-9bc4-bc02713bf843": "delayed",
"70200e02-d21d-b211-8a39-a00ca2f8be36": "delayed",
"e8702ab1-a176-4aef-8660-f01851fcae80": "initiated"}}}
|
Description of JSON Response Parameters
The data block contains information about component update initiated on stations in groups specified in the request.
The data block elements:
Field name
|
Description
|
total
|
Total number of stations in a response
|
list
|
Block containing initiated component update results for each station
|
•The list block elements:
Field name
|
Description
|
Station ID
|
Initiated component update status:
•delayed—update was delayed,
•failed—update failed,
•initiated—update was initiated. |
|