hints.hint.form.list

Scope: hints

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

Справочник значений свойства «форма подсветки» (FORM). В hints.hint.add / hints.hint.update передавайте xmlId.

HTTP: GET

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

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

Нет.

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

result.result — массив:

Поле Тип Описание
id int Числовой id enum на портале
xmlId string Код для API (circle, rect, …)
value string Отображаемое название

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

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

Код Описание
UNAUTHORIZED Пользователь не авторизован
MODULE_DISABLED Модуль выключен на сайте
ACCESS_DENIED Нет права чтения
INTERNAL_ERROR Внутренняя ошибка сервера

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

curl -G "https://76592.dev.wehive.digital/rest/1/{webhook_code}/hints.hint.form.list.json" \
          -H "Accept: application/json"

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

{
          "result": {
            "result": [
              {
                "id": 64,
                "xmlId": "circle",
                "value": "Круг"
              },
              {
                "id": 65,
                "xmlId": "rect",
                "value": "Прямоугольник"
              }
            ],
            "error": null
          },
          "time": {
            "start": 1788357575,
            "finish": 1788357575.050876,
            "duration": 0.05087590217590332,
            "processing": 0,
            "date_start": "2026-09-02T16:59:35+03:00",
            "date_finish": "2026-09-02T16:59:35+03:00"
          }
        }

См. также

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