BI API

measures

Obligatorisch.

Kommaseparierte Liste der internen Kennzahlnamen (z.B. "feesext,minutesint" ). Die Liste der internen Namen der mitgelieferten Standard-Kennzahlen finden Sie hier .

dimension

Obligatorisch, case-insensitive.

Liste der Dimensionen, nach denen das Ergebnis gruppiert ist (z.B. "Projekt,Projektbearbeiter" ). Die Liste der Dimensionen der mitgelieferten Standard-Kennzahlen finden Sie hier .

Als Pseudo-Dimension kann auch "Month" angegeben werden. Stichtageswerte wie OvertimeBalance werden nur akzeptiert für Zeitreihen. Bei diesen Werten muss also dimension=month angegeben werden, andernfalls erscheint eine Fehlermeldung.

Sind für die Dimension verschiedene Rollen vorhanden, kann der Zugriff über ein Suffix [Index 0-4] erfolgen.

• Projekt wählt die Dimension Projekt ohne Rolle.
• Projekt_1 wählt auf der Kennzahl die Dimension Projekt auf Index 1. Dies muss dann eine Rolle auf Projekt sein.
• usw..

Beispiel bei Abfrage der Kennzahl FeesExt (Honorar extern):

    dimension0 = Projekt
    dimension1 = Projektbearbeiter_1
    dimension2 = Projektbearbeiter_2
    dimension3 = ProjektPhase
    dimension4 = Taetigkeit
    dimension5 = Month

Werden mehrere Kennzahlen mit unterschiedlichem "Dimensionsaufbau" angefordert und die angeforderten Dimensionen können nicht über alle Kennzahlen geliefert werden, erscheint eine entsprechende Fehlermeldung. In einem solchen Szenario müssen die Kennzahlen mit gleicher Dimensionstruktur in einer Query gebündelt und mehrere dieser Queries abgesetzt werden, um alle Daten zu extrahieren.

_variable und OCL Expression

Optional. Ab Vertec 6.5.0.11 können zu jedem Dimensions-Parameter (dimension0=Projekt, dimension1=Projektbearbeiter etc.) Alias-Parameter mit einer OCL Expression als Wert angeben werden, z.B. dimension0_Projekttyp=typ.bezeichnung .

Dies bewirkt, dass in der Antwort ein neues Feld Projekttyp auftaucht, welches die Bezeichnung des Projekttyps des Projekt-Dimensionswertes enthält.

Pro Dimension können beliebig viele Alias-Parameter angegeben werden. Entspricht der verwendete Parameter einem Namen, der bereits verwendet wird (als Measurenamen, Klassennamen bzw. deren Übersetzungen oder Alias einer anderen Dimension), wird ein Fehler gemeldet.

startDate

endDate

selectExpression

Optional. OCL-Expression für die Selektion .

useDescriptions

Optional, True oder False. Standard: False.

Bestimmt, ob die Spaltenbezeichnungen im Klartext und übersetzt geliefert werden oder als intern technische Bezeichnungen, die sprachunabhängig sind.

f

Optional. Bestimmt, in welchem Format das Resultat ausgegeben wird:

• csv: liefert das Resultat als CSV-Datei
• json: liefert das Resultat in Json formatiert.

Der Parameter kann statt als Query-String auch als Accept Header angegeben werden. Ist beides vorhanden, wird der Query-String verwendet.

currency

Darin wird die Währung so angegeben, wie im Feld Bezeichnung auf der Währung erfasst.     

Wird mit diesem Parameter eine leere Währung übergeben (oder der Parameter nicht angegeben), wird das als Leitwährung interpretiert. Bei allen anderen Währungen werden die Werte in der angegebenen Währung ausgelesen, falls möglich.

Header (Spalten-Namen)

Name der angefragten Kennzahl (Interner Name). Falls der Parameter useDescriptions = true ist, wird statt des internen Namens die Klartext-Bezeichnung der Kennzahl verwendet und gemäss aktueller Sprache der Session übersetzt zurückgeliefert.

Datenzeile

• Dimensionswerte
• Objekt Id der Dimensionen (ab Vertec 6.5.0.11): Für jeden Dimensionswert gibt es eine Eigenschaft mit gleichem Namen und Suffix _Id welche als Wert die Objekt Id des Dimensionswertes enthält: {"Bearbeiter":"Administrator","Bearbeiter_Id": 301,"Monat":"2020-01-01", ...} . Dimensionen Monat erscheinen ohne _Id -Feld im Ergebnis.
• Kennzahl Werte