Page tree
Skip to end of metadata
Go to start of metadata

The generic format of a URL is as follows:

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

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

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

http://bppmwsserver:80/bppmws/api/Device/192.168.123.46/stats?
starttime=2011-05-19T10:00:00&endtime=2011-05-19T12:00:00&
idType=IPAddress&statstype=raw&attributetype=kpi

Example

http://bppmwsserver:80/bppmws/api/Device/192.168.123.46/stats?
starttime=2011-05-19T10
:00:00&endtime=2011-05-19T12:00:00&
idType=IPAddress&statstype=raw&attributetype=kpi

List of attributes and query parameters for BMC ProactiveNet web services that retrieve data

Entry

Description

http|https

Type of protocol to send the request. BMC ProactiveNet web services support both HTTP and HTTPS protocols.

serverHost

Host name of the BMC ProactiveNet Server

port

Port number through which communication is established. The default port number is 80 if you use the HTTP protocol and 443 if you use the HTTPS protocol.

resourceType

Type of resource that you want the web service to interact with. The available resource types are as follows:

  • Device
  • MonitorInstance
  • CI

Each URL can have only one resource type.

resourceID

Identifier of a specific resource that you want the web service to interact with. BMC ProactiveNet web services support the following resource identifiers:

  • Name of the resource
  • IP address of the resource (only for Device and MonitorInstance)
  • Uniform Resource Identifier of the resource
  • Unique identifier of a CI
  • Token identifier of a CI

Example:
In this example, the resource identifier used is its name.
Each web service supports specific resource identifiers, and the supported identifiers vary for each web service. When you use multiple resource identifiers, separate them with commas.

action

Name of the API that you want to call. The available APIs are as follows:

  • metadata
  • configdata
  • stats

queryParam1, queryParam2, queryParamn

Additional parameters that you want to provide in the request

Available query parameters (optional)

starttime and endtime

Time period for which you want to retrieve the data. The format is YYYY-MM-DDTHH:MM:SS Coordinated Universal Time (UTC) in 24-hr format. If no date is provided, by default, data is retrieved for the latest time during which it is available.

This parameter is applicable only for stats API.

Example:
starttime=2010-08-08T10:10:55&endtime=2010-08-09T10:10:55

The endtime value cannot be greater than 31 days from the starttime value.

idType

Type of identifier that the resourceID parameter used. The available identifier types are as follows:

  • Name
  • IPAddress
  • URI
  • RECON_ID/CI_ID

By default, URI is used as the identifier.

Example:
where, bppmwsserver.com is the resource identifier, which is the name of the resource, and idType=Name indicates that the resource identifier used is the name of the resource.

monitor=monitortype:attribute

Name of the monitor type and the corresponding attributes for which you want to retrieve data. This parameter is mandatory if resourceType is Device or CI for a stats request. It is optional if resourceType is MonitorInstance. If this parameter is not provided, Key Performance Indicators (KPIs) are retrieved.

Example:
monitor=CPU:CPU_UTILIZATION;Memory:UTILIZATION

page

Page number of the paginated data from which you want to retrieve the data. When your request generates a huge volume of data, the response data is paginated with page numbers. This parameter helps to retrieve data from any particular page by using the page number. This parameter is applicable only for stats API.

Example:
page=2

In this example, the data from page number 2 is retrieved. By default, the pagination feature is not enabled. You must enable this feature to use it. To enable the pagination feature, using a text editor, open the pw\pronto\conf\bppmws.properties file, and enable the paginate property as follows, and save the file:

paginate=true

subtype

Name of the subtype of the specified resource. The available subtype is cluster. By default, no subtype is assumed. Specify this property only when you use a cluster environment. This parameter is applicable only when you specify the resourceType parameter as Device.

Example:
subtype=cluster

infotype

Specifies whether you want to retrieve the data of an actual specified resource in a cluster environment. The available infotype is individual. This parameter is applicable only when you specify the resourceType as Device.

Example:
infotype=individual By default, the default value for the infotype parameter is individual. For this parameter to be effective, you must have a cluster environment, and the subtype parameter must be set to cluster.

statstype

Type of performance statistics data that you want to retrieve. This data can be of two types:

  • Raw — Actual values during a given time period
  • Aggregate — Processed values over a given time period. Generally, it is an hour's worth of data.

If statstype is not specified, by default, the data retrieved is raw data.

This parameter is applicable only for stats API.

Example:
statstype=raw

attributetype

Type of attribute that you want to retrieve. Attributes can be of two types:

  • kpi — KPIs
  • all — All the attribute types

If the attributetype parameter is not specified, by default, KPI data is retrieved.

Example:
attributetype=kpi

tenantName

Name of the tenant for which you want to fetch data

Example:
tenantName=calbro

Note

Query parameters are case sensitive. If there is any mismatch in the format of the query parameter, the corresponding parameter is ignored, and the web service request can assume the default value for those parameters. It can also result in the failure of the web service request.

1 Comment

  1. Is it possible to use Wildcards for the monitor query parameter? "*:*" does not work