Page tree
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 9 Next »

 

Using this post function, you can call any REST service of your internal/external systems that you want to integrate with JIRA. Just analyse the right transition in your workflow and configure REST service parameters.

If the system (external system) is down at the moment of calling REST service, plugin automatically stores it and re-tries to execute it periodically with a scheduled task.

To add REST Service Caller Post Function, go to the transition of your workflow, switch to Post Functions tab and click on Add post function link. Then locate "REST Service Caller" post function and click Add button.

Then configure REST service parameters

  • URL: The endpoint of the REST service. You can type any dynamic parameter here using double curly braces. (e.g. http://mycompany.com/api/book/{{bookId}} assuming bookId is defined in Parameters section which is described below)
  • Method: Select Http Method (GET, POST, PUT, DELETE)
  • Headers: Define your HTTP header key/value sets in separate lines as described in screen-shot
  • Request Body: Type json request body. You can use dynamic parameters here as well
  • Parameters: Define all your dynamic parameters here. You can add static values as well as the dynamic values of fields/custom fields in JIRA issue. Here are some sample usages:

    assignee    = $issue.assignee or {{issue.assignee}}
    reporter    = {{issue.reporter}}
    date        = $issue.created
    productName = $issue.getCustomFieldValue($customFieldManager.getCustomFieldObject('customfield_11100'))
    price       = $issue.getCustomFieldValue($customFieldManager.getCustomFieldObject('customfield_11102'))
    displayName = $user.displayName
    comment		= $comment // this is the comment that is passed throught the transition

    Please see User and Issue API for all properties and methods.

  • Authorization Type: Choose authorization type. Currently BASIC Authentication is supported.
  • Credential: If you choose any Authorization Type, this option becomes active, and the credentials you defined in Credentials section are listed.

Once, you click on OK button, it saves all configuration.

Updating a customfield with a value in REST result

There is also a section if you want to update a custom field with a value in REST response. 

  • First click on Update custom field checkbox
  • Custom field drop down is displayed, select the one you want to update
  • Type jsonpath accordingly to select the value. If the result is not json and you want to update custom field with the body itself, just leave this textbox empty.

See jsonpath examples page for jsonpath samples.

 

Please do not forget to publish workflow to see it in action.

 

  • No labels