Yandex Cloud
  • Services
  • Solutions
  • Why Yandex Cloud
  • Blog
  • Pricing
  • Documentation
  • Contact us
Get started
Language / Region
Yandex project
© 2023 Yandex.Cloud LLC
Yandex Tracker
  • Getting started
    • Activating Yandex Tracker
    • Logging in to Yandex Tracker
    • Adding users
    • Configuring access to Yandex Tracker
    • Setting up Yandex Tracker
    • Working with Yandex Tracker
      • Start page
      • My issues
      • Working with issues
      • Favorite issues, boards, and dashboards
      • Personal settings
    • Migrating to Yandex Tracker
    • Disabling paid services
  • Yandex Tracker mobile app
  • Tutorials
    • Setting up Yandex Tracker for a development team
      • Overview
      • Creating a queue for a development team
      • Structuring issues
      • Using Agile methodologies
      • Configuring issue templates
      • Connecting repositories
      • Automating recurring actions
      • Integrating Yandex Tracker with other platforms
    • Setting up Yandex Tracker for a support team
      • Overview
      • Creating a queue for the support team
      • Accepting requests by mail and via forms
      • Configuring multi-tiered support
      • Sending emails from the issue page
      • Grouping requests by topic
      • Tracking the time it takes to process a request
      • Collecting request statistics
      • Configuring integration with third-party platforms
  • Concepts
    • Service overview
    • Concepts
    • Roles and access rights
  • Configuring queues
    • Overview
    • Create a queue
    • Queue templates
    • Viewing issues in a queue
    • Changing basic queue settings
    • Changing basic queue settings
      • Overview
      • Configuring issue types
      • Creating a workflow
      • Setting up statuses
      • Configuring transitions
      • Setting up resolutions
    • Local issue fields
    • Adding a queue team
    • Setting access rights for queues
    • Advanced queue features
    • Viewing the history of queue changes
    • Delete a queue
  • Working with issues
    • Create an issue
      • Overview
      • Creating an issue via email
      • Creating an issue from a form
      • Cloning an issue
    • Edit an issue
      • Overview
      • Adding comments to issues
      • Creating a checklist
      • Editing issue links
      • Attaching images and files to an issue
      • Formatting text in issues
      • Voting for an issue
      • Move an issue to another queue
      • Changing multiple issues
    • Setting up an issue reminder
    • Registering time spent
    • Adding issue fields
    • Viewing the history of issue changes
    • Getting access to an issue
    • Deleting an issue
  • Structuring issues
    • Overview
    • Links between issues
    • Projects
      • Overview
      • Create a project
      • List of project issues
      • Gantt chart
    • Components
    • Versions
  • Agile development tools
    • Overview
    • Create a board
    • Working with an agile board
    • Editing or deleting a board
    • Backlog
    • Sprints
    • Epics
    • Collaborative workload estimation
    • Burn down charts
  • Issue boards (beta)
    • Overview
    • Create a board
    • Working with an agile board
    • Setting up a board
  • Find issues
    • Finding issues by key or name
    • Finding my issues
    • Finding issues in queues
    • Creating an issue filter
    • Query language
  • Notifications and subscriptions
    • Overview
    • Subscribing to notifications
    • Receiving update reports
    • Subscribing other users to queue updates
    • Email notification settings
      • Overview
      • Notifications about your issues
      • Notifications about your subscriptions
    • Sending notifications to mailboxes in your domain
  • Statistics and dashboards
    • Dashboards
      • Overview
      • Creating a dashboard
      • Widgets
      • Editing a dashboard
      • Shared access to dashboards
      • Making a dashboard your start page
    • Queue statistics
    • Gantt chart
  • Automation and templates
    • Overview
    • Triggers
      • Overview
      • Creating triggers
      • Setting trigger conditions
      • Configuring trigger actions
      • Editing and deleting triggers
      • Examples
    • Auto actions
      • Overview
      • Automatic issue updates
      • Scheduled issue creation
      • Editing or deleting auto actions
    • Macros
    • Templates
      • Overview
      • Creating a template in Yandex Forms (beta)
      • Creating a template
      • Editing a template
      • Deleting a template
      • Using shared templates
    • Variables
    • Using a form as a template for creating issues
  • Configuring an SLA for issues
    • Overview
    • Configuring rules
    • Work schedule
  • Integration with other services
    • Email
    • Yandex Forms
    • Yandex Wiki
    • Messengers
      • Overview
      • Slack
      • Telegram
    • Setting up links to external applications
      • Overview
      • Setting up an external application
      • Sending your application data to the Tracker team
  • Developer tools
    • API
    • Python client
    • Connecting repositories
  • Pricing policy
    • Billing
    • Setting up a billing account
    • Paying for services
    • Viewing service usage details
  • API reference
    • Overview
    • API access
    • General query format
    • Issues
      • Get issue parameters
      • Edit an issue
      • Create an issue
      • Moving an issue to another queue
      • Find out the number of issues
      • Search for issues
      • Release scroll view resources
      • Get priorities
      • Get transitions
      • Make a status transition
      • Get the history of issue changes
      • Issue links
        • Link issues
        • Get issue links
        • Remove issue links
    • Checklists
      • Create a checklist or add items to it
      • Get checklist parameters
      • Edit a checklist
      • Delete a checklist
    • Projects
      • Create a project
      • Get project parameters
      • Get a list of all projects
      • Get a list of project queues
      • Edit a project
      • Delete a project
    • Comments
      • Add comment
      • Get issue comments
      • Edit a comment
      • Delete a comment
    • Macros
      • Get queue macros
      • Get a macro
      • Create a macro
      • Edit a macro
      • Delete a macro
    • External links
      • Get a list of external applications
      • Get a list of issue external links
      • Add an external link
      • Delete an external link
    • Attached files
      • Get a list of attached files
      • Download a file
      • Download a thumbnail
      • Attach a file
      • Upload a temporary file
      • Delete a file
    • Queues
      • Create a queue
      • Get queue parameters
      • Get a list of queues
      • Get queue versions
      • Get required fields for the queue
      • Delete a queue
      • Restore a queue
      • Remove a tag from a queue
      • Automation
        • Auto actions
          • Create an auto action
          • Get auto action parameters
        • Triggers
          • Creating a trigger
          • Get trigger parameters
    • Issue boards
      • Get parameters of all boards
      • Get board parameters
      • Create a board
      • Edit a board
      • Delete a board
      • Columns
        • Get parameters of all columns
        • Get column parameters
        • Create a column
        • Edit a column
        • Delete a column
      • Sprints
        • Get all sprints of a board
        • Get a sprint
        • Create a sprint
    • Components
      • Get a list of components
    • Import
      • Import an issue
      • Import files
      • Import comments
      • Import links
    • Bulk operations
      • Perform a bulk move of issues to a different queue
      • Bulk changes to issues
      • Make bulk changes to issue statuses
    • Time tracking
      • Add a record of time spent
      • Edit a record of time spent
      • Delete a record of time spent
      • Get records of time spent
        • Get all records for an issue
        • Select records by parameters
    • Issue fields
      • Get global issue fields
      • Create an issue field
      • Get issue field parameters
      • Edit issue field names
      • Edit possible values of issue fields
      • Create an issue field category
      • Local fields
        • Create a local queue field
        • Get local queue fields
        • Get information about a local queue field
        • Edit a local queue field
    • Get information about the current user
    • Possible response codes
  • Questions and answers
    • General questions
    • Billing
  • Revision history
    • November 2022
    • October 2022
    • September 2022
    • August 2022
  • Support
  1. API reference
  2. External links
  3. Add an external link

