Page tree

The architecture of BMC ProactiveNet web services varies according to your BMC ProactiveNet setup. This section describes the architecture of BMC ProactiveNet web services for the following scenarios:

Single BMC ProactiveNet Server installation

The following figure shows the architecture of a single BMC ProactiveNet Server installation.

BMC ProactiveNet web services architecture for a single BMC ProactiveNet Server installation



For information about how the web service requests work, see Single BMC ProactiveNet Server.

Multiple BMC ProactiveNet Server installations

The following figure shows the architecture of multiple BMC ProactiveNet Server installations.

BMC ProactiveNet web services architecture for multiple BMC ProactiveNet Servers



For information about how the web service requests work, see Multiple BMC ProactiveNet Child Servers with a Central Server Router.

Single BMC ProactiveNet Server installation with Single Sign-On integration

The following figure shows the architecture of a single BMC ProactiveNet Server installation with Single Sign-On integration.

BMC ProactiveNet web services architecture for a single BMC ProactiveNet Server installation with Single Sign-On implementation



For information about how the web service requests work, see Single BMC ProactiveNet Server installation with BMC Atrium SSO integration, and for information about BMC Atrium SSO, see the BMC Atrium Single Sign-On Administrator's Guide.

Multiple BMC ProactiveNet Server installations with Single Sign-On integration

The following figure shows the architecture of multiple BMC ProactiveNet Server installations with Single Sign-On implementation.

BMC ProactiveNet web services architecture for multiple BMC ProactiveNet Servers with Single Sign-On implementation



For information about how the web service requests work, see Multiple BMC ProactiveNet Child Servers and a Central Server Router with BMC Atrium SSO integration, and for information about BMC Atrium SSO, see the BMC Atrium Single Sign-On Administrator's Guide.

REST-style architecture

BMC ProactiveNet web services conform 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 web service has three defined aspects:

  • A base Uniform Resource Locator (URL)
  • The Internet media type of the data supported by the web service. For BMC ProactiveNet web services, the Internet media type is JSON.
  • A set of calls (POST, GET, PUT, and DELETE) supported by a RESTful web service

URL of a web service

A REST-based web service is accessed through a URL. The generic format of a BMC ProactiveNet web service URL is as follows:

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


For information about accessing a web service, see Accessing BMC ProactiveNet web services.

JSON format

JSON is a text format that is completely language independent but uses conventions that are familiar to a programmer. BMC ProactiveNet web services provide 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 web services

A REST-based web service supports the following operations:

Operations

Description

POST

Adds a resource in a collection of resources and returns an identifier

GET

Retrieves information and gets the information about a resource

PUT

Updates or replaces a resource

DELETE

Removes a resource