Getting entity links

The request allows you to get information about an entity's links with other entities.

GET

https://api.tracker.yandex.net/v3/entities/<entity_type>/<entity_ID>/links?fields=<entity_fields>

Request format

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

To get entity links, use an HTTP GET request.

GET /v3/entities/<entity_type>/<entity_ID>/links?fields=<entity_fields>
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth_token>
X-Org-ID or X-Cloud-Org-ID: <organization_ID>
Headers

  • Host: Address of the node that provides the API.

  • Authorization: Authorization token about these formats:

    • OAuth <OAuth_token>: For authorization using the OAuth 2.0 protocol. Learn more

    • Bearer <IAM_token>: For authorization using an IAM token, if a Yandex Cloud Organization organization is linked to Tracker. Learn more

  • X-Org-ID or X-Cloud-Org-ID: Organization ID.

    • Use the X-Org-ID header if a Tracker organization is linked to Yandex 360 for Business.

    • Use the X-Cloud-Org-ID header if a Tracker organization is linked to Yandex Cloud Organization.

    To get the organization ID, go to Administration → Organizations and copy the value from the ID field.

Resource
Parameter Description Data type
<entity_type> Entity type:
  • project
  • portfolio
  • goal
 String
<entity_ID> Entity ID. To get the ID, see the entity list. You can use the id or shortId parameter as the ID. String
Request parameters

Additional parameters

Parameter Description Data type
fields Fields of the linked entities to include in the response. Supported fields String

Example: Get links between entities

  • An HTTP GET method is used.
  • The response includes the id and summary fields of the linked entities.
GET https://api.tracker.yandex.net/v3/entities/project/<project_ID>/links?fields=id,summary

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": "Project 1",
            "id": "6582874de6db7f5f********"
        }
    },
    {
        "type": "relates",
        "linkFieldValues": {
            "summary": "Project 2",
            "id": "65868f3fe2b9ef74********"
        }
    }
]
Response parameters

Parameter

Description

Data type

relationship

Link type. For projects and portfolios:

  • depends on: The current entity depends on the linked one.
  • is dependent by: The current entity blocks the linked one.
  • works towards: Project link to a goal.

For goals:

  • parent entity: Parent goal.
  • child entity: Subgoal.
  • depends on: The current goal depends on the linked one.
  • is dependent by: The current goal blocks the linked one.
  • is supported by: Link to a project.

String

linkFieldValues

List of fields and their values in linked entities. List of fields is specified in the fields parameter of the request. For more information, see Additional entity parameters

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.
Previous
Linking entities
Next
Deleting a link