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.

Integrating AR System forms with a third-party application by using the REST API

The REST API is a simple stateless architecture that runs over HTTP. AR System uses JavaScript Object Notation (JSON) format to transmit data between a server and a web application. The advantage of REST is having a limited number of operations for the interactions between clients and services.

The API is a web service that conforms to the architectural principles of Representational State Transfer (REST). Each API is called by issuing a standard HTTP request method.

The client issues the following standard HTTP request method to call an API:

  • POST - Request to create new resources
  • GET - Request to retrieve details of individual resources
  • PUT - Request to modify a resource object
  • DELETE - Request to remove the resources that are not needed

These HTTP request methods are more commonly known as the CRUD operations: Create, Read, Update, and Delete.

The AR System uses Jetty as a web server to service the REST API requests. You should use Secure Sockets Layer (SSL) certificates with the Jetty server to service the REST API requests. 

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

Comments