Skip to end of banner
Go to start of banner

linkIssue

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Next »

Availability

This routine is available since katl-commons 1.1.2 .

Syntax

linkIssue(issueKey1, issueKey2_or_url, issueLinkTypeName_or_linkText)

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 link the issue to a web link.

Parameters:

Parameter name

Type

Required

Description

issueKey1

string

Yes

The key of the first issue to be linked

issueKey2_or_url

string

Yes

The key of the second issue to be linked or the URL

issueLinkTypeName_or_linkText

string

Yes

The issue link type name or the link text

Return type:

None. The returned value has no meaning.

Example:

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.cprime.io", "Confluence Documentation");

Result: "TST-123" issue is linked to URL "https://confluence.cprime.io" with link text "Confluence Documentation".

.

See Also:

  • No labels