The query interface returns the data in XML format.
The root element is called queryresult and contains the two child elements header and data.
The header XML element
This XML element has further child elements containing the following meta and data structure information:
XML element |
Description |
query |
PCDATA specifies the name of the favorite. |
session |
The Client, User and Language attributes contain the corresponding data used for the login. |
timestamp |
PCDATA specifies the execution time of the query to the second. |
filter |
PCDATA outputs all filters contained in the URL in URL notation. Each filter is described in more detail in a separate item child element. |
Child element item |
PCDATA contains the filter as a key value pair. The Key attribute specifies the key and the Value attribute the value of the filter. |
column |
Each element describes an individual data column. PCDATA contains the interface name of the measure or dimension. The Name attribute specifies the internal name and the Datatype attribute the PPM data type of the values. The Usage attribute specifies whether the data column contains values for a dimension (ITERATION) or a measure (KEYINDICATOR). |
The data XML element
For each data row returned, a row XML element is output and further child elements contain the dimension values (dc XML element) and measure values (kc XML element) for the corresponding columns.
XML element |
Description |
dc |
PCDATA and the Value attribute contain the dimension value for this data column. The Name attribute specifies the internal name of the dimension, corresponding to the Name attribute of a Column element. The Type attribute specifies the data type, which may differ from the PPM data type specified in the corresponding Column element. The Value2 element specifies the scaling for numerical values, the descriptions - separated by \ for multi-level dimensions - for text dimensions and the format string for times. |
kc |
PCDATA and the Vvalue attribute contain the measure value for this data column. The Name attribute indicates the internal name of the measure, corresponding to the Name attribute of a Column element. |
Example
If you enter the URL http://<Basic URL>/API_demo41_en/urlquery/query.do?favoritename=%5CMVs%5CHelpdesk%5CFavorite_Table&WERKS=3000&language=en&TIME=2007 for the demo database in Internet Explorer, the following result is obtained:
Error messages
If a query cannot be executed correctly, an error XML element is output instead of the data XML element. The text of the error is specified in PCDATA and the identifier in the id attribute.
Example