Получить список сущностей

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

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

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

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

Чтобы получить список сущностей, используйте HTTP-запрос с методом POST. Параметры запроса передаются в его теле в формате JSON.

POST /v2/entities/{entityType}/_search?fields=entityStatus
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
X-Org-ID или X-Cloud-Org-ID: <идентификатор_организации>

{
   "filter": 
   {
      "author": "<логин_пользователя>"
   }   
}

Пример 1: Получить список сущностей с помощью фильтра с расширенным списком полей в выдаче

• Используется HTTP-метод POST.
• Ответ должен содержать только взятые в работу проекты с непустым списком наблюдателей.
• В ответе включено отображение полей Статус, Автор и Наблюдатели.

POST /v2/entities/project/_search?fields=entityStatus&author&followers HTTP/1.1
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
X-Org-ID или X-Cloud-Org-ID: <идентификатор_организации>

{
  "filter": {
    "followers": "notEmpty()",
    "entityStatus": "in_progress"
  },
}

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

• Используется HTTP-метод POST.
• Ответ должен содержать все портфели, отсортированные по статусам.
• Результаты отсортированы в убывающем порядке.
• В ответе включено отображение полей Статус и Автор.

POST /v2/entities/project/_search?fields=entityStatus&author HTTP/1.1
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
X-Org-ID или X-Cloud-Org-ID: <идентификатор_организации>

{
  "orderBy": "entityStatus", 
  "orderAsc":true
}

Пример 3: Получить для указанного портфеля список вложенных проектов с помощью фильтра

• Используется HTTP-метод POST.
• Ответ должен содержать только вложенные проекты для родительского портфеля с указанным идентификатором.

POST /v2/entities/project/_search HTTP/1.1
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
X-Org-ID или X-Cloud-Org-ID: <идентификатор_организации>

{
  "filter": {
    "parentEntity": "65868add99a40477********"
  },
}

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

{
   "hits": 8,
   "pages": 1,
   "values": [
     {
         "self": "https://api.tracker.yandex.net/v2/entities/project/655f8ce5d6a39833********",
         "id": "655f8ce5d6a39833********",
         "version": 7,
         "shortId": 8,
         "entityType": "project",
         "createdBy": { "self": "https://api.tracker.yandex.net/v2/users/11********", "id": "11********", "display": "Имя Фамилия", "cloudUid": "ajevuhegoggf********", "passportUid": 11******** },
         "createdAt": "2023-11-23T17:33:25.427+0000",
         "updatedAt": "2023-11-24T12:21:43.838+0000",
         "fields": {
             "entityStatus": "in_progress",
             "followers": [{ "self": "https://api.tracker.yandex.net/v2/users/22********", "id": "22********", "display": "Имя Наблюдателя", "cloudUid": "ajeprm0fjnql********", "passportUid": 22******** }]
         }
     },
     {
         "self": "https://api.tracker.yandex.net/v2/entities/project/655f3815a834c763********",
         "id": "655f3815a834c763********",
         "version": 4,
         "shortId": 3,
         "entityType": "project",
         "createdBy": { "self": "https://api.tracker.yandex.net/v2/users/11********", "id": "11********", "display": "Имя Фамилия", "cloudUid": "ajevuhegoggf********", "passportUid": 11******** },
         "createdAt": "2023-11-23T11:31:33.874+0000",
         "updatedAt": "2023-11-23T21:52:10.863+0000",
         "fields": {
             "entityStatus": "draft",
             "followers": [{ "self": "https://api.tracker.yandex.net/v2/users/22********", "id": "22********", "display": "Имя Наблюдателя", "cloudUid": "ajeprm0fjnql********", "passportUid": 22******** }]
         }
     }
   ],
   "orderBy": "entityStatus"
}