Получение списка устанавливаемых компонентов для группы

Параметр запроса

Параметр

Описание

Обязательный

Идентификатор группы.

Параметр может быть указан в запросе неограниченное количество раз для получения списков устанавливаемых компонентов для нескольких групп одновременно.

да

Если в группе есть станции, работающие под операционной системой Windows, то ответный документ будет содержать список компонентов, устанавливаемых на эти станции, в других случаях список будет пуст.

Пример запроса

https://192.168.1.1:9081/api/groups/components.ds?id=7ec98a70-5c83-11ea-512f-70a167e08535

Ниже представлены примеры ответов в формате XML и в формате JSON.

Ответ в формате XML

<drweb-es-api api_version="4.3.2" timestamp="1581789582" server="192.168.1.1" srv_version="13.00.0.202005090" status="true">
<groups total="1">
<group id="7ec98a70-5c83-11ea-512f-70a167e08535">
<components total="12" inherited="true" inherited_group_id="20e27d73-d21d-b211-a788-85419c46f0e6" inherited_group_name="Everyone">
<component code="4" name="Dr.Web Scanner for Windows" status="1" />

Описание параметров ответного XML

Элемент <groups /> содержит информацию обо всех устанавливаемых компонентах для групп, указанных в запросе.

Атрибут элемента <groups />:

Атрибут	Описание
total	Общее количество групп в ответе

•Элемент <group /> содержит информацию о конкретной группе.

Атрибут элемента <group />:

Атрибут	Описание
id	Идентификатор группы

▫Элемент <components /> содержит информацию об устанавливаемых компонентах для конкретной группы.

Атрибуты элемента <components />:

Атрибут	Описание
total	Общее количество устанавливаемых компонентов
inherited	Если принимает значение true, то компоненты унаследованы от родительской группы, если false — параметры компонентов заданы индивидуально.
inherited_group_id	Идентификатор родительской группы, от которой унаследованы параметры компонентов. Если атрибут inherited принимает значение false, то значение данного атрибута будет пустым.
inherited_group_name	Название родительской группы, от которой унаследованы параметры компонентов. Если атрибут inherited принимает значение false, то значение данного атрибута будет пустым.

▪Элемент <component /> содержит параметры конкретного устанавливаемого компонента.

Атрибуты элемента <component />:

Атрибут

Описание

code

Числовой код компонента (см. Приложение Б2. Коды компонентов)

name

Название компонента (см. Приложение Б2. Коды компонентов)

status

Статус компонента:

2 — компонент должен быть установлен,

1 — компонент может быть установлен,

0 — компонент не должен быть установлен.

Ответ в формате JSON

{ "head": {
"status": true,

"timestamp": 1580514156,

"api": {
"version": 40302,
"versionString": "4.3.2"},

"server": {
"name": "192.168.1.1",

"version": "13.00.0.202005090",
"uuid": "70c5f522-aaab-4c93-a180-a442a0da9c2a"}},

"data": {
"total": 1,

"list": [{
"components": [
{"code": 4,
"name": "Dr.Web Scanner for Windows",
"status": 1},

{"code": 14,
"name": "SpIDer Mail for Windows workstations",
"status": 1},

{"code": 38,
"name": "SpIDer Gate for Windows workstations",
"status": 1},

{"code": 54,
"name": "Dr.Web Office Control",
"status": 1},

{"code": 55,
"name": "Dr.Web Antispam",
"status": 1},

{"code": 57,
"name": "SpIDer Guard for Windows workstations",
"status": 1},

{"code": 58,
"name": "SpIDer Guard for Windows servers",
"status": 1},

{"code": 103,
"name": "Dr.Web plug-in for MS Outlook",
"status": 1},

{"code": 105,
"name": "Dr.Web Firewall",
"status": 1},

{"code": 30,
"name": "Dr.Web Agent for Windows",
"status": 2},

{"code": 37,
"name": "Dr.Web Agent Scanner for Windows",
"status": 2},

{"code": 39,
"name": "Dr.Web Agent for UNIX",
"status": 2}],

"group_id": "7ec98a70-5c83-11ea-512f-70a167e08535",

"inherited": true,

"inherited_group_id": "20e27d73-d21d-b211-a788-85419c46f0e6",
"inherited_group_name": "Everyone"}]}}

Описание параметров ответного JSON

Блок data содержит информацию обо всех устанавливаемых компонентах для групп, указанных в запросе.

Элементы блока data:

Название поля	Описание
total	Общее количество групп в ответе
list	Массив с информацией об устанавливаемых компонентах для каждой группы

•Каждый объект массива list содержит информацию об устанавливаемых компонентах для конкретной группы.

Элементы объектов в массиве list:

Название поля	Описание
components	Массив с параметрами для каждого устанавливаемого компонента конкретной группы
group_id	Идентификатор группы
inherited	Если принимает значение true, то компоненты унаследованы от родительской группы, если false — параметры компонентов заданы индивидуально.
inherited_group_id	Идентификатор родительской группы, от которой унаследованы параметры компонентов. Данный элемент будет отсутствовать, если элемент inherited принимает значение false.
inherited_group_name	Название родительской группы, от которой унаследованы параметры компонентов. Данный элемент будет отсутствовать, если элемент inherited принимает значение false.

▫Каждый объект массива components содержит информацию о конкретном устанавливаемом компоненте.

Элементы объектов в массиве components:

Название поля

Описание

code

Числовой код компонента (см. Приложение Б2. Коды компонентов)

name

Название компонента (см. Приложение Б2. Коды компонентов)

status

Статус компонента:

2 — компонент должен быть установлен,

1 — компонент может быть установлен,

0 — компонент не должен быть установлен.