Подключиться
Yandex Tracker

Загрузить временный файл

Статья создана
,
улучшена

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

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

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

POST /v2/attachments?filename=<новое имя файла>
Host: https://api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
X-Org-ID: <идентификатор организации>
Content-Type: multipart/form-data

<file_data>

Заголовки

  • Host

    Адрес узла, предоставляющего API:

    https://api.tracker.yandex.net

  • Authorization

    OAuth-токен в формате OAuth <значение токена>, например:

    OAuth 0c4181a7c2cf4521964a72ff57a34a07

  • X-Org-ID

    Идентификатор организации.

  • Content-Type

    Формат тела запроса. Должен иметь значение multipart/form-data.

Параметры запроса

  • filename (необязательный)

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

Тело запроса

  • <file_data>

    Файл в бинарном формате. Размер файла не должен превышать 1024 Мбайт.

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

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

{
  "self" : "https://api.tracker.yandex.net/v2/issues/JUNE-2/attachments/123",
  "id" : "123",
  "name" : "pic.png",
  "content" : "https://api.tracker.yandex.net/v2/issues/JUNE-2/attachments/123/pic.png",
  "thumbnail" : "https://api.tracker.yandex.net/v2/issues/JUNE-2/thumbnails/123",
  "createdBy" : {
    "self" : "https://api.tracker.yandex.net/v2/users/12314567890",
    "id" : "1234567890",
    "display" : "<отображаемое имя сотрудника>"
  },
  "createdAt" : "2017-06-11T05:16:01.339+0000",
  "mimetype" : "image/png",
  "size" : 5678
}

Параметры ответа

Параметр Описание Тип данных
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 Размер изображения в пикселях. Строка

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

201
В результате выполнения запроса с методом POST успешно создан новый объект.
400
Один или несколько параметров запроса имеют недопустимое значение.
404
Запрошенный объект не был найден. Возможно, вы указали неверное значение идентификатора или ключа объекта.
В этой статье: