OMD Query

This application provides an API to retrieve specific configuration information such as KPI values and statistics. Query definitions usually contain a set of parameters. For example, OMD Scheduler uses this API to dynamically retrieve KPIs defined for the set of currently selected resources and days.

The application is backed by a configuration document which is placed in the configuration's content folder called query and must be called query-config.xml. If not available in the configuration's content folder, the application will use the default configuration folder. Note that the document can only be edited by OMD staff.

Use the URL /omd-query/rest/v1/query/schema to view the query schema.

The configuration XML may contain several Query definitions, which can consist itself of several sub queries (compound).

Use the URL /omd-query/rest/v1/query/config?configId=1490785 to view the query definition for configuration 1490785.

The URL /omd-query/rest/v1/query/execute/compound?configId=1490785 retrieves a compound Query.

By default, all row values are returned as separate Value elements containing an attribute index for the position of the value and an attribute value containing the row's value. Adding the system parameter $attributes will return the values as attributes of the Row element, each named attr0, attr1, ...