General principles of the Infrastructure Management REST API

The architecture of Infrastructure Management varies according to your Infrastructure Management setup. This section describes the architecture of Infrastructure Management for the following scenarios:

• Single TrueSight Infrastructure Management Server installation
• Multiple TrueSight Infrastructure Management Server installations

 Single TrueSight Infrastructure Management Server installation

The following figure shows the architecture of a single TrueSight Infrastructure Management Server installation.

Infrastructure Management architecture for a single TrueSight Infrastructure Management Server installation



For information about how the REST API requests work, see Single BMC TrueSight Infrastructure Management Server.

 Multiple TrueSight Infrastructure Management Server installations

The following figure shows the architecture of multiple TrueSight Infrastructure Management Server installations.

Infrastructure Management architecture for multiple TrueSight Infrastructure Management Servers



For information about how the REST API requests work, see Multiple Child Servers with a Central Server Router.

REST-style architecture

Infrastructure Management conforms to REST (Representational State Transfer) principles. REST architecture uses the HTTP or HTTPS protocol to send requests and JSON standards to receive responses.

A REST-based REST API has three defined aspects:

• A base Uniform Resource Locator (URL)
• The Internet media type of the data supported by the REST API. For Infrastructure Management, the Internet media type is JSON.
• A set of calls (POST, GET, PUT, and DELETE) supported by a RESTful REST API

URL of a REST API

A REST-based REST API is accessed through a URL. The generic format of an Infrastructure Management REST API URL is as follows:

http|https://<serverHost>:<port>/bppmws/api/<resourceType>/<resourceID>/action?<queryParam1>&<queryParam2>&...<queryParamn>

For information about accessing a REST API, see Accessing Infrastructure Management.

JSON format

JSON is a text format that is completely language independent but uses conventions that are familiar to a programmer. Infrastructure Management provides responses in the JSON format.

For information about converting the input parameters to the JSON format, see JSON creator.

Set of calls supported by REST-based REST API

A REST-based REST API supports the following operations: