Position Green API: Metriken

Geändert am Di, 8 Jul um 5:11 NACHMITTAGS

Die Metriken in Position Green definieren den gesamten Datenbestand, den Sie im Laufe eines Berichtsjahres erfassen möchten. Dazu gehört auch, wer die Daten erfasst, wie oft und für welche Organisationseinheiten. Eine Metrik wird vom Controller im Setup mithilfe des Metrikengenerators erstellt.

Um den nachstehenden Endpunkt zu testen, besuchen Sie bitte unsere Swagger-UI-Seite.

Eigenschaften eines Metrik-Objekts

Eigenschaft	Datenart	Beschreibung
id	Guid	ID der Metrik
name	String	Bezeichnung der Metrik
aspectName	String	Der Aspekt, zu dem sie gehört
prettyId	String	PrettyID der Metrik

Alle Metriken abrufen

GET https://api.positiongreen.com/v1/measures

Gibt alle Metriken aus

Abfrageparameter

Bezeichnung	Art	Beschreibung
yearId	String	ID des Jahres
nameFilter	String	Filterung nach der Metrikenbezeichnung mittels "nameFilter"
first	String	Begrenzt die Ergebnismenge. Standardeinstellung: 10. Mindestens 1 und höchstens 500
after	ganze Zahl	Cursor für die Stelle, an der die Ergebnismenge fortgesetzt werden soll
sortBy	String	"Bezeichnung"
sortDirection	String	"Aufsteigend" oder "Absteigend". Standardeinstellung: "Aufsteigend"

{
    "totalCount": 70,
    "pageInfo": {
        "hasNextPage": true,
        "startCursor": "aWR4OzA=",
        "endCursor": "aWR4Ozk="
    },
    "items": [
        {
            "cursor": "aWR4OzA=",
            "node": {
                "id": "da8e4c7d-5ffb-418b-ad3c-35c6be177fe7",
                "name": "Actual working hours",
                "aspectName": "OH&S"
            }
        }
    ]
}

Beispiel: Abrufen der ersten 2 Metriken, deren Bezeichnung "201" enthält, mittels curl

curl --request GET --header 'Authorization: Bearer <access token>'
'<api url>/measures?yearId=<year id>&first=2&nameFilter=201'