This documentation supports the 20.02 version of BMC Helix Platform. 
To view an earlier version, select 19.11 from the Product version menu.

Integrating with REST services in a codeless way

Developers can connect applications to REST API services without writing code or using connectors, directly from the the BMC Helix Innovation Studio UI. For example, if you have an Integration Platform as a Service (iPaaS), you can define the REST communication between BMC Helix Platform and the integration middle ware, without having to write code or run an integration controller. Instead, you define a one-time configuration for each RESTful service that you want to connect to and create web requests for various HTTP methods such as GET, PUT, POST, or DELETE. 

Points to consider before connecting to RESTful service in a codeless way

Consider the following supported and unsupported technologies before connecting to RESTful service in a codeless way:

  • Supported authorization and authentication—Basic Auth, OAuth 2.0 (client credentials grant type), Remedy Single Sign-On (Remedy SSO), Remedy (Without RSSO), and Custom. 
  • Supported content types—JSON, Multipart 

  • REST web definitions—Once deployed as part of an application or library, administrators will not be able to modify these by using the Customization layer.

Scenario: Connecting to the JIRA REST API service

Your organization has a custom self-service application developed on BMC Helix Platform that employees use to create service requests, access knowledge articles, and so on. Your organization also uses Atlassian JIRA for project-tracking. As a developer of the self-service application, you want to connect the application to the JIRA REST service from the BMC Helix Innovation Studio UI so that you can get details about a JIRA issue in your application. To connect the JIRA REST service in a codeless way, you must perform the following tasks:

  • Create the JIRA REST service definition in BMC Helix Innovation Studio and create a web request to get the issue details from JIRA. 
  • Configure the authentication connection for the JIRA REST service and map the web request to the appropriate connection. 
  • To use the JIRA issue details in the self-service application, configure the Web Request element in the Process designer. 
  • After the process is triggered, end users can see the JIRA issue details.

The following video (8:43) shows how you can integrate with JIRA REST API service to extend BMC Helix Chatbot:

 https://youtu.be/n2X0YUTJ_68

 Process for connecting to a REST API service

The following images represents the tasks in the process of connecting to a REST service:

Note

After deploying an application in the production environment, you do not need to create the REST API service definition and configure the REST service web request in a process. Administrators can directly configure the authentication connection and map the REST API web request with the connection.

Before deploying an application in the production environment

After deploying an application in the production environment

The following table explains the tasks in the process of connecting to a REST service in a codeless way:

TaskActionReference
1Create a REST service definition along with web requests for the required methods such as GET, POST, PUT, and DELETE.Creating a REST API web service request definition
2Configure the authentication connection for the REST service definitions.Configuring the authentication credentials of REST API web services
3Configure the Web Request element in a process.Configuring web requests in a business process
4Map the REST API web request with the appropriate authentication connection.Mapping the REST API web service request alias to an appropriate connection

Related topic

Integrating with another application by using a connector


Was this page helpful? Yes No Submitting... Thank you

Comments