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

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

Параметр

Описание

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

id

Идентификатор станции.

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

да

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

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

https://192.168.1.1:9081/api/stations/components.ds?id=1001&id=1002

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

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

<drweb-es-api api_version="4.3.2" timestamp="1589406721" server="192.168.1.1" srv_version="13.00.1.202310121" status="true">

  <stations total="2">

     <station id="1001">

        <components total="11" 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"/>

          <!-- etc. Skipped in documentation -->

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

        </components>

     </station>

     <station id="1002">

        <components total="11" 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"/>

          <!-- etc. Skipped in documentation -->

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

        </components>

     </station>

  </stations>

</drweb-es-api>

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

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

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

Атрибут

Описание

total

Общее количество станций в ответе

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

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

Атрибут

Описание

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": 1589406940,

    "api": {

      "version": 40302,

      "versionString": "4.3.2"},

    "server": {

      "name": "192.168.1.1",

      "version": "13.00.1.202310121",

      "uuid": "b35d999d-9212-481d-af8c-8551c4113383"}},

"data": {

    "total": 2,

    "list": [

      {"components": [

          {"code": 4,

          "name": "Dr.Web Scanner for Windows",

          "status": 1},

          ...,

          {"code": 37,

           "name": "Dr.Web Agent Scanner for Windows",

           "status": 2}],

      "inherited": true,

      "inherited_group_id": "20e27d73-d21d-b211-a788-85419c46f0e6",

      "inherited_group_name": "Everyone",

      "station_id": "1001"},

      {"components": [

          {"code": 4,

          "name": "Dr.Web Scanner for Windows",

          "status": 1},

          ...,

          {"code": 37,

           "name": Dr.Web Agent Scanner for Windows",

           "status": 2}],

      "inherited": true,

      "inherited_group_id": "20e27d73-d21d-b211-a788-85419c46f0e6",

      "inherited_group_name": "Everyone",

      "station_id": "1002"}]}}

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

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

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

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

Описание

total

Общее количество станций в ответе

list

Массив с информацией обо всех устанавливаемых компонентах для каждой станции

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

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

Описание

components

Массив с параметрами для каждого устанавливаемого компонента конкретной станции

inherited

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

inherited_group_id

Идентификатор родительской группы, от которой унаследованы параметры компонентов.

Данный элемент будет отсутствовать, если элемент inherited принимает значение false.

inherited_group_name

Название родительской группы, от которой унаследованы параметры компонентов.

Данный элемент будет отсутствовать, если элемент inherited принимает значение false.

station_id

Идентификатор станции

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

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

Описание

code

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

name

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

status

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

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

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

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