The generic format of a URL is as follows:
List of attributes and query parameters for BMC ProactiveNet web services that retrieve data
Type of protocol to send the request. BMC ProactiveNet web services support both HTTP and HTTPS protocols.
Host name of the BMC ProactiveNet Server
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.
Type of resource that you want the web service to interact with. The available resource types are as follows:
Each URL can have only one resource type.
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 API that you want to call. The available APIs are as follows:
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.
Type of identifier that the resourceID parameter used. The available identifier types are as follows:
By default, URI is used as the identifier.
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.
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.
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.
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.
Type of performance statistics data that you want to retrieve. This data can be of two types:
If statstype is not specified, by default, the data retrieved is raw data.
Type of attribute that you want to retrieve. Attributes can be of two types:
If the attributetype parameter is not specified, by default, KPI data is retrieved.
Name of the tenant for which you want to fetch data
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.