Прикрепить файл к задаче с помощью запроса к API
Запрос позволяет прикрепить файл к задаче. Прикрепленный файл отобразится на вкладке Вложения.
Формат запроса
Перед выполнением запроса получите доступ к API.
Чтобы прикрепить файл, используйте HTTP-запрос с методом POST.
POST /v2/issues/<ключ_или_идентификатор_задачи>/attachments/
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
X-Org-ID или X-Cloud-Org-ID: <идентификатор_организации>
Content-Type: multipart/form-data
<файл>
Заголовки
-
Host
Адрес узла, предоставляющего API:api.tracker.yandex.net -
Authorization
OAuth-токен в формате
OAuth <OAuth-токен>, например:OAuth 0c4181a7c2cf4521964a72ff******** -
X-Org-ID или X-Cloud-Org-ID
Идентификатор организации. Если у вас только организация Yandex Cloud Organization, используйте заголовок
X-Cloud-Org-ID, если только Яндекс 360 для бизнеса или оба типа организаций —X-Org-ID. -
Content-Type
Формат тела запроса. Должен иметь значение
multipart/form-data.
Ресурс
| Параметр | Описание | Тип данных |
|---|---|---|
| <ключ_или_идентификатор_задачи> | Идентификатор или ключ задачи | Строка |
Параметры запроса
Дополнительные параметры
| Параметр | Описание | Тип данных |
|---|---|---|
| <новое_имя_файла> | Новое имя файла, с которым он будет храниться на сервере | Строка |
Параметры тела запроса
Обязательные параметры
| Параметр | Описание | Тип данных |
|---|---|---|
| <файл> | Файл в бинарном формате. Размер файла не должен превышать 1024 Мбит. | Файл |
Формат ответа
В случае успешного выполнения запроса API возвращает ответ с кодом 201 Created.
Тело ответа содержит параметры прикрепленного файла в формате JSON.
{
"self": "<адрес_файла>",
"id": "<идентификатор_файла>",
"name": "<имя_файла>",
"content": "<адрес_для_скачивания_файла>",
"thumbnail": "<адрес_для_скачивания_превью>",
"createdBy": {
"self": "<адрес_создателя>",
"id": "<логин_создателя>",
"display": "<имя_создателя>"
},
"createdAt": "<дата_и_время_добавления_файла>",
"mimetype": "<тип_файла>",
"size": <размер_файла>,
"metadata": {
"size": "<геометрический_размер_изображения>"
}
}
Параметры ответа
| Параметр | Описание | Тип данных |
|---|---|---|
| self | Адрес ресурса API, который соответствует прикрепленному файлу. | Строка |
| id | Уникальный идентификатор файла. | Строка |
| name | Имя файла. | Строка |
| content | Адрес ресурса для скачивания файла. | Строка |
| thumbnail | Адрес ресурса для скачивания миниатюры предпросмотра. Доступно только для графических файлов. | Строка |
| createdBy | Объект с информацией о пользователе, прикрепившем файл. | Объект |
| createdAt | Дата и время загрузки файла в формате:YYYY-MM-DDThh:mm:ss.sss±hhmm |
Строка |
| mimetype | Тип файла, например:
|
Строка |
| size | Размер файла в байтах. | Целое число |
| metadata | Объект с метаданными файла. | Объект |
Поля объекта createdBy
| Параметр | Описание | Тип данных |
|---|---|---|
| self | Адрес ресурса, соответствующего пользователю, загрузившему файл | Строка |
| id | Логин пользователя | Строка |
| display | Имя пользователя (как в интерфейсе) | Строка |
Поля объекта metadata
| Параметр | Описание | Тип данных |
|---|---|---|
| size | Размер изображения в пикселях | Строка |
Если запрос не был успешно обработан, API возвращает ответ с кодом ошибки:
- 404
- Запрошенный объект не был найден. Возможно, вы указали неверное значение идентификатора или ключа объекта.