Verschillen
Dit geeft de verschillen weer tussen de geselecteerde revisie en de huidige revisie van de pagina.
| Beide kanten vorige revisie Vorige revisie | |||
| stable:applicatiebeheer:probleemoplossing:programmablokken:zgw_open_zaak_api_functionaliteit:opvragen_lijst_eigenschappen [2026/07/15 10:16] – ↷ Pagina verplaatst van stable:applicatiebeheer:probleemoplossing:programmablokken:zgw_open_zaak_api_functionaliteit:opvragen_lijst_eigenschappen naar dev:applicatiebeheer:probleemoplossing:programmablokken:zgw_open_zaak_api_functionaliteit:opvragen_lijst Kars Gottschal | stable:applicatiebeheer:probleemoplossing:programmablokken:zgw_open_zaak_api_functionaliteit:opvragen_lijst_eigenschappen [2026/07/15 11:07] (huidige) – aangemaakt - Externe bewerking 127.0.0.1 | ||
|---|---|---|---|
| Regel 1: | Regel 1: | ||
| + | ===== Opvragen lijst met eigenschappen conform OpenZaak API ===== | ||
| + | {{tag> | ||
| + | Op het endpoint // | ||
| + | De // | ||
| + | Er kan ook informatie van één specifieke eigenschap gevraagd worden door de uuid van die eigenschap als path parameter toe te voegen: bijvoorbeeld // | ||
| + | |||
| + | Gebaseerd op versie Open Zaak API 1.2 | ||
| + | |||
| + | <adm warning Whitelist> | ||
| + | De zender die hier een de eigenschappen opvraagt zal gewhitelist moeten worden. Dit kan in de tabellen tbendpointlist en tbipauthorisationlist onder de tegel [[stable: | ||
| + | In de tabel tbendpointlist zal minimaal het endpoint /// | ||
| + | </ | ||
| + | |||
| + | ===== Authorisation Token ===== | ||
| + | |||
| + | In de Authorization header van dit GET bericht moet een valide JWT-token worden meegegeven onder Bearer Token. | ||
| + | Zie voorbeeld bij [[stable: | ||
| + | |||
| + | Voor het verkrijgen van een token (met beperkte geldigheidsduur!) zie: [[stable: | ||
| + | |||
| + | De token wordt opgezocht in de tabel tbaccesstoken en het tijdstip van aanvraag wordt getoetst aan de geldigheidsduur van de gevonden rij. | ||
| + | |||
| + | <adm warning (robot) Medewerker moet gelinkt zijn aan endpoint> | ||
| + | De gevonden token is gelinkt aan een (robot)-medewerker (degene onder wiens credentials het token is gecreëerd). Bij de betreffende medewerkers kaart moet de kolom //Endpoint (robotmedewerker is gedefinieerd voor binnenkomende berichten op endpoint)// (dnkeyendpointlist) in blok login verwijzen naar een kaart in // | ||
| + | </ | ||
| + | |||
| + | ==== Path Parameter ===== | ||
| + | |||
| + | Niet verplicht. Indien gevuld dan met een uuid van een specifieke eigenschap. Die uuid verwijst naar de kolom dvdsovraagid van tbdsospecvraagid | ||
| + | Endpoint is dan bijvoorbeeld // | ||
| + | |||
| + | |||
| + | ===== Headers ===== | ||
| + | |||
| + | Geen verplichte header. | ||
| + | |||
| + | ===== Query Parameters ====== | ||
| + | |||
| + | Niet verplicht. OpenWave ondersteunt de queryparameter // | ||
| + | * zaaktype dan verwacht OpenWave als waarde een uuid van een zaaktype (dus een verwijzing naar de kolom dvzgwuuid van tbsoortomgverg of tbsoortovverg). | ||
| + | * zaaktypeidentificatie dan verwacht OpenWave als waarde de URL verwijzing waaronder een zaaktype leeft (dus bijvoorbeeld // | ||
| + | * status. OpenWave verwacht een van onderstaande waarden: | ||
| + | * anders dan //alles, concept// of // | ||
| + | * //concept// dan moet // | ||
| + | * // | ||
| + | * alles dan wordt niet naar ddvervaldatum gekeken | ||
| + | |||
| + | Andere query parameters mogen doorgegeven worden, maar OpenWave negeert deze. | ||
| + | |||
| + | ===== Body ===== | ||
| + | |||
| + | Geen body. | ||
| + | |||
| + | ====== Responsebericht ===== | ||
| + | |||
| + | Indien de eigenschappenlijst niet kon worden gegenereerd wordt een responsecode anders dan 200/201 geretourneerd met in de body de oorzaak van het falen.\\ | ||
| + | |||
| + | Indien de eigenschappenlijst wel succesvol is gegenereerd wordt onder de responsecode 200 in de body een geneste array van eigenschappen opgesomd met hun identifiers en de zaaktypes waaraan ze verbonden zijn. | ||
| + | De data komen uit de tabel // | ||
| + | Verder gelden de restricties zoals hierboven beschreven bij de queryparameters van de GET.\\ | ||
| + | |||
| + | Er wordt een geneste array gegenereerd van de gevonden eigenschappen, | ||
| + | |||
| + | Onderstaand voorbeelden betekent dat de zender NA het aanmaken van een zaak onder het zaaktype-uuid // | ||
| + | Dat gebeurt met het POST-bericht // | ||
| + | Dat domein uit het eerste eigenschap van het voorbeeld responsebericht moet een string (specificatie: | ||
| + | De kardinaliteit geeft het aantal mogelijke voorkomens van waarden van deze EIGENSCHAP bij een zaak van het betreffende ZAAKTYPE: | ||
| + | * 0.n wil zeggen dat de waarde meerder keren of helemaal niet kan voorkomen | ||
| + | * 0.1 wil zeggen dat de waarde één keer of helemaal niet kan voorkomen | ||
| + | * 1 wil zeggen dat de waarde één keer moet voorkomen | ||
| + | * 1.n wil zeggen dat de waarde minimaal één keer moet voorkomen | ||
| + | |||
| + | De inrichtingssleutel uit de tweede eigenschap van het voorbeeld responsebericht moet een string zijn van maximaal 40 tekens en hoeft ook niet uniek te zijn.\\ | ||
| + | |||
| + | In OpenWave in de tabel tbdsospecvraagid moet bij de betreffende eigenschappen een SQL-statement ingevoerd worden die de tabel en kolom en rij bepaalt waar de domeinwaarde en inrichtingssleutel moet worden opgeslagen. | ||
| + | |||
| + | <adm example Voorbeeld response body> | ||
| + | <code json> | ||
| + | { | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | }, | ||
| + | " | ||
| + | " | ||
| + | }, | ||
| + | { | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | }, | ||
| + | " | ||
| + | " | ||
| + | } | ||
| + | ] | ||
| + | } | ||
| + | </ | ||
| + | </ | ||