Linking entities

The request allows you to create links between multiple entities.

POST

https://api.tracker.yandex.net/v3/entities/<entity_type>/<entity_ID>/links

To add a parent entity for a project or portfolio, edit the parentEntity field via a Updating an entity request.

Request format

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

To create links, use an HTTP POST request. Information about the links is sent in the request body in JSON format. The link is created between the current entity (specified in the request <entity_ID>) and the entities whose IDs are specified in the entity fields of the request body.

POST /v3/entities/<entity_type>/<entity_ID>/links
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth_token>
X-Org-ID or X-Cloud-Org-ID: <organization_ID>

{
  "relationship": "<link_type>",
  "entity": "<linked_entity_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 body parameters

Required 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

entity

ID of the linked entity.

String

Example: Creating a link between entities

  • An HTTP POST method is used.
POST /v3/entities/project/<project_ID>/links
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth_token>
X-Org-ID or X-Cloud-Org-ID: <organization_ID>

[
  {
     "relationship":"is dependent by",
     "entity": "6582874de6db7f5f********"
  },
  {
     "relationship":"works towards",
     "entity": "65868f3fe2b9ef74********"
  }
]

Response format

If the request is successful, the API returns a response with code 200 OK.

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
Deleting a file
Next
Getting links