Получить список прикрепленных файлов

Запрос позволяет получить список файлов, прикрепленных к задаче и к комментариям под ней.

Формат запроса

Чтобы получить список прикрепленных файлов, используйте HTTP-запрос с методом GET:

GET /v2/issues/<issue-id>/attachments
Host: https://api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
X-Org-Id: <идентификатор организации>
Ресурс
<issue-id>
Идентификатор или ключ задачи.

Запрос списка прикрепленных файлов задачи с ключом JUNE-2:

  • Используется HTTP-метод GET.

GET /v2/issues/JUNE-2/attachments HTTP/1.1
Host: https://api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
X-Org-Id: <идентификатор организации>

Формат ответа

В случае успешного выполнения запроса API возвращает ответ с кодом 200. Тело ответа содержит JSON-массив со списком прикрепленных файлов.

[ 
{
  "self" : "<адрес ресурса API, соответствующего прикрепленному файлу>",
  "id" : "<идентификатор файла>",
  "name" : "<имя файла>",
  "content" : "<адрес для скачивания файла>",
  "thumbnail" : "<адрес для скачивания превью>",
  "createdBy" : {
    "self" : "<ресурс, соответствующий создателю файла>",
    "id" : "<логин создателя>",
    "display" : "<имя создателя>"
  },
  "createdAt" : "<дата и время добавления файла>",
  "mimetype" : "<тип данных файла>",
  "size" : <размер файла>
  "metadata" : {
    "size" : "<геометрический размер (для изображений)>"
  }
}, 
...
]
Параметры ответа
Параметр Описание Тип данных
self

Адрес ресурса API, который соответствует прикрепленному файлу.

Строка.

id

Уникальный идентификатор файла.

Строка.

name

Имя файла.

Строка.

content

Адрес ресурса для скачивания файла.

Строка.

thumbnail

Адрес ресурса для скачивания миниатюры предпросмотра. Доступно только для графических файлов.

Строка.

createdBy

Объект с информацией о пользователе, прикрепившем файл.

JSON-объект.

createdAt

Дата и время загрузки файла в формате:

YYYY-MM-DDThh:mm:ss.sss±hhmm

Строка.

mimetype

Тип файла, например:

  • text/plain — текстовый файл;

  • image/png — изображение в формате png.

Строка.

size

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

Целое число.

metadata

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

JSON-объект.

Поля объекта createdBy
self

Адрес ресурса, соответствующего пользователю, загрузившему файл.

Строка.

id

Логин пользователя.

Строка.

display

Имя пользователя (как в интерфейсе).

Строка.

Поля объекта metadata
size

Размер изображения в пикселях.

Строка.

Параметр Описание Тип данных
self

Адрес ресурса API, который соответствует прикрепленному файлу.

Строка.

id

Уникальный идентификатор файла.

Строка.

name

Имя файла.

Строка.

content

Адрес ресурса для скачивания файла.

Строка.

thumbnail

Адрес ресурса для скачивания миниатюры предпросмотра. Доступно только для графических файлов.

Строка.

createdBy

Объект с информацией о пользователе, прикрепившем файл.

JSON-объект.

createdAt

Дата и время загрузки файла в формате:

YYYY-MM-DDThh:mm:ss.sss±hhmm

Строка.

mimetype

Тип файла, например:

  • text/plain — текстовый файл;

  • image/png — изображение в формате png.

Строка.

size

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

Целое число.

metadata

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

JSON-объект.

Поля объекта createdBy
self

Адрес ресурса, соответствующего пользователю, загрузившему файл.

Строка.

id

Логин пользователя.

Строка.

display

Имя пользователя (как в интерфейсе).

Строка.

Поля объекта metadata
size

Размер изображения в пикселях.

Строка.

Возможные коды ответа

200
Запрос выполнен успешно.
404
Запрошенный объект не был найден. Возможно, вы указали неверное значение идентификатора или ключа объекта.