knowledgebase.article.clearTrash
Scope:
knowledgebaseКто может вызывать: авторизованный пользователь; массовая очистка корзины через
TrashService::purge(). Подробнее: Права доступа
Окончательно удалить статьи из корзины (массовая очистка). Период очистки задаётся параметром — как в UI «Очистить корзину» (30 / 90 / 180 / 360 дней или вся корзина).
HTTP: POST
Побочные эффекты: безвозвратно удаляет статьи из корзины; может удалить пустые разделы
Параметры метода
| Параметр | Тип | Обяз. | Описание |
|---|---|---|---|
olderThanDays |
int|string |
нет | Удалить только статьи, помещённые в корзину не менее N дней назад. Алиасы: days, period, OLDER_THAN_DAYS, DAYS, PERIOD |
Значения периода
| Значение | Поведение |
|---|---|
параметр не передан, "", "all", 0 или любое <= 0 |
Очистить всю корзину |
30, 90, 180, 360 |
Удалить статьи старше N дней (как в UI) |
| прочие положительные числа | Передаются в TrashService::purge() как есть (в UI используются только 30 / 90 / 180 / 360) |
нечисловая строка ("abc") |
Приводится к 0 → очистка всей корзины (отдельной ошибки валидации нет) |
Возвращаемые данные
Ответ в конверте модуля: result.result — объект:
| Поле | Описание |
|---|---|
success |
true, если операция выполнена |
deletedCount |
Количество окончательно удалённых статей |
deletedSectionIds |
ID разделов, удалённых как пустые после очистки |
olderThanDays |
Применённый период (30, 90, …) или null при полной очистке |
Обработка ошибок
Справочник кодов: error-codes.md.
| Код | Описание |
|---|---|
UNAUTHORIZED |
Пользователь не авторизован |
INTERNAL_ERROR |
Внутренняя ошибка сервера |
Пример запроса — очистка за 90 дней (POST)
curl -X POST "https://{портал}/rest/{user_id}/{webhook_code}/knowledgebase.article.clearTrash.json" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
--data '{
"olderThanDays": 90
}'
Пример запроса — очистить всю корзину (POST)
curl -X POST "https://{портал}/rest/{user_id}/{webhook_code}/knowledgebase.article.clearTrash.json" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
--data '{}'
Алиасы полной очистки: "olderThanDays": "all", "olderThanDays": 0, параметр period / days с теми же значениями.
Пример ответа (период 90 дней)
{
"result": {
"result": {
"success": true,
"deletedCount": 0,
"deletedSectionIds": [],
"olderThanDays": 90
},
"error": null
}
}
Пример ответа (вся корзина)
{
"result": {
"result": {
"success": true,
"deletedCount": 0,
"deletedSectionIds": [],
"olderThanDays": null
},
"error": null
}
}
См. также
Предыдущая
Следующая