...
I KITOS API vil alle ressourcer være tildelt en UUID, der er garanteret unik og garanteret stabil uanset ændringer i den bagvedliggende struktur. I Version 1 har man typisk anvendt “Id” feltet på ressourcerne - et felt der primært er tiltænkt databasens relationsmodel, men som, af mangel på bedre, har været anvendt som identifikation på ressourcer trukket ud via API’et. Dette ændres der på i Version 2 hvor kun UUID er gyldigt som identifikation for entiteter ressourcer i KITOS.
Paginering på listeudtræk
...
Udfaldsrum
Organisationer
Brugere i organisationen
Målsætningen er ikke, at man skal kunne alt det man kan i hele KITOSU UI (administration af udfaldsrum f.eks.), men indenfor rodaggregaterne skal man kunne hente og skrive alt hvad man ellers er i stand til via UI, uden at det nødvendigvis er på samme form.
Krydsreferencer
Når en entitet ressource refererer til en anden entitet ressource - f.eks. en snitflade der refererer et udstillersystem , - så vil KITOS API tilføje en krydsreference. En krydsreference er en simpel datastype, der (som minimum) indeholder navn (name) og en id (uuid). Detaljeret information kan hernæst findes via det REST API, der findes for den krydsrefererede type.
...
I første omgang tilbydes rettelser via anvendelse af PUT og i begrænset omfang via PATCH.
I PUT leveres alt data til den nye version af ressourcen. Dette betyder at udfylder man ikke et valgfrit felt i json dokumentet der sendes ifm. PUT, så nulstiller KITOS data for dette felt. Da data kan have været opdateret i KITOS anbefales det derfor at skrive ændringer via API via følgende protokol:
...
Når PATCH anvendes er det for at muliggøre opdatering af en delmængde af ressourcen dvs. man skal i denne sammenhæng ikke levere en fuld opdatering men kan nøjes med at opdatere den del af data som er relavant.
Begrænsninger i PATCH
I første omgang (indtil Indtil https://os2web.atlassian.net/browse/KITOSUDV-2358 er løst) , tilbydes PATCH med begrænset opløsning, hvor valgfriheden tilbydes på “rod-niveau”. Dette er eksemplificeret nedenfor:
...