Importing links

Written by

Yandex Cloud

Updated at February 19, 2024

Request format
Response format

Warning

This request can only be executed if the user has permission to edit the issue whose links are to be imported.

Use it to import to Tracker links to other issues.

Request format

To import links, use an HTTP POST request. Link parameters are passed in the request body in JSON format:

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

{
  "relationship": "relates",
  "issue": "TEST-2",
  "createdAt": "2017-08-29T12:34:41.740+0000",
  "createdBy": 11********,
  "updatedAt": "2017-09-07T11:24:31.140+0000",
  "updatedBy": 11********
}

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-ID header is used.
- If a Yandex Cloud Organization organization is the only one linked to Tracker, the X-Cloud-Org-ID header is used.
- If both Yandex 360 for Business and Yandex Cloud Organization organizations are linked to Tracker at the same time, the X-Org-ID header and the Yandex 360 for Business organization ID are used.

Resource

Parameter	Description	Data type
<issue_ID_or_key>	Key of the issue to attach the file to.	String

Request body parameters

Required parameters

Parameter	Description	Data type
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. `clone`: The linked issue is a clone of the current one. `original`: The current issue is a clone of the linked one.	String
issue	ID or key of the issue being linked.	String
createdAt	Link creation date and time. `YYYY-MM-DDThh:mm:ss.sss±hhmm` format. You can specify a value in the interval from the time of creation to the time the issue being linked was last updated.	String
createdBy	Username or ID of the user who created the link.	String for the username Number for the ID

Additional parameters

Parameter	Description	Data type
updatedAt	Date and time when the link was last updated. `YYYY-MM-DDThh:mm:ss.sss±hhmm` format. You can specify a value in the interval from the time of creation to the time the issues being linked were last updated. The parameter is only used together with the `updatedBy` parameter.	String
updatedBy	Username or ID of the user who edited the link last. The parameter is only used together with the `updatedAt` parameter.	String for the username Number for the ID

Response format

Request executed successfully

Request failed

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

The response body contains the parameters of the attached file in JSON format:

{
        "self": "https://https://api.tracker.yandex.net/v2/issues/JUNE-2/links/47*****",
        "id": 47*****,
        "type": {
            "self": "https://https://api.tracker.yandex.net/v2/linktypes/subtask",
            "id": "subtask",
            "inward": "Sub-issue",
            "outward": "Parent issue"
        },
        "direction": "outward",
        "object": {
            "self": "https://https://api.tracker.yandex.net/v2/issues/TREK-9844",
            "id": "593cd211ef7e8a33********",
            "key": "TREK-9844"
            "display": "subtask"
        },
        "createdBy": {
            "self": "https://https://api.tracker.yandex.net/v2/users/11********",
            "id": "11********",
            "display": "Ivan Ivanov"
        },
        "updatedBy": {
            "self": "https://https://api.tracker.yandex.net/v2/users/11********",
            "id": "11********",
            "display": "Ivan Ivanov"
        },
        "createdAt": "2017-06-11T05:16:01.421+0000",
        "updatedAt": "2017-06-11T05:16:01.421+0000",
        "assignee": {
            "self": "https://https://api.tracker.yandex.net/v2/users/11********",
            "id": "11********",
            "display": "Ivan Ivanov"
        },
        "status": {
            "self": "https://https://api.tracker.yandex.net/v2/statuses/1",
            "id": "1",
            "key": "open",
            "display": "Open"
        }
    }

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
sdirection	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

type object fields

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 object fields

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

createdBy object fields

Parameter	Description	Data type
self	Link to the user.	String
id	User ID.	String
display	Displayed user name.	String

updatedBy object fields

Parameter	Description	Data type
self	Link to the user.	String
id	User ID.	String
display	Displayed user name.	String

assignee object fields

Parameter	Description	Data type
self	Link to the user.	String
id	User ID.	String
display	Displayed user name.	String

status object fields

Parameter	Description	Data type
self	Status link.	String
id	Status ID.	String
key	Status key.	String
display	Status name displayed.	String

If the request is processed incorrectly, the API returns a message with error details:

400: One or more request parameters have an invalid value.

403: Insufficient rights to perform this action. You can check what rights you have in the Tracker interface. The same rights are required to perform an action via the API and interface.

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.

500: Internal service error. Try resending your request in a few minutes.

503: The API service is temporarily unavailable.

Importing links

Request formatRequest format

Response formatResponse format

Was the article helpful?

Request format

Response format