Загрузить временный файл
Запрос позволяет загрузить временный файл. Используйте этот запрос, чтобы предварительно загрузить файл в Tracker, а затем прикрепить его при создании задачи или комментария.
Формат запроса
Перед выполнением запроса получите доступ к API.
Чтобы добавить временный файл, используйте HTTP-запрос с методом POST
.
POST /v2/attachments/
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 Created
.
Тело ответа содержит параметры прикрепленного файла в формате JSON.
{
"self" : "<адрес ресурса API, соответствующего прикрепленному файлу>",
"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 возвращает ответ с кодом ошибки:
- 400
- Один или несколько параметров запроса имеют недопустимое значение.
- 404
- Запрошенный объект не был найден. Возможно, вы указали неверное значение идентификатора или ключа объекта.