This documentation supports the 9.1 to 9.1 Service Pack 3 version and its patches of BMC Atrium Core. The documentation for version 9.1.04 and its patches is available here.

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