Связаться с намиПодключиться

Импортировать файлы

Статья создана
Обновлена 26 августа 2024 г.

Важно

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

С помощью запроса вы можете вы можете импортировать в Tracker файлы, прикрепленные к задаче и комментариям под ней.

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

Чтобы импортировать файл, используйте HTTP-запрос с методом POST. Файл передается в теле запроса с использованием multipart/form-data RFC-7578. Размер файла не должен превышать 1024 Мбит.

POST /v2/issues/<ключ_или_идентификатор_задачи>/attachments/_import?filename={filename}&createdAt={createdAt}&createdBy={createdBy} 
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
X-Org-ID или X-Cloud-Org-ID: <идентификатор_организации>
Content-Type: multipart/form-data
<файл>
Заголовки

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

    https://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.

Ресурс
Параметр Описание Тип данных
<ключ_или_идентификатор_задачи> Ключ задачи, к которой будет прикреплен файл. Строка
<идентификатор_комментария> Идентификатор комментария, к которому будет прикреплен файл. Строка
Параметры запроса

Обязательные параметры

Параметр Описание Тип данных
filename Имя файла, максимальная длина - 255 символов. Строка
createdAt Дата и время прикрепления файла в формате YYYY-MM-DDThh:mm:ss.sss±hhmm. Вы можете указать любое значение в интервале времени от создания до последнего обновления задачи. Строка
createdBy Логин или идентификатор автора прикрепленного файла. Строка
Параметры тела запроса

Обязательные параметры

Параметр Описание Тип данных
file_data Файл в бинарном формате. Размер файла не должен превышать 1024 Мбит. Строка 
POST /v2/issues/<ключ_или_идентификатор_задачи>/comments/<идентификатор_комментария>/attachments/_import?filename={filename}&createdAt={createdAt}&createdBy={createdBy} 
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
X-Org-ID или X-Cloud-Org-ID: <идентификатор_организации>
Content-Type: multipart/form-data
<файл>
Заголовки

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

    https://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.

Ресурс
Параметр Описание Тип данных
<ключ_или_идентификатор_задачи> Ключ задачи, к которой будет прикреплен файл. Строка
<идентификатор_комментария> Идентификатор комментария, к которому будет прикреплен файл. Строка
Параметры запроса

Обязательные параметры

Параметр Описание Тип данных
filename Имя файла, максимальная длина - 255 символов. Строка
createdAt Дата и время прикрепления файла в формате YYYY-MM-DDThh:mm:ss.sss±hhmm. Вы можете указать любое значение в интервале времени от создания до последнего обновления задачи. Строка
createdBy Логин или идентификатор автора прикрепленного файла. Строка
Параметры тела запроса

Обязательные параметры

Параметр Описание Тип данных
<файл> Файл в бинарном формате. Размер файла не должен превышать 1024 Мбит. Строка

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

В случае успешного выполнения запроса API возвращает ответ с кодом 200 OK.

Тело ответа содержит параметры прикрепленного файла в формате JSON:

{
  "self" : "https://api.tracker.yandex.net/v2/issues/JUNE-2/attachments/123",
  "id" : "123",
  "name" : "pic.png",
  "content" : "api.tracker.yandex.net/v2/issues/JUNE-2/attachments/123/pic.png",
  "thumbnail" : "api.tracker.yandex.net/v2/issues/JUNE-2/thumbnails/123",
  "createdBy" : {
	"self" : "https://api.tracker.yandex.net/v2/users/12********",
	"id" : "12********",
	"display" : "<отображаемое_имя_сотрудника>"
  },
  "createdAt" : "2017-06-11T05:16:01.339+0000",
  "mimetype" : "image/png",
  "size" : 5678
  "metadata" : {
	"size" : "128x128"
  }
}
Параметры ответа
Параметр Описание Тип данных
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 Размер изображения в пикселях. Строка

Если запрос не был успешно обработан, ответное сообщение содержит информацию о возникших ошибках:

400
Один или несколько параметров запроса имеют недопустимое значение.
403
У вас не хватает прав на выполнение этого действия. Наличие прав можно перепроверить в интерфейсе Tracker — для выполнения действия при помощи API и через интерфейс требуются одинаковые права.
404
Запрошенный объект не был найден. Возможно, вы указали неверное значение идентификатора или ключа объекта.
413
Размер файла превышает 1024 Мбит.
422
Ошибка валидации JSON, запрос отклонен.
500
Внутренняя ошибка сервиса. Попробуйте повторно отправить запрос через некоторое время.
503
Сервис API временно недоступен.
Предыдущая
Импортировать задачу
Следующая
Импортировать комментарии