Om data op te halen kies je voor een ‘Ophalen’ bouwblok van de applicatie waarvan je data op wil halen. Het ophalen kent twee varianten, een met metadata en een variant zonder metadata.
| Info |
|---|
Het component ‘Ophalen’ is beschikbaar voor elk type applicatie dat je hebt aangemaakt in Applicaties. |
Ophalen met metadata
Een applicatie waarbij metadata is vastgelegd geeft je de mogelijkheid om te kiezen uit alle endpoints uit de metadata, in plaats van het handmatig moeten samenstellen van alle requests.
| Info |
|---|
Het component ‘Ophalen’ is beschikbaar voor elk type applicatie dat je hebt aangemaakt in Applicaties. |
Hier is als voorbeeld het bouwblok Nedap ONS: Ophalen gebruikt.
...
Op het tabblad ‘Instellingen' (1) worden alle gegevens voor het uit te voeren request opgegeven. Het tabblad ‘Resultaten na uitvoer’ (2) bevat de kolommen die opgehaald worden. Het tabblad 'Documentatie applicatie’ (3) bevat een overzicht van de metadata die is vastgelegd.
Instellingen
Onderstaande beschrijving gaat volledig over het tabblad ‘Instellingen’.
...
| Info |
|---|
Om een waarde uit een dataset te kunnen gebruiken is een loop vereist die door de regels van de betreffende dataset heen loopt. Voor meer info, zie Loop. |
Resultaten na uitvoer
Het tabblad ‘Reslutaten na uitvoer’ bevat de kolommen die opgehaald worden vanuit de metadata. Dit is de lijst met alle kolommen die je terug mag verwachten nadat het request uitgevoerd is.
...
Documentatie applicatie
Het tabblad ‘Documentatie applicatie’ biedt een handig overzicht van de endpoints die beschikbaar zijn in de metadata.
...
Hier kan je gemakkelijk zien hoe het request opgebouwd is, en welke aandachtspunten er zijn. Wanneer je een endpoint open klikt zie je hier meer informatie over hoe het request opgebouwd is, en hoe de response eruitziet.
...
Ophalen zonder metadata
Het is ook mogelijk om data op te halen van een applicatie zonder dat daar metadata voor is vastgelegd. Hiervoor zal je zelf het request moeten samenstellen.
| Info |
|---|
Het tabblad ‘Documentatie applicatie’ is niet beschikbaar voor een applicatie zonder metadata. |
...
Er dient altijd een Webservice/API ingevuld te worden. Dit is een keuze uit de applicaties die je hebt vastgelegd. Wanneer je een applicatie geselecteerd hebt wordt er gecontroleerd of er metadata aanwezig is. Als dat niet zo is kan je handmatig het request invullen. Het base request staat al ingevuld, dat is afkomstig uit de applicatie die je hebt vastgelegd. Vervolgens kies je de methode en het specifieke endpoint.
Als het nodig is kan het request afgemaakt worden met query parameters, headers en een body.
Vervolgens is het belangrijk om onder het onderdeel ‘Resultaat’ het result type van het request op te geven, in de meeste gevallen zal dit JSON zijn.
Wanneer alles correct is ingevuld kan onder het tabblad ‘Resultaten na uitvoer’ gecontroleerd worden of het request correct is opgesteld. Wanneer het request een geldig request is zullen hier de kolommen teruggegeven worden van het request dat je probeert uit te voeren.
...