knowledgebase.article.delete

Scope: knowledgebase

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

Переместить статью в корзину (soft-delete: ACTIVE = N + DATE_DELETE)

HTTP: POST

Побочные эффекты: деактивирует статью и помечает датой удаления (корзина)

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

Параметр Тип Обяз. Описание
id int да ID статьи (алиасы: articleId, elementId)

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

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

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

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

Код Описание
UNAUTHORIZED Пользователь не авторизован
VALIDATION_ERROR Некорректные или неполные параметры
ARTICLE_NOT_FOUND Статья не найдена
PERMISSION_DENIED Нет прав на удаление
INTERNAL_ERROR Внутренняя ошибка сервера (сбой soft-delete)

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

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

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

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

См. также