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

`GET /v1/note/documents/:documentId/files/:id`

Возвращает метаданные файла и готовый фрагмент разметки для вставки вложения в содержимое документа. Доступно и ключу в режиме «только чтение».

## Параметры

| Параметр | Тип | Обяз. | Описание |
|----------|-----|:-----:|---------|
| `documentId` (path) | integer | да | Документ, к которому привязан файл. Идентификатор — из [`POST /v1/note/documents`](/docs/note/documents) |
| `id` (path) | integer | да | Идентификатор файла. Возвращается из [`POST /v1/note/documents/:documentId/files`](./upload.md) |

## Примеры

### curl — личный ключ

```bash
curl https://vibecode.bitrix24.tech/v1/note/documents/77/files/5001 \
  -H "X-Api-Key: YOUR_API_KEY"
```

### curl — OAuth-приложение

```bash
curl https://vibecode.bitrix24.tech/v1/note/documents/77/files/5001 \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"
```

### JavaScript — личный ключ

```javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/note/documents/77/files/5001', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data } = await res.json()
console.log(data.assetMarkdown)
```

### JavaScript — OAuth-приложение

```javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/note/documents/77/files/5001', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

const { success, data } = await res.json()
```

## Поля ответа

| Поле | Тип | Описание |
|------|-----|---------|
| `success` | boolean | Всегда `true` при успехе |
| `data.id` | number | Идентификатор файла |
| `data.documentId` | number | Документ, к которому привязан файл |
| `data.name` | string | Оригинальное имя файла |
| `data.size` | number | Размер файла в байтах |
| `data.mimeType` | string | Тип содержимого файла в формате MIME, определённый при сохранении |
| `data.assetType` | string | Категория вложения: `image`, `video` или `file` |
| `data.assetMarkdown` | string | Готовый фрагмент `[[<assetType> fileId=<id>]]` для вставки в содержимое |

## Пример ответа

```json
{
  "success": true,
  "data": {
    "id": 5001,
    "documentId": 77,
    "name": "diagram.png",
    "size": 6321,
    "mimeType": "image/png",
    "assetType": "image",
    "assetMarkdown": "[[image fileId=5001]]"
  }
}
```

## Пример ответа при ошибке

404 — документ или файл не найдены:

```json
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "Запись с ID = `999999` не найдена"
  }
}
```

## Ошибки

| HTTP | Код | Описание |
|------|-----|---------|
| 400 | `INVALID_PARAMS` | Не передан `documentId` или `id`, либо параметр неверного типа |
| 403 | `SCOPE_DENIED` | Ключу не хватает скоупа `note` |
| 404 | `ENTITY_NOT_FOUND` | Документ или файл не существуют, нет доступа, либо файл не привязан к документу |
| 401 | `TOKEN_MISSING` | У ключа нет настроенных токенов |

Полный список общих ошибок API — [Ошибки](/docs/errors).

## Известные особенности

**Формат `assetMarkdown` и вставка вложения.** Чтобы вложение появилось в документе, добавьте `assetMarkdown` отдельной строкой в `markdown` и вызовите [`PATCH /v1/note/documents/:id`](/docs/note/documents). Фрагмент должен начинаться с начала строки, без других символов в той же строке. Тип пишется в нижнем регистре, `fileId` — целое положительное число.

## Смотрите также

- [Загрузить файл](/docs/note/files/upload)
- [Документы](/docs/note/documents)
- [Файлы](/docs/note/files)
- [Обзор Базы знаний](/docs/note)