Gebruik REST API in TriplEforms

Gemaakt door Mark Duijkers, Gewijzigd op Vr, 23 Sep, 2022 om 11:55 AM op Mark Duijkers

Introductie

Net als het gebruik van SOAP is het ook mogelijk om REST te gebruiken binnen een TriplEforms formulier.

REST kan worden gebruikt om informatie in een (externe) database of programma te verwerken.
TriplEforms ondersteunt REST POST, GET, PUT, DELETE en PATCH HTTP methoden. Verder kan de gebruikte REST dienst XML, JSON of tekst terug geven aan TriplEforms.

Een REST koppeling kan worden toegevoegd als control binnen een scenario of als service call binnen een formulier.

Verbinding leggen met een REST API

Voordat de REST API kan worden toegepast dient er eerst een koppeling te worden gemaakt.
Ga hiervoor naar de Solutions Explorer en dan naar Settings.

Vervolgens kan er bij het onderdeel "REST service connections" de benodigde informatie worden ingevuld.

Ook kunnen er extra headers mee worden gezonden (zoals bijvoorbeeld tokens of authenticatie); het is ook mogelijk om hier TriplEforms variabelen in te zetten.
Mocht het een statisch gegeven zijn (dus zonder variabelen) dan is het aan te raden om "Header is read-only" aan te vinken.

Gebruik in een formulier

De inhoud van een REST API in een scenario kan eenvoudig worden weergegeven als platte tekst. Ook kunnen elementen zoals de HTTP status code worden weergegeven.
In onderstaand voorbeeld word een hele reeks weergegeven als platte tekst.

[#REST.OK] geeft in dit geval "200" terug, en [#REST.data] geeft de complete (zonder opmaak) JSON weer.

De inhoud kan bijvoorbeeld ook worden verwerkt in een element zoals een dropdown:

(Let op: wanneer er met JSON wordt gewerkt zoals in dit voorbeeld dient het JSON path te worden uitgewerkt. Gebruik eventueel een evaluator zoals http://jsonpath.com/)

Ook hier is het belangrijk dat de IDs zoals in de REST worden meegegeven overeenkomen met de waarden in TriplEforms.
In dit geval betreft het een lijst dus dan moet "Return as list" ook worden aangevinkt.

Gebruik hiervoor de TriplEforms log reader om het resultaat te controleren en te vergelijken met een (externe) REST koppeling.