Add an external link

Written by
Yandex Cloud
  • Request format
  • Response format

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

    API host address:

    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 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. Boolean
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

Request executed successfully
Request failed

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://api.tracker.yandex.net/v2/issues/<issue-id>/remotelinks/51455195", 
     "id": 51455195,
     "type": {
         "self": "https://api.tracker.yandex.net/v2/linktypes/relates",
         "id": "relates",
         "inward": "Linked",
         "outward": "Linked"
     },
     "direction": "outward",
     "object": {
         "self": "https://api.tracker.yandex.net/v2/applications/ru.yandex.bitbucket/objects/<object-id>",
         "id": "<object-id>",
         "key": "<object-key>",
         "application": {
             "self": "https://api.tracker.yandex.net/v2/applications/<application-id>",
             "id": "<application-id>",
             "type": "<application-type>",
             "name": "<application-name>"
         }
     },
     "createdBy": {
         "self": "https://api.tracker.yandex.net/v2/users/1120000000232694",
         "id": "user-name",
         "display": "display-user-name"
     },
     "updatedBy": {
         "self": "https://api.tracker.yandex.net/v2/users/1120000000232694",
         "id": "user-name",
         "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. The parameter is relevant for non-symmetric link types, such as 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

Object fields type

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

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

Object fields application

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

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

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.

Was the article helpful?

Language / Region
Yandex project
© 2023 Yandex.Cloud LLC
In this article:
  • Request format
  • Response format