метод REST scope: note

note.document.archive

Архивировать документ

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

Описание

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

Метод note.document.archive архивирует документ и все его дочерние страницы.

Параметры

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

Идентификатор документа.

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

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

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

Ответ

HTTP-статус: 200

{
    "result": {
        "result": true
    },
    "time": {
        "start": 1780391400,
        "finish": 1780391400.229114,
        "duration": 0.22911405563354492,
        "processing": 0.1881120204925537,
        "date_start": "2026-06-16T12:10:00+03:00",
        "date_finish": "2026-06-16T12:10:00+03:00",
        "operating_reset_at": 1780392000,
        "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# для такого запроса Убедитесь, что передаваемое значение нужного типа

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

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