Position Green API: Mätningar

Ändrad den Mån, 9 juni vid 3:56 E.M.

Mätningar i Position Green definierar hela det organ av data som du vill samla in under ett rapporteringsår, detta inkluderar vem som ska rapportera data, hur ofta och vilka organisatoriska enheter. Mätningen skapas av Controller i Setup med hjälp av Measure Builder.

För att testa nedanstående endpoint, gå till vår Swagger UI-sida.

Egenskaper för ett mätning-objekt

Fastighet	Typ av data	Beskrivning
id	Vägledning	Mätningens id
namn	sträng	Mätningens namn
aspektNamn	sträng	Aspekten som den tillhör
PrettyID	sträng	Mätningarnas vackra id

Hämta alla mätningar

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

Returnerar alla mätningar

Parametrar för förfrågan

Namn	Ämne	Beskrivning
årId	sträng	Årets id
namnFilter	sträng	Filtrerar efter mätningens namn, med användning av 'nameFilter'
första	sträng	Begränsar resultatuppsättningen. Förvalt 10. Minst 1 och högst 500.
efter	heltal	Cursor som pekar på var man ska fortsätta resultatuppsättningen.
sortera efter	sträng	'Namn'
sortDirection	sträng	"Stigande" eller "Fallande". Förvalt 'Stigande'.

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

Exempel: hämtning av de 2 första mätningarna som innehåller "201" i namnet med användning av curl

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