Get remote issue links

Returns the remote issue links for an issue. When a remote issue link global ID is provided the record with that global ID is returned, otherwise all remote issue links are returned. Where a global ID includes reserved URL characters these must be escaped in the request. For example, pass system=http://www.mycompany.com/support&id=1 as system%3Dhttp%3A%2F%2Fwww.mycompany.com%2Fsupport%26id%3D1.

This operation requires issue linking to be active.

This operation can be accessed anonymously.

Permissions required:

Browse projects project permission for the project that the issue is in.

If issue-level security is configured, issue-level security permission to view the issue.

[ { "id": 10000, "self": "https://your-domain.atlassian.net/rest/api/issue/MKY-1/remotelink/10000", "globalId": "system=http://www.mycompany.com/support&id=1", "application": { "type": "com.acme.tracker", "name": "My Acme Tracker" }, "relationship": "causes", "object": { "url": "http://www.mycompany.com/support?id=1", "title": "TSTSUP-111", "summary": "Customer support issue", "icon": { "url16x16": "http://www.mycompany.com/support/ticket.png", "title": "Support Ticket" }, "status": { "resolved": true, "icon": { "url16x16": "http://www.mycompany.com/support/resolved.png", "title": "Case Closed", "link": "http://www.mycompany.com/support?id=1&details=closed" } } } }, { "id": 10001, "self": "https://your-domain.atlassian.net/rest/api/issue/MKY-1/remotelink/10001", "globalId": "system=http://www.anothercompany.com/tester&id=1234", "application": { "type": "com.acme.tester", "name": "My Acme Tester" }, "relationship": "is tested by", "object": { "url": "http://www.anothercompany.com/tester/testcase/1234", "title": "Test Case #1234", "summary": "Test that the submit button saves the item", "icon": { "url16x16": "http://www.anothercompany.com/tester/images/testcase.gif", "title": "Test Case" }, "status": { "resolved": false, "icon": { "url16x16": "http://www.anothercompany.com/tester/images/person/mia.gif", "title": "Tested by Mia Krystof", "link": "http://www.anothercompany.com/tester/person?accountId=5b10a2844c20165700ede21g" } } } } ]

Responses

🟢200Returned if the request is successful.

application/json

Body

Details of an issue remote link.

application

object

optional

Details of the remote application the linked item is in.

name

string

optional

The name of the application. Used in conjunction with the (remote) object icon title to display a tooltip for the link's icon. The tooltip takes the format "[application name] icon title". Blank items are excluded from the tooltip title. If both items are blank, the icon tooltop displays as "Web Link". Grouping and sorting of links may place links without an application name last.

type

string

optional

The name-spaced type of the application, used by registered rendering apps.

Additional properties

integer | number | string | boolean

optional

globalId

string

optional

The global ID of the link, such as the ID of the item on the remote system.

integer <int64>

optional

The ID of the link.

object

optional

Details of the item linked to.

icon

object

optional

Details of the icon for the item. If no icon is defined, the default link icon is used in Jira.

status

object

optional

The status of the item.

summary

string

optional

The summary details of the item.

title

string

required

The title of the item.

url

string

required

The URL of the item.

Additional properties

integer | number | string | boolean

optional

relationship

string

optional

Description of the relationship between the issue and the linked item.

self

string <uri>

optional

The URL of the link.

🟠400Returned if the request is invalid.

🟠401Returned if the authentication credentials are incorrect or missing.

🟠403Returned if issue linking is disabled.

🟠404Returned if the issue or remote issue link is not found or the user does not have permission to view the issue.

Get remote issue links

Request

Responses