Получить метаданные вложения

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

GET

https://api.tracker.yandex.net/v3/issues/{id_задачи}/attachments/{id_файла}

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

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

Чтобы получить метаданные вложения, используйте HTTP-запрос с методом GET:

GET /v3/issues/{id_задачи}/attachments/{id_файла}
Host: api.tracker.yandex.net
Authorization: OAuth API_TOKEN
X-Org-ID или X-Cloud-Org-ID: ИДЕНТИФИКАТОР_ОРГАНИЗАЦИИ
Заголовки

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

  • Authorization: токен для авторизации в одном из форматов:

    • OAuth OAUTH_TOKEN при авторизации по протоколу OAuth 2.0. Читать подробнее

    • Bearer IAM_TOKEN при авторизации с помощью IAM-токена — если к Трекеру привязана организация Yandex Identity Hub. Читать подробнее

  • X-Org-ID или X-Cloud-Org-ID: идентификатор организации.

    • если к Трекеру привязана организация Яндекс 360 для бизнеса, используйте заголовок X-Org-ID,

    • если к Трекеру привязана организация Yandex Identity Hub, используйте заголовок X-Cloud-Org-ID.

    Чтобы узнать идентификатор организации, перейдите на страницу Администрирование → Организации и скопируйте значение поля идентификатор.

Ресурс

Обязательные параметры

Параметр Описание Тип данных
id_задачи Идентификатор или ключ задачи. Строка
id_файла Уникальный идентификатор файла. Строка или число

Пример: Получить метаданные вложения

GET https://api.tracker.yandex.net/v3/issues/JUNE-2/attachments/4159

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

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

Тело ответа содержит метаданные вложения в формате JSON.

{
    "self": "https://api.tracker.yandex.net/v3/issues/JUNE-2/attachments/4159",
    "id": "4159",
    "name": "attachment.txt",
    "content": "https://api.tracker.yandex.net/v3/issues/JUNE-2/attachments/4159/attachment.txt",
    "createdBy": {
        "self": "https://api.tracker.yandex.net/v3/users/11********",
        "id": "11********",
        "display": "Имя Фамилия"
    },
    "createdAt": "2017-06-11T05:11:12.347+0000",
    "mimetype": "text/plain",
    "size": 19090
}

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

Параметр Описание Тип данных
self Адрес ресурса API, который соответствует вложению. Строка
id Уникальный идентификатор файла. Строка
name Имя файла. Строка
content Адрес ресурса для скачивания файла. Строка
createdBy Объект с информацией о пользователе, прикрепившем файл. Объект
createdAt Дата и время загрузки файла. Строка
mimetype MIME-тип файла. Строка
size Размер файла в байтах. Целое число

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

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