REST Execution

To use the Execute REST Business Rule, the On-Premise Bridge Agent needs to be installed on a customer machine, and be configured to work.

Perform the following prerequisites:

• Configure the On-Premise Bridge Agent with a default endpoint. For more information, see How to use On-Premise Bridge agents on Windows or How to use On-Premise Bridge agents on Linux.

• Configure credentials using the Credentials Manager of the On-Premise Bridge Agent. These credentials are used for authentication in the remote server.

• Configure endpoints. An endpoint is defined with the remote service location: <Protocol>://<Host>:<Port>/<Service>. The endpoint uses the default credentials ID that was configured in the previous step for server authentication. For more information, see How to use endpoints.

After the On-Premise Bridge Agent is configured with endpoints and credentials, it is possible to configure and execute the Execute REST business rule.

The Execute REST business rule accepts the following parameters:

Click the Expression Language button to toggle between these options. When the button is selected (green), the field is in Expression Language mode. When it is not selected (white), the field is in Simple mode. For a full list of Expression Language functions, see Expression Language functions and syntax.

When selecting the output field, you should select a field of the type that matches the type of results to be returned by the REST call. The field types are defined for each field in the Fields tab.

You can define the output field for the business rule execution with the following types:

You can set the TaskPrefix value in the business rule, to be used in the result fields defined inside the complex type field. This value is not relevant for a textual type output field.

If the TaskPrefix is defined, it is added to the complex type field names as follows: fullName = taskPrefix+fieldname. The result values are then matched to a field named fullName. Similarly, when accessing a value from internal properties of the complex type field, this is done from the property named fullName.

This enables you to run multiple tasks with this business rule concurrently without overriding the other results, since the results are saved in different results fields inside the same complex type output field, according to the TaskPrefix value.

Using the example from above, for taskPrefix=Task1, the field in the complex type should be Task1Comments0ContentSubmitterUserId, in order to get the value of Comments0ContentSubmitterUserId after the execution of a task with the prefix Task1.

For multiple tasks, each task should have its own TaskPrefix value and result fields names (such as Task2 and Task2Comments0ContentSubmitterUserId).

You can use the Execute REST business rule to post issues (defects) via the JIRA service.

Follow these steps:

1. Create a demo JIRA account (go to https://www.atlassian.com/software/jira). Define the JIRA server URL: https://<demo>.atlassian.net.

2. In Integration Management, download and install the On-Premise Bridge agent and configure the agent to work with Service Management. Create credentials for the connection.

   On the Endpoints tab, define the endpoint and configure it as described in How to use endpoints. Select REST Executor 1.0 as the endpoint type.

3. In Service Management, define the following user options for an offering:

   • RawOutput. A string which contains the full JSON response. Required: false, Visibility: Agent

   • HttpStatusCode. An HTTP status response of type integer. Required: false, Visibility: Agent
   • Summary. A summary of the issue. Required: true, Visibility: User

   • Description. A description of the issue. Required: true, Visibility: User

   • Issuetype. The category of the issue. Required: false, Visibility: Agent

4. Define an automatic task for the offering, as described in How to build a task/approval plan.

5. Select the Execute REST business rule.

6. For the OPB Agent ID, OPB Endpoint ID and Credentials ID parameters, select the agent, endpoint, and credentials defined in step 2.

7. For the URI Suffix parameter, enter /rest/api/2/issue. For more information, consult the JIRA API documentation.
8. For the Web Method parameter, select POST.

9. For the Body parameter, you can either select Simple mode and enter a static JSON body, or select Expression Language mode and enter a dynamic JSON body.

   Static body example:

       {
       "fields": {
          "project":
          { 
             "key": "YOURDEFECTS"
          },
          "summary": "OPB REST Test 1 ",
          "description": " OPB REST Test 1 - description",
          "issuetype": {
             "name": "Bug"
          }
      }
   }
   

   Dynamic body example:

   ${concat('{"fields": {"project": {"key": "SAWDEFECTS"},"summary":"',	
   entity.UserOptions.Summary_c,'", "description": "',
   entity.UserOptions.Description_c,'","issuetype": {"name": "Bug"}}}')}
   							

   For more information, consult the JIRA API documentation.

10. For the Headers parameter, enter:

    Headers:
    "Accept", "application/json", 
    "Content-Type", "application/json"
    

11. For the Output field name parameter, select User Options.
12. Save the offering.
13. In Service Request Management, create a request based on the offering and run the automatic task.

14. Review the task output and check the user options fields.