Getting a list of entities

Use this request to get a list of entities that meet specific criteria.

The request is a unified method for getting a list of projects and portfolios, more flexible and functional than the get project list API.

Request formatRequest format

Before making a request, get permission to access the API.

To get a list of entities, use an HTTP POST request. Request parameters are provided in the request body in JSON format.

POST /v2/entities/{entityType}/_search?fields=entityStatus
Host: https://api.tracker.yandex.net
Authorization: OAuth <OAuth_token>
X-Org-ID: <organization ID>

{
   "filter":
   {
      "author": "<username>"
   }   
}

Example 1: Getting a list of entities using a filter with an extended list of fields in search results

• An HTTP POST method is used.
• The response should only contain projects in progress with a non-empty list of followers.
• The Status, Reporter, and Followers field values are displayed in the response.

POST /v2/entities/project/_search?fields=entityStatus&author&followers HTTP/1.1
Host: https://api.tracker.yandex.net
Authorization: OAuth <OAuth_token>
X-Org-ID: <organization ID>

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

Example 2: Getting a sorted list of all entities

• An HTTP POST method is used.
• The response should contain all portfolios sorted by status.
• The results are sorted in descending order.
• The Status and Reporter field values are displayed in the response.

POST /v2/entities/project/_search?fields=entityStatus&author HTTP/1.1
Host: https://api.tracker.yandex.net
Authorization: OAuth <OAuth_token>
X-Org-ID: <organization ID>

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

Example 3: Getting a list of nested projects for the specified portfolio using a filter

• An HTTP POST method is used.
• The response should only contain the nested projects for the parent portfolio with the specified ID.

POST /v2/entities/project/_search HTTP/1.1
Host: https://api.tracker.yandex.net
Authorization: OAuth <OAuth_token>
X-Org-ID: <organization ID>

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

Response formatResponse format

{
   "hits": 8,
   "pages": 1,
   "values": [
     {
         "self": "https://https://api.tracker.yandex.net/v2/entities/project/655f8ce5d6a39833********",
         "id": "655f8ce5d6a39833********",
         "version": 7,
         "shortId": 8,
         "entityType": "project",
         "createdBy": { "self": "https://https://api.tracker.yandex.net/v2/users/11********", "id": "11********", "display": "Full Name", "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://https://api.tracker.yandex.net/v2/users/22********", "id": "22********", "display": "Follower name", "cloudUid": "ajeprm0fjnql********", "passportUid": 22******** }]
         }
     },
     {
         "self": "https://https://api.tracker.yandex.net/v2/entities/project/655f3815a834c763********",
         "id": "655f3815a834c763********",
         "version": 4,
         "shortId": 3,
         "entityType": "project",
         "createdBy": { "self": "https://https://api.tracker.yandex.net/v2/users/11********", "id": "11********", "display": "Full Name", "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://https://api.tracker.yandex.net/v2/users/22********", "id": "22********", "display": "Follower name", "cloudUid": "ajeprm0fjnql********", "passportUid": 22******** }]
         }
     }
   ],
   "orderBy": "entityStatus"
}