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

Ограничение.

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

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

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

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

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

<file_data>

POST /v2/issues/<issue_id>/comments/<comment_id>/attachments/_import?filename={filename}&createdAt={createdAt}&createdBy={createdBy} 
Host: https://api.tracker.yandex.net
Authorization: OAuth <токен>
X-Org-ID: <идентификатор организации>
Content-Type: multipart/form-data

<file_data>

Ресурс

<issue_id>: Ключ задачи, к которой будет прикреплен файл.
<comment_id>: Идентификатор комментария, к которому будет прикреплен файл.

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

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

createdBy: Логин или идентификатор автора прикрепленного файла.

Заголовки запроса

Host

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

https://api.tracker.yandex.net

Authorization

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

OAuth 0c4181a7c2cf4521964a72ff57a34a07

X-Org-ID

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

Content-Type

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

Тело запроса

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

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

В случае успешного выполнения запроса API возвращает ответ с кодом 201. Тело ответа содержит параметры прикрепленного файла в формате 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`	Размер изображения в пикселях.	Строка.

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


HTTP-код ошибки	Описание ошибки
`400 Bad Request`	Один из параметров запроса имеет недопустимое значение или формат данных.
`403 Forbidden`	У пользователя или приложения нет прав на доступ к ресурсу, запрос отклонен.
`404 Not Found`	Запрашиваемый ресурс не найден.
`413 Request Entity Too Large`	Размер файла превышает 1024 Мбит.
`422 Unprocessable Entity`	Ошибка валидации, запрос отклонен.
`500 Internal Server Error`	Внутренняя ошибка сервиса. Попробуйте повторно отправить запрос через некоторое время.
`503 Service Unavailable`	Сервис API временно недоступен.


HTTP-код ошибки	Описание ошибки
`400 Bad Request`	Один из параметров запроса имеет недопустимое значение или формат данных.
`403 Forbidden`	У пользователя или приложения нет прав на доступ к ресурсу, запрос отклонен.
`404 Not Found`	Запрашиваемый ресурс не найден.
`413 Request Entity Too Large`	Размер файла превышает 1024 Мбит.
`422 Unprocessable Entity`	Ошибка валидации, запрос отклонен.
`500 Internal Server Error`	Внутренняя ошибка сервиса. Попробуйте повторно отправить запрос через некоторое время.
`503 Service Unavailable`	Сервис API временно недоступен.