Прикрепить файл к сущности

Запрос позволяет прикрепить файл к сущности.

POST

https://api.tracker.yandex.net/v3/entities/<тип_сущности>/<id_сущности>/attachments/<id_файла>

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

Перед выполнением запроса получите доступ к API.

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

POST /v3/entities/<тип_сущности>/<id_сущности>/attachments/<id_файла>
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
X-Org-ID или X-Cloud-Org-ID: <идентификатор_организации>

Заголовки

Host: адрес узла, предоставляющего API.
Authorization: токен для авторизации в одном из форматов:
- OAuth <OAuth-токен> при авторизации по протоколу OAuth 2.0. Читать подробнее
- Bearer <IAM-токен> при авторизации с помощью IAM-токена — если к Трекеру привязана организация Yandex Cloud Organization. Читать подробнее
X-Org-ID или X-Cloud-Org-ID: идентификатор организации.
- Используйте заголовок X-Org-ID, если к Трекеру привязана организация Яндекс 360 для бизнеса.
- Используйте заголовок X-Cloud-Org-ID, если к Трекеру привязана организация Yandex Cloud Organization.
Чтобы узнать идентификатор организации, перейдите на страницу Администрирование → Организации и скопируйте значение поля идентификатор.

Ресурс

Параметр	Описание	Тип данных
<тип_сущности>	Тип сущности: project — проект; portfolio — портфель; goal — цель	Строка
<id_сущности>	Идентификатор сущности. Чтобы получить идентификатор, посмотрите список сущностей.	Строка
<id_файла>	Идентификатор временного файла, который был предварительно загружен в Трекер.	Строка

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

Дополнительные параметры

Параметр	Описание	Тип данных
notify	Уведомлять пользователей, которые указаны в полях Автор, Ответственный, Участники, Заказчики и Наблюдатели. Значение по умолчанию — `true`.	Логический
notifyAuthor	Уведомлять автора изменений. Значение по умолчанию — `false`.	Логический
fields	Дополнительные поля сущности, которые будут включены в ответ.	Строка
expand	Дополнительная информация, которая будет включена в ответ: `all` — все; `attachments` — вложенные файлы.	Строка

Пример: Прикрепить файл к сущности

Используется HTTP-метод POST.

Прикрепить к проекту временный файл с идентификатором 30.

В ответе вывести информацию обо всех прикрепленных файлах.
POST https://api.tracker.yandex.net/v3/entities/project/<id_проекта>/attachments/30?expand=attachments

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

Запрос выполнен успешно

Запрос выполнен с ошибкой

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

Тело ответа содержит информацию о вложении сущности.

{
    "self": "https://api.tracker.yandex.net/v3/entities/project/6586d6fee2b9ef74********", 
    "id": "6586d6fee2b9ef74********", 
    "version": 78, 
    "shortId": 4, 
    "entityType": "project", 
    "createdBy": {
        "self": "https://api.tracker.yandex.net/v3/users/11********",
        "id": "11********",
        "display": "Имя Фамилия",
        "cloudUid": "ajeppa7dgp53********",
        "passportUid": 11********
    },
    "createdAt": "2023-12-23T12:47:58.405+0000", 
    "updatedAt": "2024-01-13T14:06:29.747+0000",
    "attachments": [
        {
            "self": "https://api.tracker.yandex.net/v3/attachments/4", 
            "id": "4", 
            "name": "newimage.jpg", 
            "content": "api.tracker.yandex.net/v3/attachments/4/newimage.jpg", 
            "createdBy": {
                "self": "https://api.tracker.yandex.net/v3/users/11********",
                "id": "11********",
                "display": "Имя Фамилия",
                "cloudUid": "ajeppa7dgp53********",
                "passportUid": 11********
            },
            "createdAt": "2024-01-11T06:24:57.635+0000", 
            "mimetype": "image/jpeg", 
            "size": 20466
        }
    ]
}

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

Параметр	Описание	Тип данных
self	Адрес ресурса API, который содержит информацию о сущности.	Строка
id	Идентификатор сущности.	Строка
version	Версия сущности. Каждое изменение параметров увеличивает номер версии. Редактирование сущности будет заблокировано, если версия достигнет предельного значения: для роботов `10100`, для пользователей `11100`.	Число
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	Тип файла, например: `text/plain` — текстовый файл; `image/png` — изображение в формате png.	Строка
size	Размер файла в байтах.	Целое число
metadata	Объект с метаданными файла.	Объект

Поля объекта createdBy

Параметр	Описание	Тип данных
self	Адрес ресурса API, который содержит информацию о пользователе.	Строка
id	Идентификатор пользователя.	Строка
display	Отображаемое имя пользователя.	Строка
passportUid	Уникальный идентификатор аккаунта пользователя в организации Яндекс 360 для бизнеса и Яндекс ID.	Число
cloudUid	Уникальный идентификатор пользователя в Yandex Cloud Organization.	Строка

Поля объекта metadata

Параметр	Описание	Тип данных
size	Размер изображения в пикселях.	Строка

Если запрос не был успешно обработан, API возвращает ответ с кодом ошибки:

400: Один или несколько параметров запроса имеют недопустимое значение.

404: Запрошенный объект не был найден. Возможно, вы указали неверное значение идентификатора или ключа объекта.

422: Ошибка валидации JSON, запрос отклонен.

423: Редактирование объекта заблокировано. Возможно, превышено допустимое значение параметра version — количество обновлений объекта. Максимальное значение версии составляет 10100 для роботов и 11100 для пользователей.

Была ли статья полезна?

Получить информацию о прикрепленном файле

Удалить файл