This documentation supports the 21.3 version of Action Request System.

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 the HTTP. The  AR System server 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: POST, GET, PUT, or DELETE (more commonly known as the CRUD operations: Create, Read, Update, and Delete).

The client creates new entries by issuing POST requests. The details of an individual entry or list of entries is retrieved using a GET request. The client issues PUT requests to modify an entry object. When an entry object is no longer needed, the client issues a DELETE request to remove the entry. 

The AR System server  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. For more information, see 2024-04-18_02-16-06_Configuring the REST API by using SSL certificates.

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