Introduktion

Her kan du læse om data modellen bag Thetis IMS.

Mærker

For at du kan danne dig et overblik over et element, er de forskellige typer oplysninger på hvert element markeret med et farvet mærke. Et element kan have et eller flere mærker tilknyttet afhængigt af, hvilke typer oplysninger, der er relevante for elementet.

Mærker på tabeller

tabelnavn

Dette mærke viser navnet på tabellen. Det er det navn, du skal bruge, hvis du ønsker at manipulere data i tabellen via vores REST API.

Mærker på felter

feltnavn

Dette mærke viser navnet på feltet. Det er det navn, som bruges i alle JSON beskeder til og fra REST API’et.

type

Dette mærke viser feltets type. Typen kan enten være en simpel datatype, et indlejret element eller en opremsning. Denne dokumentation indeholder en beskrivelse af de forskellige mulige typer. Du kan navigere til beskrivelsen for et felts type ved at klikke på mærket.

begrænsning

Dette mærke angiver, at der er en begrænsning for hvilke værdier, det er muligt at gemme i feltet. Det angiver også, hvilken begrænsing, der er tale om.

Read only

Dette mærke angiver, at feltet kun kan læses. Du kan ikke inkludere feltet i en JSON besked til REST API’et. Men feltet vil være inkluderet i JSON beskeder fra REST API’et.

global reference

Dette mærke viser navnet på den tabel, der indeholder en række, som dette felt indeholder en reference til.

Globale referencer kan du bruge direkte i GET forespørgsler til REST API’et. Hvis et felt har global reference til ‘Shipment’, og i en given række har værdien 4711, kan du lave følgende forespørgsel til REST API’et:

GET /prod/shipments/4711 

område specifik reference

Dette mærke viser navnet på den tabel, som indeholder en række, som dette felt indeholder en reference til. Referencen er dog ikke entydig på tværs af abonnenter og områder. Den er kun entydig indenfor det aktuelle område.

medfølgende objekt

Dette mærke angiver navnet på en tabel, hvorfra relaterede rækker er inkluderet i JSON beskeder fra REST API’et.

Relaterede rækker er kun inkluderet i GET forespørgsler, der returnerer en enkelt række.

Mærker på opremsningstypers mulige værdier

mulig værdi

Dette mærke angiver en mulig værdi for et felt af en given opremsningstype. Det er denne værdi, som vi bruger i JSON beskeder til og fra REST API’et.

Lokaliserede felter

For ethvert datofelt og for ethvert felt af en opremsningstype indeholder Thetis IMS et felt, der har den samme værdi, men angivet i den tidszone, format og sprog, som den aktuelle bruger foretrækker. De lokaliserede felter har de samme feltnavne men med teksten ‘localized’ foranstillet.