stable:applicatiebeheer:probleemoplossing:programmablokken:zgw_open_zaak_api_functionaliteit:maakzgwzaakeigenschap
Verschillen
Dit geeft de verschillen weer tussen de geselecteerde revisie en de huidige revisie van de pagina.
| Beide kanten vorige revisieVorige revisie | |||
| stable:applicatiebeheer:probleemoplossing:programmablokken:zgw_open_zaak_api_functionaliteit:maakzgwzaakeigenschap [2026/07/15 10:16] – ↷ Pagina verplaatst van stable:applicatiebeheer:probleemoplossing:programmablokken:zgw_open_zaak_api_functionaliteit:maakzgwzaakeigenschap naar dev:applicatiebeheer:probleemoplossing:programmablokken:zgw_open_zaak_api_functionaliteit:maakzgwzaakeigenschap Kars Gottschal | stable:applicatiebeheer:probleemoplossing:programmablokken:zgw_open_zaak_api_functionaliteit:maakzgwzaakeigenschap [2026/07/15 10:16] (huidige) – aangemaakt - Externe bewerking (Ongeldige datum) 127.0.0.1 | ||
|---|---|---|---|
| Regel 1: | Regel 1: | ||
| + | ===== Maak zaakeigenschap aan conform OpenZaak API ===== | ||
| + | {{tag> | ||
| + | |||
| + | Op het endpoint // | ||
| + | De path-parameter {identifier} in bovengenoemd endpoint is de UUID die toegekend is aan een eerder aangebrachte zaak op het endpoint // | ||
| + | |||
| + | Hieronder wordt een voorbeeld uitgewerkt waarbij op dit endpoint een inrichtingsnummer in de body wordt gestuurd op grond waarvan Openwave een eerder aangemaakte zaak (de uuid identifier in het endpoint) kan koppelen aan de bijbehorende inrichting.\\ | ||
| + | |||
| + | De // | ||
| + | |||
| + | Gebaseerd op versie Open Zaak API 1.2 | ||
| + | |||
| + | <adm warning Whitelist> | ||
| + | De zender die hier een creëer rolbericht POST 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 POST 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 // | ||
| + | </ | ||
| + | |||
| + | ===== Headers ===== | ||
| + | |||
| + | De enige verplichte header variabele is: Content-Type met als waarde // | ||
| + | |||
| + | ===== Body voor doorgeven zaakeigenschap===== | ||
| + | |||
| + | <adm example Voorbeeld maken zaakeigenschap> | ||
| + | <code json> | ||
| + | { | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | } | ||
| + | </ | ||
| + | </ | ||
| + | |||
| + | |||
| + | De verwerking van het bericht door OpenWave wordt gelogd in tbmessagelog indien: | ||
| + | * de instelling //Sectie: ZGW en Item: Messagelog// | ||
| + | * EN de instelling //Sectie: OWB en Item: MessageLog// | ||
| + | |||
| + | De URL van de zaak verwijst naar dezelfde zaak als de {ïdentifier} (de path-parameter) van het endpoint.\\ Deze zaak-uuid wordt opgezocht in tbomgvergunning.dvzgwuuid of tbovvergunningen.dvzgwuuid om zo de juiste zaak te bepalen waar de eigenschap aan toegevoegd moet worden. | ||
| + | De url van eigenschap verwijst naar een plek in Openwave waar een instructie is opgeslagen hoe en waar de //waarde// moet worden verwerkt. | ||
| + | In bovenstaand voorbeeld verwijst de eigenschap-uuid (de string vanaf de positie van de laatste slash in de eigenschap-url) naar een rij in de tabel tbdsospecvraagid. | ||
| + | De beheerder van OpenWave heeft bij het zaaktype (tbsoortomgverg of tbsoortovverg) waaronder de zaak valt een kaart aangemaakt in tbdsospecvraagid met in de kolom dvdsovraagid de eigenschap-uuid, | ||
| + | Deze eigenschap-uuid of URL moet dus doorgegeven worden aan de zender of kan opgehaald worden met [[opvragen_lijst_eigenschappen|]]. | ||
| + | Het item //waarde// bevat bijvoorbeeld een inrichtingsnr. | ||
| + | |||
| + | Die kaart in tbdspsecvraagid kan er als volgt uitzien:\\ | ||
| + | {{: | ||
| + | |||
| + | Bij verwerking van de body vervangt Openwave de variabelen: | ||
| + | * %dsoantwoord% met de inhoud van het item //waarde//. Op het // | ||
| + | * %keypointer% | ||
| + | |||
| + | Dat betekent na substitutie dat: Op de omgevingskaart met dnkey = //de gevonden primary key// de kolom dnkeymilinrichtingen wordt vervangen met de dnkey van tbmilinrichtingen waarvoor geldt dat dvinrichtingnr = ' | ||
| + | |||
| + | |||
| + | ===== Responsebericht | ||
| + | Indien de eigenschap niet kon worden aangemaakt of gekoppeld wordt een responsecode anders dan 200/201 geretourneerd met in de body de oorzaak van het falen. | ||
| + | Indien de eigenschap wel succesvol is aangemaakt wordt onder de responsecode 201 het oorspronkelijke bericht geretourneerd aangevuld met de verplichte items, waarbij | ||
| + | * in de items //uuid// en //url// een fake-uuid wordt geretourneerd die NIET is opgeslagen bij de aangemaakte eigenschap. Dus de eigenschap kan niet later nog eens gewijzigd worden | ||
| + | |||
| + | <adm example Voorbeeld response body eigenschap> | ||
| + | <code json> | ||
| + | { | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | } | ||
| + | </ | ||
| + | </ | ||
| + | |||
stable/applicatiebeheer/probleemoplossing/programmablokken/zgw_open_zaak_api_functionaliteit/maakzgwzaakeigenschap.txt · Laatst gewijzigd: door 127.0.0.1