Связаться с намиПодключиться

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

Статья создана
Обновлена 26 августа 2024 г.

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

Запрос представляет унифицированный метод для получения информации о проектах и портфелях, более гибкий и функциональный, чем API получения информации о проектах.

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

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

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

GET /v2/entities/<тип_сущности>/<идентификатор_сущности>?expand=attachments&fields=summary,teamAccess
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 для бизнеса.
Ресурс
Параметр Описание Тип данных
<тип_сущности> Тип сущности:
  • project — проект;
  • portfolio — портфель.
 Строка
<идентификатор_сущности> Идентификатор сущности. Чтобы получить идентификатор, посмотрите список сущностей. Строка
<идентификатор_проекта_или_портфеля> Идентификатор проекта или портфеля (значение поля shortId). Его можно использовать в запросе вместо идентификатора сущности. Строка

Важно

Идентификатор сущности не совпадает с идентификатором проекта или портфеля.

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

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

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

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

  • Используется HTTP-метод GET.
  • В ответе включено отображение вложений.
  • В ответ включено поле teamAccess.
GET /v2/entities/portfolio/655f328da834c763********?expand=attachments&fields=teamAccess HTTP/1.1
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
X-Org-ID или X-Cloud-Org-ID: <идентификатор_организации>

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

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

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

{
   "self": "https://api.tracker.yandex.net/v2/entities/project/655f328da834c763********",
   "id": "655f328da834c763********",
   "version": 3,
   "shortId": 2,
   "entityType": "project",
   "createdBy": { "self": "https://api.tracker.yandex.net/v2/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/v2/attachments/8",
         "id": "8",
         "name": "file1.docx",
         "content": "api.tracker.yandex.net/v2/attachments/8/file1.docx",
         "createdBy": { "self": "https://api.tracker.yandex.net/v2/users/11********", "id": "11********", "display": "Имя Фамилия", "cloudUid": "ajevuhegoggf********", "passportUid": 11******** },
         "createdAt": "2023-11-23T15:46:20.617+0000",
         "mimetype": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
         "size": 18585
      },
      {
         "self": "https://api.tracker.yandex.net/v2/attachments/9",
         "id": "9",
         "name": "file2.pdf",
         "content": "api.tracker.yandex.net/v2/attachments/9/file2.pdf",
         "createdBy": { "self": "https://api.tracker.yandex.net/v2/users/11********", "id": "11********", "display": "Имя Фамилия", "cloudUid": "ajevuhegoggf********", "passportUid": 11******** },
         "createdAt": "2023-11-23T15:46:25.932+0000",
         "mimetype": "application/pdf",
         "size": 175656
      }
   ],
   "fields":
   {
      "teamAccess":null
   }
}
Параметры ответа
Параметр Описание Тип данных
self Адрес ресурса API, который содержит информацию о проекте. Строка
id Идентификатор сущности. Строка
version Версия сущности. Каждое изменение параметров увеличивает номер версии. Число
shortId Идентификатор проекта или портфеля. Строка
entityType Тип сущности. Строка
createdBy Блок с информацией о создателе сущности. Объект
createdAt Дата создания сущности в формате YYYY-MM-DDThh:mm:ss.sss±hhmm. Строка
updatedAt Дата последнего обновления сущности в формате YYYY-MM-DDThh:mm:ss.sss±hhmm. Строка
attachments Массив объектов с информацией о вложении. Массив объектов

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

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

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

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