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

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

BMC Remedy AR System REST API overview

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.

Note

The BMC Remedy 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.

The REST API uses the base URI for the web service, such as 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.

Note

The root URL path for REST API in BMC Remedy AR System is
https://<localhost>:<port>
/api/arsys/v1. Any partial URLs, for example, /entry/{formName} referred to the documentation are assumed to have this prefix.

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. 

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 https://www.w3schools.com/html/html_urlencode.asp, 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

%27Incident+Number%27+%3D+%22INC000000000701%22

Additional Information

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

The following topics provide details about the BMC Remedy AR System REST API.

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

Comments