метод REST scope: note

note.file.get

Получить данные файла документа

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

Описание

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

Метод note.file.get возвращает метаданные файла и готовый блок Markdown для вставки вложения в документ.

Параметры

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

Идентификатор файла.

Идентификатор файла можно получить в ответе метода note.file.add

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

Идентификатор документа, к которому привязан файл.

Используйте тот же идентификатор документа, который передавали в метод note.file.add

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

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

Ответ

HTTP-статус: 200

{
    "result": {
        "item": {
            "id": 5001,
            "documentId": 77,
            "name": "diagram.png",
            "size": 6321,
            "mimeType": "image/png",
            "assetType": "image",
            "assetMarkdown": "[[image fileId=5001]]"
        }
    },
    "time": {
        "start": 1780392300,
        "finish": 1780392300.194822,
        "duration": 0.19482207298278809,
        "processing": 0.15441107749938965,
        "date_start": "2026-06-16T12:25:00+03:00",
        "date_finish": "2026-06-16T12:25:00+03:00",
        "operating_reset_at": 1780392900,
        "operating": 0
    }
}

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

result object

Объект с результатом получения данных файла

item object

Объект с метаданными файла

id integer

Идентификатор файла

documentId integer

Идентификатор документа, к которому привязан файл.

Это тот же идентификатор документа, который передавали в метод note.file.add

name string

Имя файла

size integer

Размер файла в байтах

mimeType string

MIME-тип файла

assetType string

Тип вложения для Markdown.

Возможные значения:

  • image — изображение
  • video — видео
  • file — обычный файл
assetMarkdown string

Готовый блок Markdown для вставки в документ в формате [[<assetType> fileId=<id>]].

Чтобы вложение появилось в документе, передайте этот блок в markdown через note.document.update.

Перед вставкой изображения или видео блок можно дополнить параметрами масштаба и выравнивания. Подробнее о параметрах читайте в описании поля markdown метода note.document.update

time time

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

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

HTTP-статус: 400

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

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

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