hints.page.get

Scope: hints

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

Страница подсказок по ID, включая счётчики подсказок и просмотров.

HTTP: GET

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

Параметр id также принимает alias: pageId, sectionId.

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

Параметр Тип Обяз. Описание
id int да ID страницы (alias: pageId, sectionId)

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

result.result — объект страницы.

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

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

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

Код Описание
UNAUTHORIZED Пользователь не авторизован
MODULE_DISABLED Модуль выключен на сайте (switchOn != Y)
ACCESS_DENIED Нет права чтения (R/W)
VALIDATION_ERROR Не указан или некорректный id
PAGE_NOT_FOUND Страница не найдена
INTERNAL_ERROR Внутренняя ошибка сервера

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

curl -G "https://76592.dev.wehive.digital/rest/1/{webhook_code}/hints.page.get.json" \
          -H "Accept: application/json" \
          --data-urlencode "id=94"

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

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

Пример ответа (ошибка)

{
          "result": {
            "result": null,
            "error": {
              "code": "PAGE_NOT_FOUND",
              "message": "Страница не найдена.",
              "details": {
                "id": 999999991
              }
            }
          },
          "time": {
            "start": 1788357586,
            "finish": 1788357586.280703,
            "duration": 0.280703067779541,
            "processing": 0,
            "date_start": "2026-09-02T16:59:46+03:00",
            "date_finish": "2026-09-02T16:59:46+03:00"
          }
        }

См. также

Предыдущая
hints.page.list
Следующая
hints.page.add