метод REST scope: note

note.collection.archive

Архивировать базу знаний

Кто может выполнять: пользователь с доступом к модулю База знаний и правом «Администрирование» для нужной базы знаний

Описание

Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в обзоре REST 3.0.

Метод note.collection.archive архивирует базу знаний и каскадно архивирует все ее документы.

Параметры

id integer обязательный

Идентификатор базы знаний.

Идентификатор можно получить методом note.collection.list

Примеры запроса

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":42}' \
https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/note.collection.archive

Ответ

HTTP-статус: 200

{
    "result": {
        "result": true
    },
    "time": {
        "start": 1780388120,
        "finish": 1780388120.245321,
        "duration": 0.24532103538513184,
        "processing": 0.1812450885772705,
        "date_start": "2026-06-16T11:15:20+03:00",
        "date_finish": "2026-06-16T11:15:20+03:00",
        "operating_reset_at": 1780388720,
        "operating": 0
    }
}

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

result object

Объект с результатом архивации базы знаний

result boolean

Значение true, если база знаний успешно архивирована

time time

Информация о времени выполнения запроса

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

HTTP-статус: 400

{
    "error": {
        "code": "BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION",
        "message": "Ошибка при валидации объекта запроса",
        "validation": [
            {
                "message": "Обязательное поле `id` не указано",
                "field": "id"
            }
        ]
    }
}
Код Описание Значение
Поле Описание ошибки Как исправить
id Обязательное поле id не указано Добавьте id в тело запроса
id В поле id требуется тип данных #TYPE# для такого запроса Убедитесь, что передаваемое значение нужного типа

Что будем искать? Например,Продвижение

Этот сайт использует куки-файлы. Оставаясь на сайте, Вы соглашаетесь на их использование. Для получения дополнительной информации, пожалуйста, ознакомьтесь с политикой в отношении персональных данных.