knowledgebase.hash.delete

Scope: knowledgebase

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

Удалить публичную ссылку (hash) на статью

HTTP: POST

Побочные эффекты: удаляет запись hash из хранилища

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

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

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

Ответ в конверте модуля: result.result — { elementId, deleted }; result.error.

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

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

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

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

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

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

{
          "result": {
            "result": {
              "elementId": 1078,
              "deleted": true
            },
            "error": null
          }
        }

См. также

Предыдущая
knowledgebase.hash.create
Следующая
knowledgebase.hash.getByElement