Link issues

Written by

Request format
Response format

Use this request to create links between two issues. A link is created between the current issue (specified in the issue-id request parameter) and the linked one (specified in the issue field of the request body).

Request format

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

To create links, use an HTTP POST request:

POST /v2/issues/<issue-id>/links
Host: https://api.tracker.yandex.net
Authorization: OAuth <OAuth token>
X-Org-ID: <organization ID>

{
    "relationship": "<link type>",
    "issue": "<issue>"
}

Headers

Host

Address of the node that provides the API:
```
https://api.tracker.yandex.net
```
Authorization

OAuth token in OAuth <token value> format. For example:
```
OAuth 0c4181a7c2cf4521964a72ff57a34a07
```
X-Org-ID

Organization ID.

Resource

Parameter	Description	Data type
<issue-id>	ID or key of the current issue.	String

Request body parameters

Required parameters

Parameter	Description	Format
relationship	Type of links between issues: `relates`: Simple link. `is dependent by`: The current issue blocks the linked one. `depends on`: The current issue depends on the linked one. `is subtask for`: The current issue is a sub-issue of the linked one. `is parent task for`: The current issue is a parent issue of the linked one. `duplicates`: The current issue duplicates the linked one. `is duplicated by`: The linked issue duplicates the current one. `is epic of`: The current issue is an epic of the linked one. You can only set this type of link for Epic-type issues. `has epic`: The linked issue is an epic of the current one. You can only set this type of link for Epic-type issues.	String
issue	ID or key of the issue being linked.	String

Example: Creating a link

An HTTP POST method is used.

POST /v2/issues/TEST-1/?links HTTP/1.1
Host: https://api.tracker.yandex.net
Authorization: OAuth <OAuth token>
X-Org-ID: <organization ID>

{
    "relationship": "relates",
    "issue": "TREK-2"
}

Response format

Successful execution of the request

The request failed

If the request is successful, the API returns a response with code 201 Created.

The response body contains the results in JSON format.

  {
    "self" : "https://api.tracker.yandex.net/v2/issues/TEST-1/links/1048570",
    "id" : 1048570,
    "type" : {
      "self" : "https://api.tracker.yandex.net/v2/linktypes/relates",
      "id" : "relates",
      "inward" : "relates",
      "outward" : "relates"
    },
    "direction" : "inward",
    "object" : {
      "self" : "https://api.tracker.yandex.net/v2/issues/STARTREK-2",
      "id" : "4ff3e8dae4b0e2ac27f6eb43",
      "key" : "TREK-2",
      "display" : "NEW!!!"
    },
    "createdBy" : {
      "self" : "https://api.tracker.yandex.net/v2/users/1120000000004859",
      "id": "<employee ID>",
      "display": "<employee name displayed>"
    },
    "updatedBy" : {
      "self": "https://api.tracker.yandex.net/v2/users/1120000000049224",
      "id": "<employee ID>",
      "display": "<employee name displayed>"
    },
    "createdAt" : "2014-06-18T12:06:02.401+0000",
    "updatedAt" : "2014-06-18T12:06:02.401+0000"
  }

Response parameters

Parameter	Description	Data type
self	Address of the API resource with information about the link.	String
id	Link ID.	Number
type	Block with information about the link type.	Object
direction	Link type of the issue specified in the request in relation to the issue specified in the object field. Possible values: `outward`: The issue specified in the request is the main one for the issue in the object field. `inward`: The issue specified in the object field is the main one for the issue in the request.	String
object	Block with information about the linked issue.	Object
createdBy	Block with information about the user who created the link.	Object
updatedBy	Block with information about the user who edited the linked issue last.	Object
createdAt	Link creation date and time.	String
updatedAt	Link update date and time.	String
assignee	Assignee of the linked issue.	Object
status	Status of the linked issue.	Object

Object fields type

Parameter	Description	Data type
self	Link to the link type.	String
id	ID of the link type.	String
inward	Name of the link type of the issue specified in the object field in relation to the issue specified in the request.	String
outward	Name of the link type of the issue specified in the request in relation to the issue specified in the object field.	String

Object fields object

Parameter	Description	Data type
self	Address of the API resource with information about the issue.	String
id	Issue ID.	String
key	Issue key.	String
display	Issue name displayed.	String

Object fields createdBy

Parameter	Description	Data type
self	Address of the API resource with information about the user.	String
id	User ID.	String
display	User's name displayed.	String

Object fields updatedBy

Parameter	Description	Data type
self	Address of the API resource with information about the user.	String
id	User ID.	String
display	User's name displayed.	String

Object fields assignee

Parameter	Description	Data type
self	Address of the API resource with information about the user.	String
id	User ID.	String
display	User's name displayed.	String

Object fields status

Parameter	Description	Data type
self	Address of the API resource with information about the status.	String
id	Status ID.	String
key	Status key.	String
display	Status name displayed.	String

If the request is processed incorrectly, the API returns a response with an error code:

404: The requested object was not found. You may have specified an invalid object ID or key.

Link issues

Request format

Response format

Was the article helpful?