метод REST scope: note

note.document.tree.list

Получить дерево документов

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

Описание

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

Метод note.document.tree.list возвращает дерево документов одной базы знаний.

Архивные документы не попадают в ответ.

Параметры

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

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

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

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

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

Ответ

HTTP-статус: 200

{
    "result": {
        "items": [
            {
                "id": 10,
                "collectionId": 123,
                "parentId": null,
                "title": "Введение",
                "position": 1,
                "children": [
                    {
                        "id": 11,
                        "collectionId": 123,
                        "parentId": 10,
                        "title": "Глава 1",
                        "position": 1,
                        "children": []
                    }
                ]
            }
        ],
        "truncated": false
    },
    "time": {
        "start": 1780639500,
        "finish": 1780639500.268512,
        "duration": 0.2685120105743408,
        "processing": 0.22631406784057617,
        "date_start": "2026-06-19T10:05:00+03:00",
        "date_finish": "2026-06-19T10:05:00+03:00",
        "operating_reset_at": 1780640100,
        "operating": 0
    }
}

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

result object

Объект с деревом документов

items array

Корневые узлы дерева документов

items[] object

Объект документа дерева

id integer

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

collectionId integer

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

parentId integer

Идентификатор родительского документа или null для корневой страницы

title string

Заголовок документа

position integer

Позиция документа среди соседних страниц

children array

Дочерние страницы документа

truncated boolean

Значение true, если дерево превышало внутренний лимит TREE_MAX_NODES = 5000 и было обрезано по корневым узлам.

Исключение — первый корневой документ. Если он один превышает внутренний лимит TREE_MAX_NODES, метод вернет его начальную часть в порядке обхода в ширину, чтобы ответ не оказался пустым

time time

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

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

HTTP-статус: 400

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

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

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