Получить список прикрепленных файлов

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

GET

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

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

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

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

GET /v3/entities/<тип_сущности>/<id_сущности>/attachments
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 или shortId. Строка

Пример: Получить список прикрепленных файлов

  • Используется HTTP-метод GET.
  • В ответе выводится информация о всех прикрепленных файлах сущности.
GET https://api.tracker.yandex.net/v3/entities/project/<id_проекта>/attachments

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

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

Тело ответа содержит информацию о всех прикрепленных файлах сущности в формате JSON.

[
    {
        "self": "https://api.tracker.yandex.net/v3/attachments/3", 
        "id": "3",
        "name": "Shops.csv", 
        "content": "api.tracker.yandex.net/v3/attachments/3/Shops.csv",
        "createdBy": {
            "self": "https://api.tracker.yandex.net/v3/users/11********",
            "id": "11********",
            "display": "Имя Фамилия",
            "cloudUid": "ajeppa7dgp53********",
            "passportUid": 11********
        },
        "createdAt": "2023-12-25T07:21:36.722+0000", 
        "mimetype": "text/csv", 
        "size": 559
    }, 
    {
        "self": "https://api.tracker.yandex.net/v3/attachments/5", 
        "id": "5", 
        "name": "flowers.jpg", 
        "content": "api.tracker.yandex.net/v3/attachments/5/flowers.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, 
        "metadata": {
            "size": "236x295"
        }
    }
]
Параметры ответа
Параметр Описание Тип данных
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, запрос отклонен.
Предыдущая
Метрики
Следующая
Получить информацию о прикрепленном файле