hints.page.list

Scope: hints

Кто может вызывать: RestAccess::requireRead(). Подробнее: Права доступа

Список страниц подсказок (секций инфоблока) с Mongo-style фильтром и пагинацией.

HTTP: GET

Побочные эффекты: none

Параметры метода

Параметр Тип Обяз. Описание
limit int нет Размер страницы, по умолчанию 50, максимум 500
offset int нет Смещение, по умолчанию 0
fetchAll bool нет Вернуть все записи (защитный лимит 5000)
filter object нет Mongo-фильтр по полям страницы

Поля filter (Mongo)

Поддерживаемые поля: id, name, url, hintsCount, viewsCount.

Alias в filter: sectionId, pageId, groupId → id.

Операторы: $eq, $ne, $gt, $gte, $lt, $lte, $in, $nin.

Фильтрация по hintsCount и viewsCount выполняется до пагинации. total, offset и limit рассчитываются по отфильтрованному результату.

Пагинация

limit (default 50, max 500), offset, fetchAll (защитный лимит 5000, иначе FETCH_ALL_LIMIT_EXCEEDED).

Возвращаемые данные

result.result — массив страниц; верхнеуровневые Bitrix next (смещение следующей страницы или отсутствует) и total.

Поле Тип Описание
id int ID страницы
name string Название
url string URL шаблон страницы
hintType string Тип сценария (xmlId UF_HINT_TYPE, напр. step)
active bool Активность
sort int Сортировка
hintsCount int Число подсказок на странице
viewsCount int Число записей просмотра

Обработка ошибок

Справочник кодов: error-codes.md.

Код Описание
UNAUTHORIZED Пользователь не авторизован
MODULE_DISABLED Модуль выключен на сайте
ACCESS_DENIED Нет права чтения
INVALID_LIMIT limit вне диапазона 1..500
INVALID_OFFSET offset < 0
INVALID_FILTER Некорректный filter или неизвестное поле (details.allowed)
INVALID_FILTER_OPERATOR Неизвестный оператор фильтра
FETCH_ALL_LIMIT_EXCEEDED При fetchAll=true записей больше 5000
INTERNAL_ERROR Внутренняя ошибка сервера

Пример запроса (GET)

curl -G "https://76592.dev.wehive.digital/rest/1/{webhook_code}/hints.page.list.json" \
          -H "Accept: application/json" \
          --data-urlencode "limit=1" \
          --data-urlencode "offset=0"

Пример ответа

{
          "result": {
            "result": [
              {
                "id": 94,
                "name": "(1) Поиск сотрудника",
                "url": "/company/",
                "hintType": "step",
                "active": true,
                "sort": 500,
                "hintsCount": 1,
                "viewsCount": 1
              }
            ],
            "error": null
          },
          "next": 1,
          "total": 9,
          "time": {
            "start": 1788357574,
            "finish": 1788357574.57738,
            "duration": 0.5773799419403076,
            "processing": 0,
            "date_start": "2026-09-02T16:59:34+03:00",
            "date_finish": "2026-09-02T16:59:34+03:00"
          }
        }

См. также

Предыдущая
Обзор раздела
Следующая
hints.page.get