hints.config.get

Scope: hints

Кто может вызывать: RestAccess::requireRead() — модуль включён и право группы R или W. Подробнее: Права доступа

Возвращает настройки модуля для одного сайта или список настроек всех активных сайтов.

HTTP: GET

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

Без параметра siteId метод возвращает массив конфигураций всех активных сайтов портала. С siteId — один объект; если сайт не найден — NOT_FOUND.

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

Параметр Тип Обяз. Описание
siteId string нет ID сайта (LID). Пустая строка трактуется как отсутствие параметра

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

Ответ в конверте модуля: result.result — объект (один сайт) или массив объектов (все сайты); result.error.

Поле Тип Описание
siteId string ID сайта
name string Название сайта
switchOn bool Модуль включён на сайте
moderateOn bool Режим модерации
theme string Тема оформления (light / dark)

При запросе всех сайтов верхнеуровневый Bitrix total — число записей в массиве.

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

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

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

Пример запроса (GET, один сайт)

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

Пример ответа (один сайт)

{
          "result": {
            "result": {
              "siteId": "s1",
              "name": "Моя компания",
              "switchOn": true,
              "moderateOn": false,
              "theme": "light"
            },
            "error": null
          },
          "time": {
            "start": 1788357574,
            "finish": 1788357574.970185,
            "duration": 0.9701850414276123,
            "processing": 0,
            "date_start": "2026-09-02T16:59:34+03:00",
            "date_finish": "2026-09-02T16:59:34+03:00"
          }
        }

Пример запроса (GET, все сайты)

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

Пример ответа (все сайты)

{
          "result": {
            "result": [
              {
                "siteId": "s1",
                "name": "Моя компания",
                "switchOn": true,
                "moderateOn": false,
                "theme": "light"
              },
              {
                "siteId": "hq",
                "name": "Второй департамент",
                "switchOn": false,
                "moderateOn": true,
                "theme": "dark"
              }
            ],
            "error": null
          },
          "total": 2,
          "time": {
            "start": 1788357574,
            "finish": 1788357574.929897,
            "duration": 0.9298970699310303,
            "processing": 0,
            "date_start": "2026-09-02T16:59:34+03:00",
            "date_finish": "2026-09-02T16:59:34+03:00"
          }
        }

См. также

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