...
Starting with release 5.2, support has been added for remote linking. This page describes this support in more detail. Related improvement requests are
and
.
Links
Actions
- addRemoteLink
- removeRemoteLink
- getRemoteLinkList
- getApplicationLinkList
Links
| Table plus |
|---|
| 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. |
| No Format |
|---|
--action linkIssue --issue XXX-1 --toIssue XXX-2 --link Relates |
|
|---|
| Web links | Simple url links. Multiple links with the same name can be made. |
| No Format |
|---|
--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- A reverse link will be established if there is an application link on the target server pointing back to the source server and the reverseLink parameter is specified. The reverseLink parameter specifies the link description of the reverse link. If blank, the link description is defaulted by JIRA.
| Tip |
|---|
| Both source and target versions must be 6.4 or higher for remote issue linking. |
| - JIRA 7.1.0 is the name of an application link
| No Format |
|---|
--action addRemoteLink --issue XXX-1 --toIssue SUPPORT-123 --targetServer "JIRA 7.1.0"
--link "Support issue" |
| No Format |
|---|
--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: - Using the CLI getPage action which has the pageId or you can use the URL it also provides
- The url when editing the page or copied from the Edit link
- The url for Attachments
- The url for Page Information
Reverse links- We are not able to support at this time. Watch .
|
| No Format |
|---|
--action addRemoteLink --issue "XXX-1"
--url https://.../pages/viewinfo.action?pageId=135463166 |
|
|---|
|
Parameters
| Table plus |
|---|
| 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. | - Used for referencing this remote link for later reference. Multiple links can have the same name.
- The name or link parameter on synonymous.
- The name of a web link appears in the second column on the UI.
- For other links, the name may be replaced by other information like JIRA issue key and summary.
|
|---|
| link | Link description that defines what kind of link this is. Also known as relationship in the Atlassian documentation. - Similar to the link name for standard issue linking - example: relates to.
| - The text that appears in the first column on the UI (on the left of the link).
|
|---|
| 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. | - Used to identify the target JIRA instance and verify the existence of the target issue.
|
|---|
| 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. | - CLI attempts to mask the inconsistent types used in application links and remote links.
|
|---|
|