hints.hint.get

Scope: hints

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

Подсказка по ID.

HTTP: GET

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

Параметр id также принимает alias hintId.

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

Параметр Тип Обяз. Описание
id int да ID подсказки (alias: hintId)

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

result.result — объект подсказки.

Поле Тип Описание
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 Нет права чтения
VALIDATION_ERROR Не указан или некорректный id
HINT_NOT_FOUND Подсказка не найдена
INTERNAL_ERROR Внутренняя ошибка сервера

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

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

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

{
          "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
          },
          "time": {
            "start": 1788357574,
            "finish": 1788357574.770897,
            "duration": 0.7708969116210938,
            "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": "HINT_NOT_FOUND",
              "message": "Подсказка не найдена.",
              "details": {
                "id": 999999991
              }
            }
          },
          "time": {
            "start": 1788357586,
            "finish": 1788357586.396727,
            "duration": 0.3967270851135254,
            "processing": 0,
            "date_start": "2026-09-02T16:59:46+03:00",
            "date_finish": "2026-09-02T16:59:46+03:00"
          }
        }

См. также

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