Mapping the REST API web service request alias to an appropriate connection

You can connect your application to the REST API web service of another application without using code or connectors. After configuring web requests in a business process, an alias is created for the web request. An alias is a placeholder for tenant-specific configurations. To make sure that the appropriate authentication credentials are used when a RESTful web service is invoked from the business process, administrators must map the alias with the appropriate web API connection.

For example, if you want to connect to a JIRA RESTful service, you must map the JIRA Web API alias with the JIRA connection. Administrators should have already configured the JIRA connection with authentication credentials.

Related topics

Expression-Editor

Process-designer-elements

Before you begin

To map the web request alias with an appropriate web API connection

  1. Log in to BMC Helix Innovation Studioand navigate to the Administration tab. 
  2. Select Integrations > Web APIs > Web API mapping, as shown in the following image:
    22_1_REST alias mapping.png

  3. From the Application list, select the application from which you want to connect to the REST API web service.

    Important

    If you have not created the REST API web request definition in any application, the list is blank.

    A list of web request aliases that you configured for the selected application is displayed as Connection target; for example, JIRA.

  4. In Connection configuration, select the appropriate authentication credentials for the web request alias. 
  5. Click Save. 

After you have completed all the tasks, when the process in which you have configured the web request is triggered, a connection is established between your application and the REST API web service.

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*