XML-Datenstrom

Die Abfrageschnittstelle gibt die Daten im XML-Format zurück.

Das Wurzelelement heißt queryresult und enthält die beiden Kindelemente header und data.

XML-Element header

Dieses XML-Element enthält in weiteren Kindelementen folgende Meta- und Datenstrukturinformationen:

XML-Element

Beschreibung

query

PCDATA gibt den Namen des Favoriten an.
Attribut type enthält den Typ des Favoriten, PRIVATE oder SHARED.
Attribut title enthält die Überschrift des Favoriten

session

Die Attribute client, user und language enthalten die entsprechenden Daten, die zur Anmeldung verwendet wurden.

timestamp

PCDATA gibt sekundengenau den Ausführungszeitpunkt der Anfrage an.

filter

PCDATA gibt alle in der URL enthaltenen Filter in URL-Notaion aus. Jeder Filter ist in einem eigenen Kindelement item näher beschrieben.

Kindelement

item

PCDATA enthält den Filter als Schlüssel-Werte-Paar. Attribute key gibt den Schlüssel und Attribut value den Wert des Filters an.

column

Jedes Element beschreibt eine einzelne Datenspalte. PCDATA enthält den Oberflächennamen der Kennzahl oder Dimension. Attribut name gibt den Internen Namen, Attriubt datatype den PPM-Datentyp der Werte an. Attribut usage gibt an, ob es sich bei der Datenspalte um Werte einer Dimension (ITERATION) oder Kennzahl (KEYINDICATOR) handelt.

XML-Element data

Für jede zurückgelieferte Datenzeile wird ein XML-Element row ausgegeben und weitere Kindelemente enthalten die Dimensionswerte (XML-Element dc) und Kennzahlenwerte (XML-Element kc) der entsprechenden Spalten.

XML-Element

Beschreibung

dc

PCDATA und Attribut value enthalten den Dimensionswert dieser Datenspalte. Attribut name gibt den Internen Namen der Dimension an, enspricht dem Attribut name eines column-Elements. Attribut type gibt den Datentyp an, der vom im entsprechenden column-Element angegebenen PPM-Datentyp abweichen kann. Attribut value2 gibt für numerische Werte die Skalierung, für Textdimensionen die bei mehrstufigen Dimesnionen durch \ getrennte Beschreibungen und bei Zeiten den Formatierungszeichenkette an.

kc

PCDATA und Attribut value enthalten den Kennzahlenwert dieser Datenspalte. Attribut name gibt den Internen Namen der Kennzahl an, enspricht dem Attribut name eines column-Elements.
Attribut value2 (optional) gibt die Skalierung des Kennzahlenwertes an. Attribut zone (optional) gibt Planwertebereich des Kannzahlenwertes an, mögliche Werte: _GREEN, _YELLOW (ungünstige Abweichung), _RED (kritische Abweichung)

Beispiel

Wenn Sie für die Demo-Datenbank die URL http://<Basis-URL>/API_demo41_de/urlquery/query.do?favoritename=%5CMVs%5CHelpdesk%5CFavorite_Table&WERKS=3000&language=de&TIME=2007 im Internet Explorer ausführen, erhalten Sie folgendes Ergebnis:

Linked Picture File Template_support_manuals_APD

Fehlermeldungen

Wenn eine Anfrage nicht korrekt ausgeführt werden kann, wird anstelle des XML-Elements data ein XML-Element error ausgegeben. In PCDATA ist der Text und im Attribut id der Identifizierer des Fehlers angegeben.

Beispiel

Linked Picture File Template_support_manuals_APD