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.
The following topics provide details about the BMC Remedy AR System REST API.
Comments
Where are the details of the CMDB REST Operations?
Hello Brock,
The CMDB REST operations are documented in the BMC Atrium Core 9.0 space. The link to the topic is REST API.
Thanks,
Prachi
Prachi, thanks for adding the link. That is most helpful.
REST API on URL http://ARSERVER/api/arsys/v1/entry/FORMNAME
Should always return DATABASE field names,
For example Getting an Entry on AR System User Preference form should return this
"values": {
"Request ID": "000000000000001",
"Submitter": "Demo",
"Submitter" is the database field name
If you have overlaid a form and you are getting Field Labels instead of Field Names, you are facing a defect
Upgrading to latest AR server and Hotfix is recommended
Does BMC Remedy expose REST API by default? or Do we need to configure it in Admin console within Remedy? Where can we find that this is already exposed?
Is this API work for ITSM application?
Also i am looking for REST API which create, edit and change the status of record in ITSM application using REST API.
Can you please assist on this