Поиск станций и групп

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

Параметр

Описание

Допустимые значения

Примечание

groups

Искать по группам

yes | no

Обязательный параметр: нет.

По умолчанию yes

query

Строка поиска

–

Обязательный параметр: да.

Осуществляется поиск соответствия в идентификаторе, имени и строке описания объекта, а также в идентификаторах  пользователей.

stations

Искать по станциям

yes | no

Обязательный параметр: нет.

По умолчанию no

 

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

http://192.168.1.1:9080/api/server/search.ds?query=1&groups=yes&stations=yes

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

 

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

<drweb-es-api api_version="4.3.0" timestamp="11558521947" server="192.168.1.1" srv_version="12.00.0.201909260" status="true">
  <groups total="2">
     <group id="20e27d73-d21d-b211-a788-85419c46f0e6" name="Everyone" description="All stations" parent_id="" parent_name="" child_groups="0" stations="2"/>

     <group id="10f58fa7-ffa6-4e85-ba4a-f67f44455a75" name="GroupAfterAddGroupFunctional3" description="" parent_id="ParentGroupForAGF5" parent_name="ParentGroupForAGF5" child_groups="0" stations="0"/>
  </groups>

  <stations total="2">
     <station id="StationForChangeStationFunctional1" name="StationForChangeStationFunctional1" parent_id="20e27d73-d21d-b211-a788-85419c46f0e6" parent_name="Everyone" description="StationForChangeStationFunctional 1" last_seen_time="0" last_seen_addr="" user-id=""/>

     <station id="2091ada3-ed5e-e611-3392-f0b9022a5484" name="WIN-7-PRO-SP1-X" parent_id="20e27d73-d21d-b211-a788-85419c46f0e6" parent_name="Everyone" description="" last_seen_time="1489567785" last_seen_addr="tcp://192.168.1.2:49285" user-id=""/>
  </stations>
</drweb-es-api>

 

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

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

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

Атрибут

Описание

total

Общее количество групп, соответствующих поисковому запросу

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

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

Атрибут

Описание

id

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

name

Имя группы

description

Строка описания

parent_id

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

parent_name

Имя родительской группы

child_groups

Количество дочерних групп

stations

Количество станций, входящих в данную группу

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

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

Атрибут

Описание

total

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

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

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

Атрибут

Описание

id

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

name

Имя станции

parent_id

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

parent_name

Имя первичной группы

description

Строка описания

last_seen_time

Время последнего подключения станции к Серверу

last_seen_addr

Адрес, с которого станция последний раз подключалась к Серверу

user-id

Идентификатор пользователя

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

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

    "timestamp": 1558522035,

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

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

      "version": "12.00.0.201909260",
      "uuid": "27671337-e0b0-4f60-aeb0-ab1f2ca47f77"}},

"data": {
    "groups": {
      "total": 2,

      "list": [
          {"child_groups": 0,

          "description": "All stations",

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

          "name": "Everyone",

          "parent_id": null,

          "parent_name": null,
          "stations": 2},

          {"child_groups": 0,
          "description": null,

          "id": "10f58fa7-ffa6-4e85-ba4a-f67f44455a75",

          "name": "GroupAfterAddGroupFunctional3",

          "parent_id": "ParentGroupForAGF5",

          "parent_name": "ParentGroupForAGF5",
          "stations": 0}]},

    "stations": {
      "total": 2,

      "list": [
          {"description": "StationForChangeStationFunctional 1",

          "id": "StationForChangeStationFunctional1",

          "last_seen_addr": null,

          "last_seen_at": 0,

          "name": "StationForChangeStationFunctional1",

          "parent_id": "20e27d73-d21d-b211-a788-85419c46f0e6",
          "parent_name": "Everyone"}

          {"description": null,
          "id": "2091ada3-ed5e-e611-3392-f0b9022a5484",

          "last_seen_addr": "tcp://192.168.233.131:49285",

          "last_seen_at": 1489567785,

          "name": "WIN-7-PRO-SP1-X",

          "parent_id": "20e27d73-d21d-b211-a788-85419c46f0e6",
          "parent_name": "Everyone"}]}}}

 

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

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

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

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

Описание

total

Общее количество групп, соответствующих поисковому запросу

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

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

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

Описание

child_groups

Количество дочерних групп

description

Строка описания

id

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

name

Имя группы

parent_id

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

parent_name

Имя родительской группы

stations

Количество станций, сходящих в данную группу

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

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

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

Описание

total

Общее количество станций, соответствующих поисковому запросу

▫Массив list содержит информацию о конкретных станциях.

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

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

Описание

description

Строка описания

id

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

last_seen_addr

Адрес, с которого станция последний раз подключалась к Серверу

last_seen_time

Время последнего подключения станции к Серверу

name

Имя станции

parent_id

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

parent_name

Имя первичной группы