Grunnleggende
Tillatte HTTP-verber er GET, PATCH, POST og DELETE. Her er detaljerte beskrivelser av anropstyper:
- GET: Hente data fra Severa
- PATCH: Oppdatere eksisterende data
- JSON Patch er formatet som brukes for å oppdatere data i REST API (mer informasjon på: http://jsonpatch.com/).
- Kun Replace (erstatte) er støttet.
- POST: Opprette nye data i Severa
- DELETE: Slette data fra Severa.
- Bruk med forsiktighet, da slettede data fjernes permanent
- Svarkodene for anrop er Success, Created og Bad request
Paginering
Som standard hentes 20 rader per GET-anrop, og maksimum er 1000. Parametrene er firstRow og rowCount. Anbefales for tunge anrop.
Tekstsøk
Parameteren textToSearch kan brukes for raskt søk. For eksempel har GET/users anropet en parameter som lar deg søke etter informasjon relatert til brukernavn, kode, e-post eller nøkkelord. For hver rute er feltene som søket utføres på, definert i den tekniske dokumentasjonen.
Sortering
Definert i mange GET all for ruter som en spørringsparameter. Den støtter å gi flere verdier. Eksempel:
- ?sortings[0]
- [key]=lastUpdatedDateTime&sortings[0]
- [value]=Desc&sortings[1]
- [key]=createdDateTime&sortings[1]
- [value]=Asc
Changed since
Parameter for å hente data fra en bestemt dato og fremover. Med denne parameteren kan du hente data som er endret etter den angitte datoen. For eksempel har GET/users anropet en ChangedSince-parameter som gir brukere som er lagt til eller endret etter denne datoen (større eller lik).
Omfang (Scopes)
For øyeblikket er kun SeveraAll i bruk, men omfang vil bli lagt til etter hvert som de implementeres.
Var dette svaret til hjelp? Ja Nei
Send feedback