Поиск в области поиска

Алгоритм

• Авторизация;
• Запрос поиска объектов.

Авторизация

Необходимо пройти стандартную процедуру авторизации требуемого пользователя в выбранном хранилище.

Варианты авторизации:

• Авторизация с использованием командной строки;
• Авторизация с использованием Swagger;
• Авторизация в C# .NET.

Запрос поиска объектов

В консоли необходимо указать строку поиска и идентификатор области поиска. Если идентификатор области поиска не указан, используется значение по умолчанию — «Все справочники». Отправляется POST-запрос по адресу /search/query.

Запрос

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

{
  "query": "Элемент",
  "scopes": [
    {
      "objectId": 1,
      "typeId": 203
    }
  ],
  "pageNumber": 0,
  "pageSize": 0
}

Ответ

В качестве ответа возвращается объект с информацией об общем количестве найденных элементов (totalCount), общем количестве страниц результатов поиска (totalPages), текущем номере и размере страницы (pageNumber и pageSize) и признаках существования предшествующей и последующей страниц (hasPreviousPage и hasNextPage). В блоке items размещен список найденных элементов.

{
  "items": [
    {
      "applicability": 0,
      "iconCode": 0,
      "iconColor": 0,
      "path": [
        {
          "name": "Справочник",
          "objectId": 6,
          "typeId": 48
        },
        {
          "name": "Каталог",
          "objectId": 5,
          "typeId": 40
        },
        {
          "name": "Группа",
          "objectId": 6,
          "typeId": 39
        }
      ],
      "name": "Элемент",
      "objectId": 42,
      "typeId": 4
    }
  ],
  "pageNumber": 0,
  "pageSize": 0,
  "totalPages": 0,
  "totalCount": 1,
  "hasPreviousPage": false,
  "hasNextPage": false
}