Получить список прикрепленных файлов
Статья создана
Обновлена 26 августа 2024 г.
Запрос позволяет получить список файлов, прикрепленных к задаче и к комментариям под ней.
Формат запроса
Перед выполнением запроса получите доступ к API.
Чтобы получить список прикрепленных файлов, используйте HTTP-запрос с методом GET.
GET /v2/issues/<ключ_или_идентификатор_задачи>/attachments
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
X-Org-ID или X-Cloud-Org-ID: <идентификатор_организации>
Заголовки
-
Host
Адрес узла, предоставляющего API:
api.tracker.yandex.net -
Authorization
OAuth-токен в формате
OAuth <OAuth-токен>, например:OAuth 0c4181a7c2cf4521964a72ff******** -
X-Org-ID или X-Cloud-Org-ID
Идентификатор организации. Узнать его можно на странице организаций Tracker.
- Если к Tracker привязана только организация Яндекс 360 для бизнеса, используется заголовок
X-Org-ID. - Если к Tracker привязана только организация Yandex Cloud Organization, используется заголовок
X-Cloud-Org-ID. - Если к Tracker одновременно привязаны организации Яндекс 360 для бизнеса и Yandex Cloud Organization, используется заголовок
X-Org-IDи идентификатор организации Яндекс 360 для бизнеса.
- Если к Tracker привязана только организация Яндекс 360 для бизнеса, используется заголовок
Ресурс
| Параметр | Описание | Тип данных |
|---|---|---|
| <ключ_или_идентификатор_задачи> | Идентификатор или ключ задачи | Строка |
Пример: Запросить список прикрепленных файлов задачи с ключом
JUNE-2.
- Используется HTTP-метод
GET.GET /v2/issues/JUNE-2/attachments HTTP/1.1 Host: api.tracker.yandex.net Authorization: OAuth <OAuth-токен> X-Org-ID или X-Cloud-Org-ID: <идентификатор_организации>
Формат ответа
Запрос выполнен успешно
Запрос выполнен с ошибкой
В случае успешного выполнения запроса API возвращает ответ с кодом 200 OK.
Тело ответа содержит 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
- Запрошенный объект не был найден. Возможно, вы указали неверное значение идентификатора или ключа объекта.