knowledgebase.hash.setActive

Scope: knowledgebase

Кто может вызывать: IblockRights::canEditElement(); при active=true — публичная ссылка не запрещена модулем и статьёй. Подробнее: Права доступа

Включить или отключить публичную ссылку на статью

HTTP: POST

Побочные эффекты: обновляет флаг UF_ACTIVE записи hash

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

Параметр Тип Обяз. Описание
elementId int да ID статьи
active bool|string нет Активность ссылки; по умолчанию true. Допустимо: true/false, 1/0, Y/N, yes/no

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

Ответ в конверте модуля: result.result — обновлённый объект hash; result.error.

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

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

Код Описание
UNAUTHORIZED Пользователь не авторизован
VALIDATION_ERROR Некорректные или неполные параметры
NOT_FOUND Элемент не найден в инфоблоке базы знаний
PERMISSION_DENIED Нет прав на редактирование элемента
HASH_NOT_FOUND Публичная ссылка для элемента не найдена
PUBLIC_LINK_FORBIDDEN Публичные ссылки отключены (при active=true)
INTERNAL_ERROR Внутренняя ошибка сервера

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

curl -X POST "https://{портал}/rest/{user_id}/{webhook_code}/knowledgebase.hash.setActive.json" \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          --data '{
          "elementId": 501,
          "active": false
        }'

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

{
          "result": {
            "result": {
              "id": 10,
              "elementId": 1078,
              "hash": "6a1087684209a9331a6a45f8634fef57",
              "active": false,
              "url": "https://76569.dev.wehive.digital/pub/knowledgebase/show.php?hash=6a1087684209a9331a6a45f8634fef57"
            },
            "error": null
          }
        }

См. также

Предыдущая
knowledgebase.hash.getByElement
Следующая
История версий