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.
Het bouwblok ‘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.
Hier is als voorbeeld het bouwblok Nedap ONS: Ophalen gebruikt.
Het bouwblok om data op te halen bestaat uit drie tabbladen.
Op het tabblad ‘Instellingen' (1) worden alle gegevens voor het uit te voeren verzoek 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’.
Globaal kent dit onderdeel drie onderdelen. Als eerste selecteer je de applicatie waarvan je data op wil halen (1). Vervolgens wordt gecontroleerd of de applicatie metadata bevat, als dat zo is heb je de mogelijkheid om een endpoint uit de metadata te selecteren (2). Daarna worden de methode en URL voor je ingevuld.
Wanneer er metadata aanwezig is, en de schuif ‘Maak gebruik van de metadata’ aan staat, kan er een endpoint geselecteerd worden uit de lijst wanneer je op het veld ‘Bekende locaties uit metadata’ klikt.
Afhankelijk van het type bouwblok dat je bewerkt zijn bepaalde items uit de metadata wel of niet beschikbaar. De metadata wordt hier gefilterd op basis van de actie van het bouwblok. Als je gekozen hebt voor [naam applicatie] Ophalen dan krijg je alleen maar de optie om endpoints te selecteren met de methode GET. Wanneer je kiest voor [naam applicatie] Versturen krijg je de endpoints voor POST, PUT en DELETE te zien.
Wanneer een optie uit de lijst is geselecteerd wordt deze automatisch voor je ingevuld.
Mocht het nog nodig zijn, dan kan je met query parameters, headers en een body het request afmaken. In de meeste gevallen zal dit niet nodig zijn.
In bovenstaand voorbeeld is een endpoint gekozen waar geen query parameter benodigd is. Het komt ook voor dat een endpoint nog een query parameter bevat, bijvoorbeeld om een record met een specifieke ID op te halen
Wanneer je een endpoint selecteert dat een query parameter bevat, zal deze automatisch als query parameter toegevoegd worden in je request. Je moet hierbij nog zelf de waarde invullen.
De waarde invullen kan door handmatig een waarde op te geven. Je zou er ook voor kunnen kiezen om een waarde uit een eerdere dataset te gebruiken. Wanneer je hier gebruik van maakt, zet dan de naam van de kolom die je wil gebruiken tussen dubbele accolades, dus bijvoorbeeld {{Medewerkercode}}.
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.
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.
