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

Customizing an application with REST APIs

BMC Helix Platform 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/.

Each API is called by issuing a standard HTTP request method: 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: 


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.
Foundation Service REST APIsUsed to fetch the Foundation data and associations and feed the data to the consuming applications.

Related topics

Creating a custom service in Java

Creating a custom interface with REST

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