This documentation supports the 19.02 version of Remedy Action Request System.

To view the latest version, select the version from the Product version menu.

Integrating AR System forms with a third-party application by using 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. BMC recommends to use Secure Sockets Layer (SSL) certificates with Jetty server to service the REST API requests. For more information, see Configuring the REST API.

REST API format

The REST API uses the base URI for the web service. For example,  https://<localhost>:<port>/api/{namespace}/{version} 

api - is the default prefix.

namespace - is used to help separate the different APIs.

version - is the version used for particular REST API.

The root URL path for REST API in BMC Remedy AR System is as follows:


Any partial URLs, for example, /entry/{formName} referred to the documentation are assumed to have this prefix.

Encoding for URL parameters

When using GET operation to fetch entries from a form via any REST client, URL parameters may be required. Examples of URL parameters are qualification (q), fields, limit and sort. While using any of these parameters with request URL, these must be encoded properly and then used in the request. Else results may not be as expected.

To encode URL parameters, use any third party tool or site such as, where non-encoded URL parameters can be converted into encoded URL parameter string. Use these encoded parameters to send a REST request.

For example, for sending qualification on a form:

 'Incident Number' = "INC000000000701"

It should be encoded and sent as


For more information on how BMC Remedy AR System integrates using REST APIs and web services watch the video on YouTube at

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


  1. Ankur Bindal


    Documentation does help with the information with respect to user access control.

    Is there any specific roles to be provided to user to restrict the data fetch from remedy using REST API Specifically.

    As per my observation, any user can extract any amount of data from incident even if user doesn't have the access from front end.

    Thanks, Ankur

    Feb 26, 2020 07:13
    1. Anagha Deshpande

      Hello Ankur,

      Thanks for your feedback on the documentation.

      We are working on your query. We will respond shortly.



      Feb 26, 2020 08:09
      1. Anagha Deshpande

        Hello Ankur,

        Remedy REST API works as a transport layer. The user access roles and permissions are handled by the AR System server.

        To better understand your issue, could you please provide the steps you are performing or the environment where you are facing this issue.



        Mar 02, 2020 02:44