Overordnet

Under er en liste over alle endepunkter:

Metode Endepunkt Funksjon
POST /objects Last opp én stor fil
POST /objects/initialization Initialiser opplasting av en oppdelt fil
POST /objects/{key}/part Opplasting av én av flere deler av en oppdelt fil
POST /objects/{key}/completion Fullfør opplasting av en oppdelt fil
POST /objects/{key}/cancellation Kanseller opplastningen av en oppdelt fil
GET /objects/{key} Last ned fil
DELETE /objects/{key} Slett opplastet fil
PUT /objects/{key}/download-receipt/{markerHerId} Kviter på at fil er lastet ned og lagret
GET /objects/{key}/download-status Hente status på hvilke mottakere som har kvittert på nedlasting

For opplasting velger man en av to metoder. Én hel fil med POST /objects, eller en fil oppstykket i flere små filer (multipart). Sistnevnte gjennomføres ved å initialisere opplastingen med POST /objects/initialization som returnerer en key. Denne brukes når en fortsetter med POST /objects/{key}/part hvor hver bit av det oppstykkede vedlegget lastes opp. Til slutt POST /objects/{key}/completion, alternativt POST /objects/{key}/cancellation.

Returverdien fra en opplastet fil er en lenke som kan brukes til å laste ned filen. Denne kan sendes mottaker via en annen kommunikasjonskanal, eller f.eks. brukes som en fil-referanse i en fagmelding. Filreferansen som returneres etter opplasting inneholder hele lenken, så filen kan f.eks. lastes ned direkte i en nettleser ved å aksessere lenken. Alternativt så kan nøkkelen (key) brukes til å laste ned filen ved å gjøre et kall mot GET /objects/{key}.

Sletting av en opplastet fil kan gjøres av avsender med DELETE /objects/{key}. Nedlaster skal også markere filen som nedlastet med PUT /objects/{key}/download-receipt/{markerHerId}. Når alle mottaker har lastet ned og markert filen som nedlastet, vil den bli automatisk slettet. Filen vil automatisk slettes av retention mekanismer noen dager etter opplasting, så REST APIet skal ikke brukes til lagring, kun transport

Opplaster kan også verifisere hvem som har kvittert på nedlasting med GET /objects/{key}/download-status