The Web service node helps you integrate Jira Service Management with Koji. It sends a request to a web service, obtains, and parses the returned result. This page describes how to use this node.

Jira Cloud Platform APIs

The REST APIs help developers integrate Jira Service Management with Koji. To learn more about JSM REST APIs functionality and view the references, visit the Atlassian Developer REST API portal.

Node prerequisites

Before using JSM APIs in your workflow, you must obtain the Session Auth Token, which is required for proper APIs performance. To do so:

1. In your workflow, create a Call function node.

2. In the Function name field, specify the wf.itsm.ticket.get_authorization_header function. It returns Session Auth Token.

3. Save the result in a variable. For example, it can be user_token.

4. Add the Authorization = user_token pair in the Web service node's header part.

Now you can start using JSM APIs in your workflows.

Web service node usage

Use the Web service node to send a request to a web service, obtain, and parse the returned result. Fill in the fields:

• URI: specify the URL of Web Service that Kbot shall use.

• Method: select the required method from the drop-down list: POST, GET, PUT, or DELETE.

• Headers, Parameters, Body data: these fields are for the input data of the request. These parameters are sent to the service. Specify this data in accordance with the documentation of the API that you are using.

• Patterns: save your request’s JSON results. You can save a result to the internal variable for the following usage in the Workflow. The patterns' data is stored as the argument name - argument value pairs.

Sample

Let’s create a workflow that returns a status for a given request. For such a workflow we are going to use the Get customer request by id or key method. It is used to return a given’s request status by ID or key. Our workflow will consists of multiple nodes described below.

1. Go to Content > Workflows.

2. Click Create and name your workflow.

3. In the workflow details view, click Edit workflow.

4. Create a Call function node for obtaining the authorization details. In the Function name field, specify the wf.itsm.ticket.get_authorization_header function, which returns Session Auth Token. Save the result in a variable. For example, it can be user_token.

5.

It returns the request status by ID or key.

We are creating a workflow that:

1. Obtaining the authorization using call function (above)

2. Asking user the request key

3. Getting ready the pass (as it is described in Atlassian documentation)

4. Everything is ready for Web service node

5. Path is in URI field

6. In headers / auth we add auth that we got after call function

7. to get ticket status in patterns fields we are adding an variable for storing ticket status. the value of this variable corresponds to the path in response json object

$.currentStatus.status

testing

#workflow workflowname