Прикрепить файл к сущности
Статья создана
Обновлена 26 августа 2024 г.
Запрос позволяет прикрепить файл к сущности. Прикрепленный файл отобразится на вкладке О проекте или О портфеле.
Формат запроса
Перед выполнением запроса получите доступ к API.
Чтобы прикрепить файл, используйте HTTP-запрос с методом POST.
POST /v2/entities/<тип_сущности>/<идентификатор_сущности>/attachments/<идентификатор_файла>
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
X-Org-ID или X-Cloud-Org-ID: <идентификатор_организации>
Заголовки
-
Host
Адрес узла, предоставляющего API:
api.tracker.yandex.net -
Authorization
OAuth-токен в формате
OAuth <OAuth-токен>, например:OAuth 0c4181a7c2cf4521964a72ff******** -
X-Org-ID или X-Cloud-Org-ID
Идентификатор организации. Узнать его можно на странице организаций Tracker.
- Если к Tracker привязана только организация Яндекс 360 для бизнеса, используется заголовок
X-Org-ID. - Если к Tracker привязана только организация Yandex Cloud Organization, используется заголовок
X-Cloud-Org-ID. - Если к Tracker одновременно привязаны организации Яндекс 360 для бизнеса и Yandex Cloud Organization, используется заголовок
X-Org-IDи идентификатор организации Яндекс 360 для бизнеса.
- Если к Tracker привязана только организация Яндекс 360 для бизнеса, используется заголовок
Ресурс
| Параметр | Описание | Тип данных |
|---|---|---|
| <тип_сущности> | Тип сущности:
|
Строка |
| <идентификатор_сущности> | Идентификатор сущности. Чтобы получить идентификатор, посмотрите список сущностей. | Строка |
| <идентификатор_проекта_или_портфеля> | Идентификатор проекта или портфеля (значение поля shortId). Его можно использовать в запросе вместо идентификатора сущности. |
Строка |
| <идентификатор_файла> | Идентификатор временного файла, который был предварительно загружен в Tracker. | Строка |
Важно
Идентификатор сущности не совпадает с идентификатором проекта или портфеля.
Параметры запроса
Дополнительные параметры
| Параметр | Описание | Тип данных |
|---|---|---|
| notify | Уведомлять пользователей, которые указаны в полях Автор, Ответственный, Участники, Заказчики и Наблюдатели. Значение по умолчанию — true. |
Логический |
| notifyAuthor | Уведомлять автора изменений. Значение по умолчанию — false. |
Логический |
| fields | Дополнительные поля сущности, которые будут включены в ответ. | Строка |
| expand | Дополнительная информация, которая будет включена в ответ:
|
Строка |
Пример: Прикрепить файл к сущности
- Используется HTTP-метод POST.
- В ответе выводится информация о всех прикрепленных файлах.
POST /v2/entities/project/<идентификатор_проекта>/attachments/30?expand=attachments Host: api.tracker.yandex.net Authorization: OAuth <OAuth-токен> X-Org-ID или X-Cloud-Org-ID: <идентификатор_организации>
Формат ответа
Запрос выполнен успешно
Запрос выполнен с ошибкой
В случае успешного выполнения запроса API возвращает ответ с кодом 200 OK.
Тело ответа содержит информацию о вложении сущности.
{
"self": "api.tracker.yandex.net/v2/entities/project/6586d6fee2b9ef74********",
"id": "6586d6fee2b9ef74********",
"version": 78,
"shortId": 4,
"entityType": "project",
"createdBy": {
"self": "api.tracker.yandex.net/v2/users/19********",
"id": "19********",
"display": "Имя Фамилия",
"cloudUid": "ajeppa7dgp53********",
"passportUid": "15********"
},
"createdAt": "2023-12-23T12:47:58.405+0000",
"updatedAt": "2024-01-13T14:06:29.747+0000",
"attachments": [
{
"self": "api.tracker.yandex.net/v2/attachments/4",
"id": "4",
"name": "newimage.jpg",
"content": "api.tracker.yandex.net/v2/attachments/4/newimage.jpg",
"createdBy": {
"self": "api.tracker.yandex.net/v2/users/19********",
"id": "19********",
"display": "Имя Фамилия",
"cloudUid": "ajeppa7dgp53********",
"passportUid": "15********"
},
"createdAt": "2024-01-11T06:24:57.635+0000",
"mimetype": "image/jpeg",
"size": 20466
}
]
}
Параметры ответа
| Параметр | Описание | Тип данных |
|---|---|---|
| self | Адрес ресурса API, который содержит информацию о сущности. | Строка |
| id | Идентификатор сущности. | Строка |
| version | Версия сущности. Каждое изменение параметров увеличивает номер версии. | Число |
| shortId | Идентификатор проекта или портфеля. | Строка |
| entityType | Тип сущности. | Строка |
| createdBy | Блок с информацией о создателе сущности. | Объект |
| createdAt | Дата создания сущности в формате YYYY-MM-DDThh:mm:ss.sss±hhmm. |
Строка |
| updatedAt | Дата последнего обновления сущности в формате YYYY-MM-DDThh:mm:ss.sss±hhmm. |
Строка |
| attachments | Массив объектов с информацией о вложении. | Массив объектов |
Поля объекта attachments
| Параметр | Описание | Тип данных |
|---|---|---|
| self | Адрес ресурса API, который содержит информацию о прикрепленных файлах сущности. | Строка |
| id | Идентификатор файла. | Строка |
| name | Имя файла. | Строка |
| content | Адрес ресурса для скачивания файла. | Строка |
| thumbnail | Адрес ресурса для скачивания миниатюры предпросмотра. Доступно только для графических файлов. | Строка |
| createdBy | Объект с информацией о пользователе, прикрепившем файл. | Объект |
| createdAt | Дата и время загрузки файла в формате YYYY-MM-DDThh:mm:ss.sss±hhmm. |
Строка |
| mimetype | Тип файла, например:
|
Строка |
| size | Размер файла в байтах. | Целое число |
| metadata | Объект с метаданными файла. | Объект |
Поля объекта createdBy
| Параметр | Описание | Тип данных |
|---|---|---|
| self | Адрес ресурса API, который содержит информацию о пользователе. | Строка |
| id | Идентификатор пользователя. | Число |
| display | Отображаемое имя пользователя. | Строка |
| cloudUid | Уникальный идентификатор пользователя в Yandex Cloud Organization. | Строка |
| passportUid | Уникальный идентификатор аккаунта пользователя в организации Яндекс 360 для бизнеса и Яндекс ID. | Строка |
Поля объекта metadata
| Параметр | Описание | Тип данных |
|---|---|---|
| size | Размер изображения в пикселях. | Строка |
Если запрос не был успешно обработан, API возвращает ответ с кодом ошибки:
- 400
- Один или несколько параметров запроса имеют недопустимое значение.
- 404
- Запрошенный объект не был найден. Возможно, вы указали неверное значение идентификатора или ключа объекта.
- 422
- Ошибка валидации JSON, запрос отклонен.