Availability
- This routine is available starting with SIL Engine™ 1.1.2.
- This routine is available for Jira server and cloud deployment options.
Syntax for server version
linkIssue(issueKey1, issueKey2_or_url, issueLinkTypeName_or_linkText)
Syntax for cloud version
linkissue(inwardIssueKey, outwardIssueKey, issueLinkTypeName [, comment, securityLevel])
Description
Links two issues by a specified link type name. First issue will have the outward description of the link type, the second issue will have the inward description of the link type.Starting with katl-commons 4.0.14 you can also link the issue to a web link.
Parameters
Parameter name | Type | Required | Description |
|---|---|---|---|
issueKey1 | string | Yes | Key of the first issue to be linked. |
issueKey2_or_url | string | Yes | Key of the second issue to be linked or the URL. |
issueLinkTypeName_or_linkText | string | Yes | Issue link type name or the link text. |
| comment | string | No | Comment that will be posted on the selected issue. |
| securityLevel | string | No | Security level of comment. |
Return type
None. The returned value has no meaning.
Examples for server version
Example 1
linkIssue(key, "TST-123", "Relates"); //key represents the key of current issue, "TST-123" the key of the issue it will be linked to.
Result: current issue is linked to issue "TST-123" by Relates link type, such that "TST-123" relates to current issue and vice versa.
Example 2
linkIssue("TST-123", "TST-234", "Blocks");
Result: "TST-123" issue is linked to issue "TST-234" by Blocks link type, such that "TST-123" blocks "TST-234" and "TST-234" is blocked by "TST-123".
Example 3
linkIssue("TST-123", "https://confluence.example.com", "Confluence Documentation");
As a result, the TST-123 issue will be linked to https://confluence.example.com with the "Confluence Documentation" link text.
Examples for cloud version
Example
/*same as server*/ linkIssue(key, "TEST-5", "Duplicate");
/*or like this, and the added comment will be public*/ linkIssue(key, "TEST-5", "Duplicate", "some text here")
//*or like this, and the added comment will be visible just for users with project role "Developers"*/ linkIssue(key, "TEST-5", "Duplicate", "some text here", "Developers")
See also