BI API

measures

Mandatory.

Comma-separated list of internal measure names (e.g. "feesext,minutesint"). You can find the list of internal names of the supplied default measures here.

dimension

Mandatory, case-insensitive.

List of dimensions by which the result is grouped (e.g. "Projekt,Projektbearbeiter"). You can find the list of dimensions of the supplied default measures here.

As a pseudo-dimension, "Month" can also be specified. Key date values such as OvertimeBalance are only accepted for a time series. For these values, you also have to specify dimension=month, otherwise an error message appears.

If there are different roles for the dimension, access can be made via a suffix [Index 0-4].

• Projekt selects the dimension project without role.
• Projekt_1 selects the dimension project to index 1 on the metric. This must then be a role on the project.
• etc.

Example when querying the measure FeesExt (external fee):

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

If several measures with different “dimension structures” are requested and the requested dimensions cannot be delivered across all measures, a relevant error message appears. If this happens, you have to bundle the measures with the same dimension structure into a query and discontinue several of these queries in order to extract all data.

_variable and OCL expression

Optional. As of Vertec 6.5.0.11, you can specify for each dimension parameter (dimension0=Projekt, dimension1=Projektbearbeiter etc.), alias parameters with an OCL expression as a value dimension0_Projekttyp=typ.bezeichnung.

This adds a new field Projekttyp to the response, which contains the designation of the project type of the project dimension value.

You can specify any number of alias parameters per dimension. If the parameter used matches a name that is already used (as a measure name, class name or its translations, or alias of another dimension), an error is reported.

startDate

endDate

selectExpression

Optional. OCL expression for selection.

useDescriptions

Optional, True or False. Default: False.

Determines whether the column labels are delivered in plain text and translated, or as internal technical designations that are language independent.

f

Optional. Determines the format in which the result is output:

• csv: returns the result as a CSV file
• json: returns the result formatted in json.

You can specify the parameter as an accept header, instead of a query string. If both are present, the query string is used.

currency

The currency indicated here must match the designation field on the currency.                    

If an empty currency is passed with this parameter (or the parameter is not specified), it is interpreted as the key currency. For all other currencies, the values are read in the specified currency, if possible.

Header (column names)

Name of the requested measure (internal name). If the parameter is useDescriptions = true, the plain text designation of the measure is used instead of the internal name, and is returned translated according to the current language of the session.

Data row

• Dimensional values
• Object ID of dimensions (from Vertec 6.5.0.11): For each dimension value, there is a property with the same name and suffix _Id, which contains as the value the object ID of the dimension value: {"Bearbeiter":"Administrator","Bearbeiter_Id": 301,"Month":"2020-01-01", ...}. Month dimensions appear without the _Id-field in the result.
• Measure values