метод REST scope: note

note.document.get

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

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

Описание

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

Метод note.document.get возвращает один документ с содержимым в Markdown.

Параметры

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

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

Идентификатор можно получить методом note.document.tree.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.document.get

Ответ

HTTP-статус: 200

{
    "result": {
        "item": {
            "id": 42,
            "collectionId": 123,
            "parentId": 10,
            "title": "Глава 1",
            "markdown": "# Глава 1\n\nТекст в Markdown...",
            "position": 5,
            "createdBy": 1,
            "updatedBy": 1,
            "createdAt": "2026-04-20T12:00:00Z",
            "updatedAt": "2026-04-21T09:15:30Z"
        }
    },
    "time": {
        "start": 1780639800,
        "finish": 1780639800.215441,
        "duration": 0.21544098854064941,
        "processing": 0.1772141456604004,
        "date_start": "2026-06-19T10:10:00+03:00",
        "date_finish": "2026-06-19T10:10:00+03:00",
        "operating_reset_at": 1780640400,
        "operating": 0
    }
}

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

result object

Объект с данными документа

item object

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

id integer

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

collectionId integer

Идентификатор базы знаний или null, если документ доступен через прямой доступ к документу

parentId integer

Идентификатор родительского документа или null

title string

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

markdown string

Содержимое документа в Markdown

position integer

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

createdBy integer

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

updatedBy integer

Идентификатор последнего редактора документа

createdAt datetime

Дата и время создания документа в UTC

updatedAt datetime

Дата и время последнего изменения документа в UTC

time time

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

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

HTTP-статус: 400

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

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

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