Получить параметры сущности

Запрос позволяет получить информацию о сущности — цели, проекте или портфеле проектов.

GET

https://api.tracker.yandex.net/v3/entities/<тип_сущности>/<id_сущности>?expand=attachments&fields=summary,teamAccess

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

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

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

GET /v3/entities/<тип_сущности>/<id_сущности>?expand=attachments&fields=summary,teamAccess
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. Строка
Параметры запроса

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

Параметр Описание Тип данных
fields Дополнительные поля сущности, которые будут включены в ответ. Список допустимых полей Строка
expand Дополнительная информация, которая будет включена в ответ:
  • attachments – вложенные файлы.
 Строка

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

  • Используется HTTP-метод GET.
  • В ответе включено отображение вложений.
  • В ответ включено поле teamAccess.
GET https://api.tracker.yandex.net/v3/entities/portfolio/655f328da834c763********?expand=attachments&fields=teamAccess

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

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

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

{
   "self": "https://api.tracker.yandex.net/v3/entities/project/655f328da********",
   "id": "655f328da********",
   "version": 3,
   "shortId": 2,
   "entityType": "project",
   "createdBy": { "self": "https://api.tracker.yandex.net/v3/users/11********", "id": "11********", "display": "Имя Фамилия", "cloudUid": "ajevuhegoggf********", "passportUid": 11******** },
   "createdAt": "2023-11-23T11:07:57.298+0000",
   "updatedAt": "2023-11-23T15:46:26.391+0000",
   "attachments": [
      {
         "self": "https://api.tracker.yandex.net/v3/attachments/9",
         "id": "9",
         "name": "file2.pdf",
         "content": "api.tracker.yandex.net/v3/attachments/9/file2.pdf",
         "createdBy": { "self": "https://api.tracker.yandex.net/v3/users/11********", "id": "11********", "display": "Имя Фамилия", "cloudUid": "ajevuhegoggf********", "passportUid": 11******** },
         "createdAt": "2023-11-23T15:46:25.932+0000",
         "mimetype": "application/pdf",
         "size": 175656
      }
   ],
   "fields": {
     "summary": "Название проекта",
     "teamAccess": null,
     "author": { "self": "https://api.tracker.yandex.net/v3/users/11********", "id": "11********", "display": "Имя Фамилия", "cloudUid": "ajevuhegoggf********", "passportUid": 11******** },
     "parentEntity": {
         "primary": {
             "self": "https://api.tracker.yandex.net/v3/entities/portfolio/67ffd7e3********",
             "id": "67ffd7e3********",
             "display": "My portfolio"
         },
         "secondary": []
     }
   }

}
Параметры ответа
Параметр Описание Тип данных
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 Массив объектов с информацией о вложениях. Массив объектов
fields Блок с дополнительными полями сущности. Объект

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

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

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

400
Один или несколько параметров запроса имеют недопустимое значение.
401
Пользователь не авторизован. Проверьте, были ли выполнены действия, описанные в разделе Доступ к API.
403
У вас не хватает прав на выполнение этого действия. Наличие прав можно перепроверить в интерфейсе Трекера — для выполнения действия при помощи API и через интерфейс требуются одинаковые права.
404
Запрошенный объект не был найден. Возможно, вы указали неверное значение идентификатора или ключа объекта.
Предыдущая
Создать сущность
Следующая
Изменить сущность