Gå til innholdet

API-et for rapportdata: parametere, rader og verdier i detalj

Denne siden gir detaljene i rapportkallet i API-et for rapportdata: hva hver parameter gjør, hvilke rader og kolonner svaret har, og hvordan hver verdi skrives. Tokenet, HTTP-headeren og adressen til kallet står i API-et for rapportdata; oppsettet sammen med IT-avdelingen står i Hent rapportdata inn i Power BI eller et annet verktøy.

Parameter Hva den gjør Når den utelates
count Antall rader per side, som et heltall. ABMS har ingen øvre grense. Det kommer ingen rader.
page Hvilken side som skal hentes; 1 er første side. Side 2 starter etter de første count radene. Første side hentes.
language en eller no. Bestemmer språket i kolonnenavnene, listeverdiene og statusene, og datoformatet i Opprettet og Sist endret: 16.06.2026 for no, 16/06/2026 for en. Språket til API-brukeren brukes.
sort Kolonnen det skal sorteres etter, oppgitt som plassen i den lagrede kolonnerekkefølgen i rapporten, regnet fra 0 for første kolonne. En plass som ikke finnes, sorterer etter første kolonne. Den lagrede sorteringen i rapporten brukes; en rapport uten lagret sortering sorteres etter Sist endret, nyeste først.
reverse 1 sorterer synkende, 0 stigende. Den lagrede retningen i rapporten brukes.
search En søketekst, med de samme reglene som søkeboksen på rapportsiden; se Hvilke dokumenter en rapport viser: dokumenttyper, filtre, søk og sortering. Ikke noe søk.
archived 1 tar med arkiverte dokumenter; se radene nedenfor. Arkiverte dokumenter utelates.
from, to Godtas, men endrer ikke svaret på rapportkallet. —
Regel Detalj
Dokumenttyper Dokumenttypene i rapporten (nye, under arbeid, fullførte) gjelder.
Arkiverte dokumenter Avgjøres av parameteren archived, ikke av bryteren for arkiverte i rapporten. Med archived=1 legges alle arkiverte dokumenter til dokumentene av de andre typene i rapporten. En rapport som er satt opp til å vise bare arkiverte dokumenter, gir ingen rader med mindre archived=1 sendes.
Hovedfilter Hovedfilteret i rapporten gjelder.
Personlige filtre Personlige filtre som API-brukeren har satt på rapporten i ABMS, gjelder også. Gi API-brukeren ingen personlige filtre hvis verktøyet skal få de samme radene som rapporten viser en bruker uten personlige filtre.
documents_count Det samlede antallet dokumenter som passer, på tvers av alle sidene.
Regel Detalj
Kolonner De lagrede kolonnene i rapporten, i den lagrede rekkefølgen. Den egne kolonnerekkefølgen til API-brukeren i ABMS brukes ikke.
Navn Hver verdi har kolonnetittelen på det valgte språket som navn.
Utelatt Kolonnen Slette tas aldri med. Kolonnen for observasjoner utelates når arbeidsflyten i modulen ikke tillater lagring som observasjon, Sendt eksternt når ingen steg kan sendes ut av ABMS, og Status når modulen ikke har statuser.
Siste oppføring Lenken til dokumentet.
Kolonne eller felttype Verdi
Opprettet, Sist endret Datoen som tekst i formatet for det valgte språket.
Ansvarlig Fullt navn på brukeren, fulgt av «[Deactivated]» for en deaktivert bruker, eller «No User» når steget ikke har noen bruker. Begge tekstene vises på engelsk, også med language=no.
Status Statusnavnet på det valgte språket. Et arkivert dokument har «Arkivert» («Archived» med language=en).
Sendt eksternt «Ja» eller «Nei» («Yes» eller «No» med language=en).
Nedtrekksliste, valgknapper, avkrysningsbokser Navnene på verdiene på det valgte språket; flere verdier skilles med komma.
Sjekkliste Antall oppgaver det er krysset av for, og totalt antall, for eksempel «3/5».
Koblet nedtrekksliste Verdiene som er valgt, skilt med komma, eller hele stien med « - » mellom nivåene når listen er satt opp til å vise hele stien.
Opplastingsfelt En liste med én oppføring per fil, hver med title (filnavnet) og url (nettadressen).
Andre kolonner (datofelt, tall, Revisjonsnummer, globale felt, kolonnen for observasjoner) Den samme verdien som i Excel-eksporten; se Eksport av rapporter: hva Excel- og PDF-filene inneholder.
Risikofelt En oppføring med value (tallet, eller NA) og color_code: risikofargen som heksadesimal kode når Vis farger er slått på for modulen, ellers tom.