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
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":5001,"documentId":77,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/api/note.file.get
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
type FileGetResult = {
item: {
id: number
documentId: number
name: string
size: number
mimeType: string
assetType: string
assetMarkdown: string
}
}
try {
const response = await $b24.actions.v3.call.make<FileGetResult>({
method: 'note.file.get',
params: {
id: 5001,
documentId: 77,
},
requestId: Text.getUuidRfc4122()
})
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info('File info:', result.item.assetMarkdown)
}
} catch (error) {
console.error(error)
}
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
async function getFile() {
try {
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v3.call.make({
method: 'note.file.get',
params: {
id: 5001,
documentId: 77,
},
requestId: B24Js.Text.getUuidRfc4122()
})
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info('File info:', result.item.assetMarkdown)
} catch (error) {
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getFile)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.note.file.get(
bitrix_id=5001,
document_id=77,
).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Ошибка Bitrix API",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
print(f"Непредвиденная ошибка: {error}")
try {
$response = $b24Service
->core
->call(
'note.file.get',
[
'id' => 5001,
'documentId' => 77,
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error getting file info: ' . $e->getMessage();
}
BX24.callMethod(
'note.file.get',
{
id: 5001,
documentId: 77
},
function(result){
console.info(result.data());
console.log(result);
}
);
require_once('crest.php');
$result = CRest::call(
'note.file.get',
[
'id' => 5001,
'documentId' => 77
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "note.file.get", b24.Params{
"id": 5001,
"documentId": 77,
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("note.file.get: %w", err)
}
// Метод заворачивает ответ в объект с ключом "item".
raw, ok := b24.Unwrap(res.Result, "item")
if !ok {
return fmt.Errorf("в ответе нет ключа item")
}
var item struct {
ID b24.ID `json:"id"`
DocumentID b24.ID `json:"documentId"`
Name string `json:"name"`
Size int `json:"size"`
MimeType string `json:"mimeType"`
AssetType string `json:"assetType"`
}
if err := json.Unmarshal(raw, &item); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.ID, item.DocumentID)
Ответ
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# для такого запроса |
Убедитесь, что передаваемое значение нужного типа |

