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

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

Параметр

Описание

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

id

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

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

да

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

 

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

http://192.168.1.1:9080/api/groups/components.ds?id=gr1

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

 

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

<drweb-es-api api_version="4.3.0" timestamp="1551789582" server="192.168.1.1" srv_version="12.00.0.201909260" status="true">
  <groups total="1">
    <group id="gr1">
        <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" />

          <component code="14" name="SpIDer Mail for Windows workstations" status="1" />

          <component code="38" name="SpIDer Gate for Windows workstations" status="1" />

          <component code="54" name="Dr.Web Office Control" status="1" />

          <component code="55" name="Dr.Web Antispam" status="1" />

          <component code="57" name="SpIDer Guard for Windows workstations" status="1" />

          <component code="58" name="SpIDer Guard for Windows servers" status="1" />

          <component code="103" name="Dr.Web plug-in for MS Outlook" status="1" />

          <component code="105" name="Dr.Web Firewall" status="1" />

          <component code="30" name="Dr.Web Agent for Windows" status="2" />

          <component code="37" name="Dr.Web Agent Scanner for Windows" status="2" />
          <component code="39" name="Dr.Web Agent for UNIX" status="2" />
        </components>
    </group>
  </groups>
</drweb-es-api>

 

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

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

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

Атрибут

Описание

total

Общее количество групп станций, информация о которых приведена в ответе

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

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

Атрибут

Описание

id

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

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

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

Атрибут

Описание

total

Общее количество всех компонентов

inherited

Если принимает значение true, то компоненты унаследованы от родительской группы, если false — параметры компонентов заданы индивидуально.

inherited_group_id

Идентификатор родительской группы, от которой унаследованы параметры компонентов. Если атрибут inherited принимает значение false, то значение данного атрибута будет none.

inherited_group_name

Название родительской группы, от которой унаследованы параметры компонентов. Если атрибут inherited принимает значение false, то значение данного атрибута будет none.

Элемент <component /> содержит информацию о конкретном устанавливаемом компоненте.

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

Атрибут

Описание

code

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

name

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

status

Статус компонента. Может принимать значения:

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

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

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

 

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

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

    "timestamp": 1550514156,

    "api": {
      "version": 40300,
      "versionString": 4.3.0},

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

      "version": "12.00.0.201909260",
      "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": "gr1",

      "inherited": true,

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

 

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

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

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

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

Описание

total

Общее количество групп станций, информация о которых приведена в ответе

Массив list содержит информацию о конкретных запрашиваемых группах станций.

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

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

Описание

group_id

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

inherited

Если принимает значение true, то компоненты унаследованы от родительской группы, если false — параметры компонентов заданы индивидуально.

inherited_group_id

Идентификатор родительской группы, от которой унаследованы параметры компонентов. Если атрибут inherited принимает значение false, то значение данного атрибута будет none.

inherited_group_name

Название родительской группы, от которой унаследованы параметры компонентов. Если атрибут inherited принимает значение false, то значение данного атрибута будет none.

Массив components содержит информацию о устанавливаемых компонентах группы.

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

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

Описание

code

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

name

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

status

Статус компонента. Может принимать значения:

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

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

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