knowledgebase.hash.create

Scope: knowledgebase

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

Создать или активировать публичную ссылку на статью

HTTP: POST

Побочные эффекты: создаёт запись hash или активирует существующую (UF_ACTIVE = 1)

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

Параметр Тип Обяз. Описание
elementId int да ID статьи

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

Ответ в конверте модуля: result.result — объект hash (id, elementId, hash, active, url); result.error.

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

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

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

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

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

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

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

См. также

Предыдущая
Обзор раздела
Следующая
knowledgebase.hash.delete