Configuring an Open API Connector to Invoke a REST Service (Release 9.2.3.4)

You can configure an Open API connector to invoke a REST service. In the Open API connector, when you specify the API call and set the HTTP method that is populated as per the allowed API call, the Pathing and Parameter fields are automatically filled with values as required for the REST service.

You can test the connector and view the JSON response body of the REST service. You can also use Groovy scripting to refine the data in the connector output.

To configure an Open API connector to invoke a REST service:

1. Create and name the connector service request as described in Creating a Service Request.

2. On the Connector design page, click the Connection field and select a connection under the OPEN_ API category.

   The URL to the REST service for the Open API connection is displayed.

3. Click the API drop-down list and select the API from the list of all the available APIs as defined in the Open API documentation. The HTTP methods will be populated as applicable to the selected API call.

4. Click the HTTP Method drop-down list and select the method as required.

   After you select the HTTP Method value, if available in the documentation, the corresponding values for the selected API are displayed in the API Description and API Summary fields. Also, the Pathing and Parameters sections are automatically filled with the appropriate values.

5. Slide the Fire and Forget toggle to the right if you want the orchestration to execute without waiting for a response. If Fire and Forget is enabled, the Output section is hidden because the REST service response is not processed.

6. In the Output section, use the following sections to identify the outputs:

   Note: The outputs are based on the JSON response of the REST service call. You can see the response after running a successful test of the REST service using the Test button.

   • Manipulate Output (advanced). Use Groovy scripting to modify the output of the REST call. For example, if you only need certain data in the output, you can use Groovy scripting to refine the data that is displayed in the output. See Groovy Template for Manipulating Output from a REST Connector Response for more information.

   • Output grid. If the value you want is nested in JSON objects, you can get to the value by separating each JSON object name by a period (.). If the value you want is in an array, you can access it by adding the proper index of the array inside brackets ([]).

7. To test the connector:

   1. Click the Test button.

   2. If the connector includes parameters, enter values for the parameters in the pop-up box.

      Clicking Execute displays the REST service response.

   3. Click the Show Output button that is displayed at the end of the response to view the modified output.

Note: The Pathing, Parameter, Header, and Body sections are prefilled with optional values. You can remove the optional values per your requirement and save the connector.