Page Comparison

verb

Indicates the HTTP verb such as GET (to get information), PUT (to update existing information), POST (to post or create a new item), DELETE (to delete an item).

The default is GET.

• {{ "/rest/api/2/issue/TEST-1" | callJira() | dump(2)}} dumps the information of the issue with key TEST-1

• {{ "/rest/api/2/issue/:issue" | callJira(verb = "GET", params={"issue":issue.key}) | dump(2)}} dumps the information of the current issue.

• {{ "/rest/api/2/issue/TEST-1" | callJira(verb=("PUT"), params={"issue":"TEST-1"}, body={"fields": {"summary": "New summary"} }) }} updates the summary of the issue with key TEST-1 to “New summary”

• See the examples section for an example on the POST verb

• {{ "/rest/api/2/issue/TEST-1" | callJira( verb=("DELETE"), params={"issue":"TEST-1"} ) }} deletes the issue with key TEST-1

params

Indicates the parameters to be passed to replace placeholders in the rest-url. It is a hash of key and values. Any instance of ":key" in the rest-url is replaced with its value found in the hash under "key". The value will be Uri-Encoded.

The default is no param

• {{"rest/api/2/customFieldOption/:id" | callJira(verb = "GET", params={"id":"10000"}) | dump(2)}} replaces :id with 10000 and dumps the custom field option

• {{"/rest/api/2/priority/:id" | callJira(verb = "GET", params={"id":linkedIssue.fields.priority.id}) | dump(2)}} replaces :id with the id of the linked issues' priority and dumps the priority object in a pretty JSON format

query

Indicates the query string to be appended to the url. It is a hash of key and values. The values must be scalar and will be encoded appropriately. This is used to return a subset of fields.

The default is no query param.

• {{ "/rest/api/2/issue/TEST-1" | callJira(query={"fields":"reporter"}) | dump(2) }} will call /rest/api/2/issue/TEST-1?fields=reporter and dump the issue whose key is TEST-1 with its Reporter information.

• {{ "/rest/api/2/issue/:issue" | callJira(params={"issue":linkedIssue.key}, query={"fields":"subtasks"}) | dump(2) }} dumps the linked issue with its subtasks in a pretty JSON format.

body

Indicates the body to pass to PUT and POST calls. It is an object that will be automatically converted to JSON.

The default is no body.

• {{ "/rest/api/2/issue/:issue" | callJira(verb=("put"), params={"issue":linkedIssue.key}, body={"fields": {"summary": "Updated Summary"} }) }} updates the Summary of the current issue to Updated Summary

• {{ "/rest/api/2/issue/:issue" | callJira(verb=("put"), params={"issue":parentIssue.key}, body={"fields": {"versions": issue.fields.versions | first | field("name"} }) }} updates the Affects Version/s of the parent issue to the first Affects Version/s of the current issue.

• For examples using POST call and PUT verb see here.

impersonate

Indicates the impersonation to be applied to the call. It is either true to impersonate the current user, or an accountId to impersonate that user.

The default is no impersonation and acts as the add-on user.

• {{ "/rest/api/2/issue/:issue" | callJira(verb=("put"), params={"issue":parentIssue.key}, body={"fields": {"summary": "Hello" } }, impersonate=("accountId:5d94aa5a4af8460dd557a40a" ) ) }} updates the Summary of the parent issue to “Hello” as the user with the specified accountID.

dontFail

If true, when the REST call to Jira returns an error, instead of throwing an exception, the error will be returned as an object containing an _error and/or a _statusCode field.

• {{ "/rest/api/2/issue/:issue" | callJira(verb=("put"), params={issue:issue.key}, body={fields:{components: [{name:"Server"}]} }, dontFail=true) | dump(2)}} updates the Component/s of the issue to “Server”, and if the “Server” component doesn’t exist, returns:
  

  Code Block
  { "_error": { "code": 400, "detail": { "errorMessages": [], "errors": { "components": "Component name 'Server' is not valid" } } } }