This resource represents remote issue links, a way of linking Jira to information in other systems. Use it to get, create, update, and delete remote issue links either by ID or global ID. The global ID provides a way of accessing remote issue links using information about the item's remote system host and remote system identifier.
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:
Connect app scope required: READ
read:jira-workread:issue.remote-link:jira, read:status:jirastring
Requiredstring
Returned if the request is successful.
Details of an issue remote link.
1
2
3
4
5
6
7
8
9
10
11
12
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
const response = await api.asUser().requestJira(route`/rest/api/2/issue/{issueIdOrKey}/remotelink`, {
headers: {
'Accept': 'application/json'
}
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
[
{
"application": {
"name": "My Acme Tracker",
"type": "com.acme.tracker"
},
"globalId": "system=http://www.mycompany.com/support&id=1",
"id": 10000,
"object": {
"icon": {
"title": "Support Ticket",
"url16x16": "http://www.mycompany.com/support/ticket.png"
},
"status": {
"icon": {
"link": "http://www.mycompany.com/support?id=1&details=closed",
"title": "Case Closed",
"url16x16": "http://www.mycompany.com/support/resolved.png"
},
"resolved": true
},
"summary": "Customer support issue",
"title": "TSTSUP-111",
"url": "http://www.mycompany.com/support?id=1"
},
"relationship": "causes",
"self": "https://your-domain.atlassian.net/rest/api/issue/MKY-1/remotelink/10000"
},
{
"application": {
"name": "My Acme Tester",
"type": "com.acme.tester"
},
"globalId": "system=http://www.anothercompany.com/tester&id=1234",
"id": 10001,
"object": {
"icon": {
"title": "Test Case",
"url16x16": "http://www.anothercompany.com/tester/images/testcase.gif"
},
"status": {
"icon": {
"link": "http://www.anothercompany.com/tester/person?accountId=5b10a2844c20165700ede21g",
"title": "Tested by Mia Krystof",
"url16x16": "http://www.anothercompany.com/tester/images/person/mia.gif"
},
"resolved": false
},
"summary": "Test that the submit button saves the item",
"title": "Test Case #1234",
"url": "http://www.anothercompany.com/tester/testcase/1234"
},
"relationship": "is tested by",
"self": "https://your-domain.atlassian.net/rest/api/issue/MKY-1/remotelink/10001"
}
]Creates or updates a remote issue link for an issue.
If a globalId is provided and a remote issue link with that global ID is found it is updated. Any fields without values in the request are set to null. Otherwise, the remote issue link is created.
This operation requires issue linking to be active.
This operation can be accessed anonymously.
Permissions required:
Connect app scope required: WRITE
write:jira-workwrite:issue:jira, write:issue.remote-link:jira, read:issue.remote-link:jirastring
RequiredApplication
string
RemoteObject
Requiredstring
any
Returned if the remote issue link is updated.
Details of the identifiers for a created or updated remote issue link.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
var bodyData = `{
"application": {
"name": "My Acme Tracker",
"type": "com.acme.tracker"
},
"globalId": "system=http://www.mycompany.com/support&id=1",
"object": {
"icon": {
"title": "Support Ticket",
"url16x16": "http://www.mycompany.com/support/ticket.png"
},
"status": {
"icon": {
"link": "http://www.mycompany.com/support?id=1&details=closed",
"title": "Case Closed",
"url16x16": "http://www.mycompany.com/support/resolved.png"
},
"resolved": true
},
"summary": "Customer support issue",
"title": "TSTSUP-111",
"url": "http://www.mycompany.com/support?id=1"
},
"relationship": "causes"
}`;
const response = await api.asUser().requestJira(route`/rest/api/2/issue/{issueIdOrKey}/remotelink`, {
method: 'POST',
headers: {
'Accept': 'application/json',
'Content-Type': 'application/json'
},
body: bodyData
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());1
2
3
4
{
"id": 10000,
"self": "https://your-domain.atlassian.net/rest/api/issue/MKY-1/remotelink/10000"
}Deletes the remote issue link from the issue using the link's global ID. Where the 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:
Connect app scope required: DELETE
write:jira-workdelete:issue.remote-link:jira, write:issue:jirastring
Requiredstring
RequiredReturned if the request is successful.
1
2
3
4
5
6
7
8
9
10
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
const response = await api.asUser().requestJira(route`/rest/api/2/issue/{issueIdOrKey}/remotelink?globalId=system%3Dhttp%3A%2F%2Fwww.mycompany.com%2Fsupport%26id%3D1`, {
method: 'DELETE'
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.text());Returns a remote issue link for an issue.
This operation requires issue linking to be active.
This operation can be accessed anonymously.
Permissions required:
Connect app scope required: READ
read:jira-workread:issue.remote-link:jira, read:status:jirastring
Requiredstring
RequiredReturned if the request is successful.
Details of an issue remote link.
1
2
3
4
5
6
7
8
9
10
11
12
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
const response = await api.asUser().requestJira(route`/rest/api/2/issue/{issueIdOrKey}/remotelink/{linkId}`, {
headers: {
'Accept': 'application/json'
}
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
{
"application": {
"name": "My Acme Tracker",
"type": "com.acme.tracker"
},
"globalId": "system=http://www.mycompany.com/support&id=1",
"id": 10000,
"object": {
"icon": {
"title": "Support Ticket",
"url16x16": "http://www.mycompany.com/support/ticket.png"
},
"status": {
"icon": {
"link": "http://www.mycompany.com/support?id=1&details=closed",
"title": "Case Closed",
"url16x16": "http://www.mycompany.com/support/resolved.png"
},
"resolved": true
},
"summary": "Customer support issue",
"title": "TSTSUP-111",
"url": "http://www.mycompany.com/support?id=1"
},
"relationship": "causes",
"self": "https://your-domain.atlassian.net/rest/api/issue/MKY-1/remotelink/10000"
}Updates a remote issue link for an issue.
Note: Fields without values in the request are set to null.
This operation requires issue linking to be active.
This operation can be accessed anonymously.
Permissions required:
Connect app scope required: WRITE
write:jira-workwrite:issue:jira, write:issue.remote-link:jirastring
Requiredstring
RequiredApplication
string
RemoteObject
Requiredstring
any
Returned if the request is successful.
any
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
var bodyData = `{
"application": {
"name": "My Acme Tracker",
"type": "com.acme.tracker"
},
"globalId": "system=http://www.mycompany.com/support&id=1",
"object": {
"icon": {
"title": "Support Ticket",
"url16x16": "http://www.mycompany.com/support/ticket.png"
},
"status": {
"icon": {
"link": "http://www.mycompany.com/support?id=1&details=closed",
"title": "Case Closed",
"url16x16": "http://www.mycompany.com/support/resolved.png"
},
"resolved": true
},
"summary": "Customer support issue",
"title": "TSTSUP-111",
"url": "http://www.mycompany.com/support?id=1"
},
"relationship": "causes"
}`;
const response = await api.asUser().requestJira(route`/rest/api/2/issue/{issueIdOrKey}/remotelink/{linkId}`, {
method: 'PUT',
headers: {
'Accept': 'application/json',
'Content-Type': 'application/json'
},
body: bodyData
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());Deletes a remote issue link from an issue.
This operation requires issue linking to be active.
This operation can be accessed anonymously.
Permissions required:
Connect app scope required: DELETE
write:jira-workdelete:issue.remote-link:jira, write:issue:jirastring
Requiredstring
RequiredReturned if the request is successful.
1
2
3
4
5
6
7
8
9
10
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
const response = await api.asUser().requestJira(route`/rest/api/2/issue/{issueIdOrKey}/remotelink/{linkId}`, {
method: 'DELETE'
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.text());Rate this page: