hints.hint.list

Scope: hints

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

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

HTTP: GET

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

Для полей name, selector, code строковое значение $eq или прямое значение интерпретируется как подстрока (LIKE).

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

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

Поля filter (Mongo)

Поддерживаемые поля: id, pageId, name, selector, code, form, event, showByQueue, showByAnchor, hideNext, hideSkip, active, timestampX, dateCreate.

Alias: sectionId, groupId → pageId; hintId → id; anchor → code.

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

Enum-поля (form, event, showByQueue, showByAnchor, hideNext, hideSkip): xmlId или числовой id enum. Для checkbox-полей: Y/N, true/false, 1/0. active: bool или Y/N.

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

result.result — массив подсказок; верхнеуровневые Bitrix next, total.

Поле Тип Описание
id int ID подсказки
pageId int ID страницы
pageName string Название страницы
name string Название
selector string CSS-селектор
code string Код якоря
detailText string HTML-содержимое
active bool Активность
sort int Сортировка
form string xmlId формы (см. hints.hint.form.list)
event string xmlId события (см. hints.hint.event.list)
hideNext string Y / N
hideSkip string Y / N
showByAnchor string Y / N
showByQueue string Y / N
radius string Радиус
timeout string Таймаут (мс)
nextText string Текст кнопки «Далее»
linkForNextBtn string Ссылка кнопки «Далее»
dateCreate string Дата создания
timestampX string Дата изменения
createdBy int ID автора
modifiedBy int ID редактора

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

Справочник кодов: 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
INTERNAL_ERROR Внутренняя ошибка сервера

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

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

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

{
          "result": {
            "result": [
              {
                "id": 1065,
                "pageId": 88,
                "pageName": "Тестовая страница Postman",
                "name": "Postman hint A",
                "selector": "",
                "code": "",
                "detailText": "<p>Hint A for filter test</p>",
                "active": true,
                "sort": 500,
                "form": "",
                "event": "",
                "hideNext": "N",
                "hideSkip": "N",
                "showByAnchor": "N",
                "showByQueue": "Y",
                "radius": "",
                "timeout": "",
                "nextText": "",
                "linkForNextBtn": "",
                "dateCreate": "31.08.2026 15:20:18",
                "timestampX": "31.08.2026 15:20:18",
                "createdBy": 1,
                "modifiedBy": 1
              }
            ],
            "error": null
          },
          "next": 1,
          "total": 11,
          "time": {
            "start": 1788357574,
            "finish": 1788357574.671762,
            "duration": 0.6717619895935059,
            "processing": 0,
            "date_start": "2026-09-02T16:59:34+03:00",
            "date_finish": "2026-09-02T16:59:34+03:00"
          }
        }

См. также

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