JIRA IssueLink

On this page

Snap type:

Write


Description:

This Snap provides the functionality to execute HTTP Post method to a JIRA REST API service endpoint to link JIRA issues.


For more information about the JIRA Issue Link API,  refer to the official JIRA Rest API document for the Link Issue Resource.


Prerequisites:

The user must have the link issue permission in JIRA.

Support and limitations:

Works in Ultra Task Pipelines.

Account: 

This Snap uses account references created on the Accounts page of SnapLogic Manager to handle access to this endpoint. The Snap supports the JIRA basic auth account. The JIRA sites may or may not allow anonymous access.


Views:
Input

This Snap has exactly one input view and receives documents in the view. Each document contains data needed to create a link between two issues at the JIRA REST API service endpoint. The Snap provides schema on the input view.
 

Example input:

[
    {
        "type": { "name": "Duplicates" },
        "inwardIssue": { "key": "JIRASNAP-1" },
        "outwardIssue": { "key": "JIRASNAP-2" },
        "comment": { "body": "Linked related issue!", "visibility": { "type": "role", "value": "Users" } } }
]

Note that the "visibility" part is optional. See the Examples section below for more information.

OutputThis Snap has at most one output view and produces documents in the view. Each document contains the response data from the JIRA REST API service endpoint.
ErrorThis Snap has at most one error view and produces zero or more documents in the view. Each document contains the response from the JIRA REST API service endpoint.

Label


The name for the Snap. You can modify this to be more specific, especially if you have more than one of the same Snap in your pipeline.

API version



The JIRA REST API version number.

Example: 2

Default value: 2


Snap Execution

Select one of the three modes in which the Snap executes. Available options are:

  • Validate & Execute: Performs limited execution of the Snap, and generates a data preview during Pipeline validation. Subsequently, performs full execution of the Snap (unlimited records) during Pipeline runtime.
  • Execute only: Performs full execution of the Snap during Pipeline execution without generating preview data.
  • Disabled: Disables the Snap and all Snaps that are downstream from it.




You will likely want to use a Mapper Snap before the JIRA IssueLink Snap to see the target schema being requested and to map the appropriate fields or parameters.

 

The following image shows the schema of the JIRA IssueLink Snap inside the Mapper Snap:

 

The following sections describe common values that you might use when linking issues.


Use the JIRA Get issue link type API for your list of link types.


TypeInward issue noteOutward issue note
Blocksis blocked byblocks
Clonersis cloned byclones
Duplicateis duplicated byduplicates
Problem/Incidentis caused bycauses
Relatesrelates to

relates to


The value for the comment body must be a string.


If not specified, comments are visible to anyone with access to the issue. When specified, visibility type is usually set to role or group. The value is then set to the string containing the name of the preferred object.


See Also

Snap Pack History

 Click to view/expand
ReleaseSnap Pack VersionDateTypeUpdates
August 2022main17386 StableUpgraded with the latest SnapLogic Platform release.
4.29main15993 StableUpgraded with the latest SnapLogic Platform release.
4.28main14627 StableUpgraded with the latest SnapLogic Platform release.

4.27

main12833

 

Stable

Upgraded with the latest SnapLogic Platform release.
4.26main11181 StableUpgraded with the latest SnapLogic Platform release.
4.25 Patch425patches10571 Latest

Enhanced the JIRA Snap Pack to support HTTP Proxy Authentication.

4.25main9554
 
Stable

Upgraded with the latest SnapLogic Platform release.

4.24main8556
StableUpgraded with the latest SnapLogic Platform release.
4.23main7430
 
StableUpgraded with the latest SnapLogic Platform release.
4.22main6403
 
StableUpgraded with the latest SnapLogic Platform release.
4.21snapsmrc542

 

StableUpgraded with the latest SnapLogic Platform release.
4.20snapsmrc535
 
StableUpgraded with the latest SnapLogic Platform release.
4.19snaprsmrc528
 
StableUpgraded with the latest SnapLogic Platform release.
4.18snapsmrc523
 
StableUpgraded with the latest SnapLogic Platform release.
4.17ALL7402
 
Latest

Pushed automatic rebuild of the latest version of each Snap Pack to SnapLogic UAT and Elastic servers.

4.17snapsmrc515
 
Latest

Added the Snap Execution field to all Standard-mode Snaps. In some Snaps, this field replaces the existing Execute during preview check box.

4.16snapsmrc508
 
StableUpgraded with the latest SnapLogic Platform release.
4.15snapsmrc500
 
StableUpgraded with the latest SnapLogic Platform release.
4.14snapsmrc490
 
StableUpgraded with the latest SnapLogic Platform release.
4.13
 
StableUpgraded with the latest SnapLogic Platform release.
4.12
 
StableUpgraded with the latest SnapLogic Platform release.
4.11snapsmrc465
 
StableUpgraded with the latest SnapLogic Platform release.
4.10
 
StableUpgraded with the latest SnapLogic Platform release.
4.9snapsmrc405
 
StableUpgraded with the latest SnapLogic Platform release.
4.8
 
StableUpgraded with the latest SnapLogic Platform release.
4.7
 
StableUpgraded with the latest SnapLogic Platform release.
4.6snapsmrc362
 
StableUpgraded with the latest SnapLogic Platform release.
4.5.1
 
StableUpgraded with the latest SnapLogic Platform release.
4.5Stable

Enhanced the error view output to include error, reason, and resolution.

4.4
 Stable

JIRA Search now has the Ignore empty result option.