This documentation supports the 23.3 version of BMC Helix Innovation Suite (AR System and BMC Helix Innovation Studio).

To view an earlier version, select the version from the Product version menu.

Customizing an application with REST APIs

BMC Helix Innovation Studio provides a few services that contain REST APIs.  These REST APIs communicate with your custom bundle deployed in the server. The REST API uses the base URL for the web service, such as https://<host>:<port>/api/.

The client issues the following standard HTTP request method to call an API: POST, GET, PUT, or DELETE (More commonly known as the CRUD operations: Create, Read, Update, and Delete).

List of REST APIs available for communicating with the server

You can use the following REST APIs to communicate with the custom bundle deployed in the server: 

APIUsage

RecordInstanceDataPageQuery REST API

Used to retrieve record instances.
EventMetricsDataPageQuery REST APIUsed to retrieve Chatbot user feedback report.
Approval REST APIsUsed to access approvals directly in your application code, such as get approval request details or update an approval request.


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

Comments