This documentation supports the 9.0 version of BMC Atrium Core.

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

REST API

Representational State Transfer (REST) API is a simple stateless architecture that is used to create scalable web services. RESTful APIs usually communicate over Hypertext Transfer Protocol (HTTP). The BMC Atrium Core 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 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 Atrium Core is
https://<localhost>:<port>
/api/cmdb/v1.

Any partial URLs, for example, /instance/{datasetId}/{namespace}/{className} referred to in this documentation are assumed to have this prefix.

An API is a web service that conforms to the architectural principles of 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 instances by issuing POST requests. The details of an individual instance or list of instances is retrieved using a GET request. The client issues PUT requests to modify an instance object. When an instance object is no longer needed, the client issues a DELETE request to remove an instance. 

The following topics provide details about the BMC Atrium Core REST API:

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

Comments

  1. Leonard Warren

    Very clear and understandable.  Thanks

    Jan 05, 2016 12:59
  2. Ben Weeks

    If we normally access BMC Remedy at the following URL:

    https://www.somedomain.com/arsys/shared/login.jsp

    (I understand we are using v9). From the above, I assume I should be able to access the URL at:

    https://www.somedomain.com/api/arsys/v9/

    However, this gives an Apache Tomcat/7.0.59 HTTP 404 error.

    Any ideas?

    Sep 06, 2016 06:23
    1. Vaijayanti Nerkar

      Devendra Yadav can you please help Ben. Thanks!  

      Sep 06, 2016 08:36
    1. Devendra Yadav

      Hi Ben Weeks

      You access https://www.somedomain.com/arsys/shared/login.jsp to get in to mid-tier while REST APIs has nothing to do with mid-tier they run in bundled jetty container on AR Server. To access REST API, URL is different.

      Thanks,

      Devendra

       

      Sep 08, 2016 12:30