JIRA Update

On this Page


Snap type:

Write


Description:

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

  • Expected upstream Snaps: Any Snap with a document output view
  • Expected downstream Snaps: Any Snap with a document input view
  • Expected input: Input document should contain JIRA issue ID and fields to update. The following example uses the Snap to insert a comment:


 {
        "id": "17000",
        "fields": {
        "comment": "this is an example of JIRA Update Snap to insert comment"
  }

  • Expected output:  Output document contains the response from the JIRA REST API service endpoint. An example of an output document is as following:


  {
        "headers": {
            "strict-transport-security": "max-age=315360000;includeSubdomains",
            "x-content-type-options": "nosniff",
            "x-seraph-loginreason": "OK",
            "connection": "keep-alive",
            "set-cookie": "atlassian.xsrf.token=BWCK-SR48-JN93-ESFC|9516f97dabdfcb95ea739defda6ffec0caa1ece7|lin; Path=/; Secure",
            "content-type": "application/json;charset=UTF-8",
            "date": "Mon, 08 Dec 2014 17:20:18 GMT",
            "x-arequestid": "560x115x1",
            "x-asen": "SEN-2848532",
            "content-length": "0",
            "x-asessionid": "1es5ykj",
            "cache-control": "no-cache, no-store, no-transform",
            "x-ausername": "admin",
            "server": "nginx"
        },
        "statusLine": {
            "reasonPhrase": "No Content",
            "statusCode": 204,
            "protoVersion": "HTTP/1.1"
        },
        "entity": "No Content",
        "original": {
            "id": "17000"
            "fields": {},
            "update": {
                "comment": [
                    {
                        "add": {
                            "body": "this is an example of JIRA Update Snap to insert comment"
                        }
                    }
                ]
            }
        }
    }


Prerequisites:

[None]


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


Views:
InputThis Snap has exactly one input view and receives documents in the view. Each document contains data to be updated at the JIRA REST API service endpoint. The Snap provides the schema on the input view.
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 document error view and produces zero or more documents in the view. Each document contains the response from the JIRA REST API service endpoint.

Settings

Label


Required. 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.


Examples



For a simple update to a JIRA item, you can use a simple Mapper + JIRA Update pipeline.

 
When the JIRA Update Snap has a valid account, the target schema is displayed in the Mapper Snap. 
Specify the ID of the JIRA issue by mapping a value to $id, then update the fields you need to. In the following screen, JIRA issue FULL-8 will update the Assignee in JIRA to the value of the pipeline parameter _assignee.
 

 
Use the JIRA Get fields API to determine what your custom fields are.


See Also

Snap Pack History

 Click to view/expand
ReleaseSnap Pack VersionDateTypeUpdates

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

snapsmrc486

 
StableUpgraded with the latest SnapLogic Platform release.
4.12

snapsmrc480

 
StableUpgraded with the latest SnapLogic Platform release.
4.11snapsmrc465
 
StableUpgraded with the latest SnapLogic Platform release.
4.10

snapsmrc414

 
StableUpgraded with the latest SnapLogic Platform release.
4.9snapsmrc405
 
StableUpgraded with the latest SnapLogic Platform release.
4.8

snapsmrc398

 
StableUpgraded with the latest SnapLogic Platform release.
4.7

snapsmrc382

 
StableUpgraded with the latest SnapLogic Platform release.
4.6snapsmrc362
 
StableUpgraded with the latest SnapLogic Platform release.
4.5.1

snapsmrc344

 
StableUpgraded with the latest SnapLogic Platform release.
4.5

snapsmrc344

Stable

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

4.4
 Stable

JIRA Search now has the Ignore empty result option.