Contact UsGet started
© 2024 Iron Hive LLC Belgrade

Adding an external link

Written by
Updated at February 19, 2024

Use this request to create a link for working with an external application object.

Request format

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

To create an external link, use an HTTP POST request.

POST /v2/issues/<issue_ID_or_key>/remotelinks?backlink=true
Host: https://api.tracker.yandex.net
Authorization: OAuth <OAuth_token>
X-Org-ID: <organization ID>

{
    "relationship": "RELATES",
    "key": "<object_key>",
    "origin": "<application_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-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_key_or_ID> ID or key of the current issue. String
Request parameters

Additional parameters

Parameter Description Data type
backlink Set true to execute a request from Tracker, when adding a link, to create a duplicate link in an external application. Logical
Request body parameters

Required parameters

Parameter Description Data type
relationship Link type. We recommend using the value RELATES. String
key Key of the external application object. String
origin ID of the application whose object you need to create a link to. String

Response format

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

The request body contains information about the created link in JSON format.

 {
     "self": "https://https://api.tracker.yandex.net/v2/issues/<issue_ID_or_key>/remotelinks/51******",
     "id": 51******,
     "type": {
         "self": "https://https://api.tracker.yandex.net/v2/linktypes/relates",
         "id": "relates",
         "inward": "Linked",
         "outward": "Linked"
     },
     "direction": "outward",
     "object": {
         "self": "https://https://api.tracker.yandex.net/v2/applications/ru.yandex.bitbucket/objects/13570010********",
         "id": "13570010********",
         "key": "TEST-17",
         "application": {
             "self": "https://https://api.tracker.yandex.net/v2/applications/25811000********",
             "id": "25811000********",
             "type": "app",
             "name": "test-app"
         }
     },
     "createdBy": {
         "self": "https://https://api.tracker.yandex.net/v2/users/11********",
         "id": "11********",
         "display": "display-user-name"
     },
     "updatedBy": {
         "self": "https://https://api.tracker.yandex.net/v2/users/11********",
         "id": "11********",
         "display": "display-user-name"
     },
     "createdAt": "2021-07-19T06:18:09.327+0000",
     "updatedAt": "2021-07-19T06:18:09.327+0000"
 }
Response parameters
Parameter Description Data type
self Address of the API resource with information about the external link. String
id Link ID. String
type Block with information about the link type. Object
direction Link direction. This parameter is relevant for non-symmetric link types, e.g., Parent issue: Sub-issue. Possible values:
  • outward: The issue specified in the request is the main one for the object.
  • inward: The object is the main one for the issue specified in the request.
 String
object Block with information about an external application object. Object
createdBy Block with information about the user who created the link. Object
updatedBy Block with information about the employee who updated the link last. Object
createdAt Link creation date and time. String
updatedAt Date and time when the link was last updated. String

type object fields

Parameter Description Data type
self Address of the API resource with information about the link type. String
id ID of the link type. String
inward Link type name depending on the direction. String
outward Link type name depending on the direction. String

object object fields

Parameter Description Data type
self Address of the API resource with information about the external application object. String
id Object ID. String
key Object key. String
application Block with information about the external application. Object

application object fields

Parameter Description Data type
self Address of the API resource with information about the external application. String
id Application ID. String
type Application type. String
name Application name displayed. String

createdBy object fields

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

updatedBy object fields

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

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.
401
The user isn't authorized. Make sure to perform the actions described in API access.
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.
Previous
Getting a list of issue external links
Next
Deleting an external link