Поиск объектов

Искать объекты

GET /(company_code)/v2/search

Искать объекты

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

Поиск может включать объекты следующих типов: account, entry, file, profile, transaction, record, notice, disclaimer, log. Авторизованному пользователю могут быть доступны только некоторые из этих типов. По умолчанию включаются типы account, entry и profile, если они доступны. Клиентское приложение может ограничить поиск определенными типами, используя поле запроса type. Типы notice, disclaimer и log являются эксклюзивными. Если используется один из этих типов, он должен быть единственным запрашиваемым типом объекта.

По умолчанию результаты поиска сортируются по убыванию временной метки для данных, основанных на временных метках, или по релевантности в других случаях. Другой порядок сортировки может быть запрошен используя поле sort. Оно может содержать название поля (lname), название поля и направление (lname:asc или lname:desc) или список названий или названий и направлений, разделенных запятыми (date_of_birth:desc,lname,fname).

Заголовки запроса:  

• Authorization – Bearer <сессионный_токен>, либо Signature <подпись>

URL-параметры запроса:  

• query (string) – Поисковый запрос (поддерживается язык запросов Elasticsearch)
• type (string) – (Необязательно) Код типа включаемых объектов, либо разделенный запятыми список кодов типа
• fields (string) – (Необязательно) Если поиск ведется по объектам ровно одного типа: разделенный запятыми список названий полей для включения в ответ
• sort (string) – (Необязательно) Порядок сортировки, название поля с необязательным направлением, либо список названий с необязательными направлениями, разделенных запятыми
• size (integer) – Разбивка на страницы: количество возвращаемых результатов
• from (integer) – (Необязательно) Разбивка на страницы: количество пропускаемых результатов (по умолчанию 0)

JSON-объект ответа:  

• status (string) – success или error
• total (integer) – Общее количество найденных результатов
• data (array) – Объекты данных результатов поиска
• error_code (string) – (Необязательно) Если status содержит error: один из перечисленных ниже кодов ошибки

Поля данных найденного объекта

У каждого объекта в массиве ответа data есть следующие поля:

Имя поля	Тип	Описание
type	string	Код типа объекта
data	object	Поля данных объекта

Используемые коды ошибки

• auth.header.missing
• auth.header.invalid
• auth.token.invalid
• auth.token.expired
• auth.session.invalid
• auth.user.restricted
• auth.user.closed
• auth.user.denied
• auth.restricted
• search.type.restricted
• request.validation.failed

Подробнее см. Коды ошибок.