Getting entity links
The request allows you to get information about an entity's links with other entities.
Request format
Before making a request, get permission to access the API.
To get entity links, use an HTTP GET request.
GET /v2/entities/<entity_type>/<entity_ID>/links
Host: https://api.tracker.yandex.net
Authorization: OAuth <OAuth_token>
X-Org-ID: <organization ID>
Headers
-
Host
Address of the node that provides the API:
https://api.tracker.yandex.net -
Authorization
OAuth token in
OAuth <OAuth_token>format, e.g.:OAuth 0c4181a7c2cf4521964a72ff******** -
X-Org-ID or X-Cloud-Org-ID
Organization ID. You can find it out on the Tracker organizations page.
- If a Yandex 360 for Business organization is the only one linked to Tracker, the
X-Org-IDheader is used. - If a Yandex Cloud Organization organization is the only one linked to Tracker, the
X-Cloud-Org-IDheader is used. - If both Yandex 360 for Business and Yandex Cloud Organization organizations are linked to Tracker at the same time, the
X-Org-IDheader and the Yandex 360 for Business organization ID are used.
- If a Yandex 360 for Business organization is the only one linked to Tracker, the
Resource
| Parameter | Description | Data type |
|---|---|---|
| <entity_type> | Entity type:
|
String |
| <entity_ID> | Entity ID. To get the ID, see the entity list. | String |
| <project_or_portfolio_ID> | Project or portfolio ID (the shortId value). You can use it instead of the entity ID in the request. |
String |
Warning
Entity ID is not the same as project or portfolio ID.
Request parameters
Additional parameters
| Parameter | Description | Data type |
|---|---|---|
| fields | Additional entity fields to be included into the response. | String |
Example: Getting links between entities
- An HTTP GET method is used.
GET /v2/entities/project/<project_ID>/links?fields=id,summary Host: https://api.tracker.yandex.net Authorization: OAuth <OAuth_token> X-Org-ID: <organization ID>
Response format
If the request is successful, the API returns a response with code 200 OK.
The response body contains information about the entity links in JSON format.
[
{
"type": "is dependent by",
"linkFieldValues": {
"summary": "First project",
"id": "6582874de6db7f5f********"
}
},
{
"type": "relates",
"linkFieldValues": {
"summary": "Second project",
"id": "65868f3fe2b9ef74********"
}
}
]
Response parameters
| Parameter | Description | Data type |
|---|---|---|
| type | Link type:
|
String |
| linkFieldValues | List of fields and their values in linked entities. List of fields is specified in the fields parameter of the request. |
String |
If the request is processed incorrectly, the API returns a response with an error code:
- 400
- One or more request parameters have an invalid value.
- 404
- The requested object was not found. You may have specified an invalid object ID or key.
- 422
- JSON validation error, the request is rejected.