FORM-version 2.10.5  

FORM-REST udstiller forretningsreferencemodellen (FORM) som RESTful web service. Her følger en dokumentation af de forskellige funktioner, der er tilgængelige i FORM-REST.

Opgavenøgle

Man kan både hente hele Opgavenøglen med samtlige serviceområder, hovedområder, opgaveområder og opgaver, og hente delelementer som f.eks. et enkelt hovedområde, med tilhørende opgaveområder.

For at hente den fulde Opgavenøgle skriver man følgende URL:

Ønsker man at hente dele af Opgavenøglen skal man anvende to parametre: FormIndgang og dybde.

"FormIndgang" angiver FORM-nummeret på det element, man ønsker at hente. Formatet for hhv. serviceområder, hovedområder, opgaveområder og opgaver er: "00", "00.00", "00.00.00", "00.00.00.00".

"dybde" angiver hvor mange niveauer, man ønsker at hente sammen med det specificerede element. Angiver man FormIndgang og ikke nogen dybde, returneres samtlige niveauer under det angivne element. Angiver man dybde=0 returneres det specificerede element i et særligt kort format. Ligeledes returneres niveauet under sidste niveau altid i kort format.

Her følger et par eksempler:

  1. http://www.form-online.dk:8080/FORM-REST/resources/10?dybde=0 (link)
  2. http://www.form-online.dk:8080/FORM-REST/resources/10?dybde=1 (link)
  3. http://www.form-online.dk:8080/FORM-REST/resources/10?dybde=2 (link)
  4. http://www.form-online.dk:8080/FORM-REST/resources/37.25.30 (link)

Eksempel 1, 2 og 3 henter alle serviceområde 10. Eksempel 1 henter i kort format uden hovedområder. Eksempel 2 henter i fuldt format inklusive hovedområder i kort format. Eksempel 3 henter serviceområdet og tilknyttede hovedområder i fuldt format, samt opgaveområder i kort format.

Eksempel 4 henter opgaveområdet 37.25.30 i fuldt format inklusive tilknyttede opgaver i fuldt format.

Man kan også kalde "resources" med en UUID i stedet for et FORM-nummer. Syntaksen er helt identisk med ovenstående:

  1. http://www.form-online.dk:8080/FORM-REST/resources/f3295ba5-0915-11e0-8366-0050c2490048?dybde=1 (link)

Bemærk at FORM søgeord ikke leveres med som default, da de fylder meget. Ønsker man at få søgeord med i resultatet, skal man tilføje parameteren "soegeord" med værdien "ja". F.eks.

  1. http://www.form-online.dk:8080/FORM-REST/resources/10?dybde=1&soegeord=ja (link)

Søgning

Fritekstsøgningen fra FORM-Online er også til rådighed over REST via følgende URL:

Søgeresultatet returneres som en liste af FORM-elementer rangeret efter, hvor godt brugerens søgeord matcher de pågældende elementer. For hvert FORM-element er skemaet næsten identisk med skemaet for den almindelige hentning af FORM-elementer. Det vil sige, at hvert FORM-element er repræsenteret med sine vigtigste attributter (VersionIdentifikator, OprettetDato, NavnTekst, BeskrivelseTekst og NummerIdentifikator). Forskelle fra standardskemaet:

Som på FORM-Online er det i FORM-REST også muligt at angive forskellige parametre, der styrer mere præcist, hvordan søgningen udføres.

Parameteren "scope" angiver, hvilke FORM-elementer, der skal søges i. Man kan ved at angive én eller flere scope-værdier søge i ét eller flere elementer på en gang, f.eks.:

Parameteren "element" angiver, hvilke attributter, der skal søges i. Man kan angive én eller flere, f.eks.:

Parameteren "synonyms" angiver om der skal udføres en semantisk smal ("dictionary") eller bred ("synonyms") søgning. Standardsøgningen (smal søgning) søger på bøjningsudvidelser og sammemsatte ord. Angiver man en bred søgning, søges der dertil også på synonymer.

Hvis man ikke angiver nogen værdi for en given parameter, anvender søgningen default-indstillingen (som markeret i listen ovenfor).

NB! Søgning med resultater returneret via JSONP er endnu IKKE understøttet. NB! Søgeord returneres IKKE i søgeresultatet fra en fritekstsøgning.

Opslag i ældre (arkiverede) versioner af FORM

Alle operationer i REST-API'et foregår som udgangspunkt i nyeste publicerede version. Versionsnummeret på nyeste version står både angivet her på siden (øverst i højre hjørne) samt på alle resultater, der returneres fra API'et.

Det er muligt at tilgå ældre/arkiverede versioner af FORM, dog er søgningen kun tilgængelig for nyeste version. Ældre versioner kan tilgås ved at tilføje en "version"-parameter til sin URL.

Følgende arkiverede versioner er tilgængelige:

Prøv f.eks.

  1. http://www.form-online.dk:8080/FORM-REST/resources/05.05.55?version=2.1 (link)

Versionsnummerering

Her følger en kort forklaring af betydningen af de enkelte sekvenser i versioneringen af FORM:

Skema

Skemaet for den XML, som returneres er specificeret i følgende skema:

Ligeledes er der defineret et skema for nuværende (og fremtidige) funktionskald tilgængelige via FORM-REST:

JSONP

Data er også tilgængelige i JSON-format via JSONP på eksempelvis følgende URL:

Eksempel på javascript.

SPARQL Endpoint

Tilgængelighed via SPARQL Endpoint.