Composing requests in configuration APIs

To configure features, such as Watchpoints and custom fields, configuration APIs use HTTPS-encoded requests to the system.

Every request must have the following format:

• <SystemHost> is the IP address or host name of the BMC Real End User Experience Monitoring Software Edition computer that you want to configure.
• <resourceapi> is the specific configuration API that you are accessing. For example, if you are accessing the Custom field configuration API, replace <resourceapi> with <customfieldapi>.
• <APIVersionNumber> is the version of the API that you are using (for example, 1.0).
• <resource> is the resource that you are accessing via the API. For example, if you are editing a custom field with a PUT command, the resource is customfield.
• <resourceIdentifier> is the identification number of the resource that you are accessing. For example, if you are accessing a given custom field, <resourceIdentifier> is the custom field's identification number (custom field ID). If you are composing a request that accesses multiple resources (all custom fields, for example), you do not need to specify the resource identifier.
• <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 (=).

For a stateful operation, you must also supply a transaction identifier (tid). A transaction identifier is returned in the response to a successful request that you make to initiate a transaction on the system and must be used in each subsequent operation in the transaction.

Sample request to configuration APIs

Where to go from here

Watchpoint-configuration-API

Custom-field-configuration-API