Composing requests in data APIs

To retrieve data about system entities, such as Geo PCLs and incidents, data APIs use HTTPS-encoded requests to the system.

Every request must have the following format:

Where:

• <SystemHost> is the IP address or host name of the BMC Real End User Experience Monitoring computer that you want to request data from.
• <resourceapi> is the specific data API you are accessing. For example, if you are accessing the Incidents Data API, replace <resourceapi> with incdentAPI.
• <APIVersionNumber> is the version of the API you are using (for example, 1.0).
• <resource>/<resourceIdentifier> is the resource you are accessing via the API and the particular identification number of the resource. For example, if you are requesting data for a given Geo PCL definition, the resource is geoPCL and the resource identifier is the integer that uniquely identifies the Geo PCL definition.
  
  For complex entities such as Geo PCLs, resources can be more specific.
  
  For example, to access aggregated data for a particular zone associated with a Geo PCL definition, the full resource might be geopcl/1/zone/4/aggregation, where you are accessing aggregation data
   for a specific zone in associated with a specific Geo PCL definition.
• <parameters> is one or multiple key-value pairs. Key-value pairs must be separated by ampersands (&) and the elements in a key-value pair must be linked with equal signs (=).

Sample request to data APIs

• • ==

Where to go from here

Geographic-performance-compliance-level-Geo-PCL-data-API
Incident-data-API