Remote Linking
Description
Starting with release 5.2, support has been added for remote linking. This page describes this support in more detail. Related improvement requests are
Links
Actions
addRemoteLink
removeRemoteLink
getRemoteLinkList
getApplicationLinkList
Links
Kind | Description | Example |
|---|---|---|
Local issue links | Standard JIRA issue linking is not supported as part of these remote link actions. Instead use linkIssue and related actions. | --action linkIssue --issue XXX-1 --toIssue XXX-2 --link Relates |
Web links | Simple url links. Multiple links with the same name can be made. | --action addRemoteLink --issue XXX-1 --url http://google.com --name google --link Search |
Remote issue links | Linking to an issue on another JIRA instance. When this is done through application links, JIRA automatically brings in additional information from the remote system like summary and status. When done without an application link, the link just becomes a web link. There can only be one remote link to the same JIRA server issue. Attempting to add another one with the same application link and issue will replace the existing link. Reverse links
JIRA 6.4 and higher Both source and target versions must be 6.4 or higher for remote issue linking. |
--action addRemoteLink --issue XXX-1 --toIssue SUPPORT-123 --targetServer "JIRA 7.1.0"
--link "Support issue"
--action addRemoteLink --issue XXX-1 --toIssue SUPPORT-123 --targetServer "JIRA 7.1.0"
--link "Support issue" --reverseLink "Development issue"
|
Confluence pages | Confluence page linking can be done by providing a url to a Confluence page that contains a pageId request parameter. It also requires a Confluence application link with a url that partially matches the url of the page being linked. Without an application link, it will just be a web link. If a pageId is not available, the UI will show a page loading error! A url with a pageId can be obtained in a number of ways:
Reverse links
| --action addRemoteLink --issue "XXX-1"
--url https://.../pages/viewinfo.action?pageId=135463166
|
Parameters
Parameter | Description | Use |
|---|---|---|
issue | Source issue key for the link located on the server identified by the server parameter | |
name | Name of the link. Also known as title in Atlassian documentation. |
|
link | Link description that defines what kind of link this is. Also known as relationship in the Atlassian documentation.
|
|
url | Target url of the web link. | |
toIssue | Target issue key of a JIRA remote issue link. | |
targetServer | Either an application link name or a url for an remote JIRA instance where the toIssue can be found. Needs to be distinct from server identified by the server parameter. |
|
targetUser | User id on the target server if different than the source server. | |
targetPassword | User password on the target server if different than the source server. | |
type | Application type either as an application link type like jira or confluence or an equivalent remote link application type like com.atlassian.jira or com.atlassian.confluence. |
|
