Параметр запроса
Параметр
|
Описание
|
Обязательный
|
id
|
Идентификатор группы.
Параметр может быть указан в запросе неограниченное количество раз для обновления компонентов на станциях нескольких групп одновременно.
|
да
|
Пример запроса
https://192.168.1.1:9081/api/groups/update-components.ds?id=123123123
|
Ниже представлены примеры ответов в формате XML и в формате JSON.
Ответ в формате XML
<drweb-es-api api_version="4.3.2" timestamp="1582521923" server="192.168.1.1" srv_version="13.00.0.202005090" 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>
|
Описание параметров ответного XML
Элемент <stations /> содержит информацию о запуске обновления компонентов на станциях в группах, указанных в запросе.
Атрибут элемента <stations />:
Атрибут
|
Описание
|
total
|
Общее количество станций в ответе
|
•Элемент <station /> содержит информацию о запуске обновления компонентов на конкретной станции.
Атрибуты элемента <station />:
Атрибут
|
Описание
|
id
|
Идентификатор станции
|
status
|
Статус запуска обновления компонентов:
•delayed — обновление отложено,
•failed — обновление завершилось с ошибкой,
•initiated — обновление инициировано. |
Ответ в формате JSON
{ "head": {
"status": true,
"timestamp": 1582522006,
"api": {
"version": 40302,
"versionString": "4.3.2"},
"server": {
"name": "192.168.1.1",
"version": "13.00.0.202005090",
"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"}}}
|
Описание параметров ответного JSON
Блок data содержит информацию о запуске обновления компонентов на станциях в группах, указанных в запросе.
Элементы блока data:
Название поля
|
Описание
|
total
|
Общее количество станций в ответе
|
list
|
Блок с результатами запуска обновления компонентов для каждой станции
|
•Элементы блока list:
Название поля
|
Описание
|
Идентификатор станции
|
Статус запуска обновления компонентов:
•delayed — обновление отложено,
•failed — обновление завершилось с ошибкой,
•initiated — обновление инициировано. |
|