hints.show.list

Scope: hints

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

Список записей просмотра/пропуска страниц подсказок.

HTTP: GET

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

Без права W результат автоматически фильтруется по userId текущего пользователя — параметр filter[userId] не позволит увидеть чужие записи. С правом W доступны все записи с произвольным фильтром.

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

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

Поля filter (Mongo)

Поддерживаемые поля: id, userId, pageId.

Alias: sectionId, groupId → pageId.

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

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

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

Поле Тип Описание
id int ID записи ShowTable
userId int ID пользователя
pageId int ID страницы

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

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

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

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

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

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

{
          "result": {
            "result": [
              {
                "id": 20,
                "userId": 1,
                "pageId": 97
              },
              {
                "id": 11,
                "userId": 1,
                "pageId": 94
              }
            ],
            "error": null
          },
          "next": 2,
          "total": 3,
          "time": {
            "start": 1788357574,
            "finish": 1788357574.889016,
            "duration": 0.8890159130096436,
            "processing": 0,
            "date_start": "2026-09-02T16:59:34+03:00",
            "date_finish": "2026-09-02T16:59:34+03:00"
          }
        }

См. также

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