Verschillen

Dit geeft de verschillen weer tussen de geselecteerde revisie en de huidige revisie van de pagina.

--- stable:applicatiebeheer:probleemoplossing:programmablokken:zgw_open_zaak_api_functionaliteit:koppel_zgw_documentaanzaak [2026/07/15 10:16] – ↷ Pagina verplaatst van stable:applicatiebeheer:probleemoplossing:programmablokken:zgw_open_zaak_api_functionaliteit:koppel_zgw_documentaanzaak naar dev:applicatiebeheer:probleemoplossing:programmablokken:zgw_open_zaak_api_functionaliteit:koppel_zgw_docum Kars Gottschal
+++ stable:applicatiebeheer:probleemoplossing:programmablokken:zgw_open_zaak_api_functionaliteit:koppel_zgw_documentaanzaak [2026/07/15 11:07] (huidige) – aangemaakt - Externe bewerking 127.0.0.1
@@ Regel 1: / Regel 1: @@
+===== Koppel Document aan Zaak conform OpenZaak API =====
+{{tag>openwave:1.34:applicatiebeheer:functionaliteiten:zgw}}
+Op het endpoint //base-url//<nowiki>/api/zgw/zaken/api/v1/zaakinformatieobjecten/</nowiki> kan een POST worden geplaatst met de UUID van een zaak (zie response bij creëer nieuwe zaak) en een UUID van een eerder geüpload document (zie uploaden van document). OpenWave kan hiermee het document aan een zaak koppelen en dat document op de juiste bestemming plaatsen.\\
+De //base_url// is de implementatie van OpenWave waar tegenaan gepraat moet worden, bijvoorbeeld: //<nowiki>https://acc.rommeldam.open-wave.nl</nowiki>//.\\
+Gebaseerd op versie Open Zaak API 1.2
+<adm warning Whitelist>
+De zender die hier een koppeldocumentaanzaak-bericht POST zal gewhitelist moeten worden. Dit kan in de tabellen tbendpointlist en tbipauthorisationlist onder de tegel [[stable:applicatiebeheer:probleemoplossing:portalen_en_moduleschermen:beheerportaal_nieuw:tegels_kolom_gebruikers:endpoints_whitelist]] op het nieuwe beheerportaal onder de kolom //Gebruikers//.
+In de tabel tbendpointlist zal minimaal het endpoint ///api/zgw// gedefinieerd moeten zijn met daaronder (in de tabel tbipauthorisationlist) het IP-adres van de zender.
+</adm>
+===== Authorisation Token =====
+In de Authorization header van dit POST bericht moet een valide JWT-token worden meegegeven onder Bearer Token.
+Zie voorbeeld bij [[stable:applicatiebeheer:probleemoplossing:programmablokken:zgw_open_zaak_api_functionaliteit:creeer_zgw_zaak]].
+Voor het verkrijgen van een token (met beperkte geldigheidsduur) zie:  [[stable:applicatiebeheer:probleemoplossing:programmablokken:zgw_open_zaak_api_functionaliteit]].\\
+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 //tbendpointlist// waarvan de inhoud van de kolom //dvendpointurl// een substring is van dit endpoint //api/zgw/zaken/api/v1/zaakinformatieobjecten// waarop dit koppelzaakaandocument-bericht wordt gepost: bijvoorbeeld: ///api/zgw//
+</adm>
+===== Headers =====
+De enige verplichte header variabele is: Content-Type met als waarde //application/json//
+===== Body =====
+In application/json.
+<adm Example>
+  {
+   "informatieobject": "https://acc.rommeldam.open-wave.nl/api/zgw/documenten/api/v1/enkelvoudiginformatieobjecten/7057f8b6-2e1f-47d9-92c9-8a51da1851c9",
+   "zaak": "https://acc.rommeldam.open-wave.nl/api/zgw/zaken/api/v1/zaken/dc594a1a-61ac-49d2-88cd-535029033fe3"
+  }
+</adm>
+Zie Github: POST Maak een ZAAK-INFORMATIEOBJECT relatie aan op https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/vng-Realisatie/zaken-api/1.5.1/src/openapi.yaml#tag/zaakinformatieobjecten/operation/zaakinformatieobject_create
+De verwerking van het bericht door OpenWave wordt gelogd in tbmessagelog indien:
+  * de instelling //Sectie: ZGW en Item: Messagelog// aangevinkt staat
+  * EN de instelling //Sectie: OWB en Item: MessageLog// aangevinkt staat
+Met de twee verwijzingen in dit bericht naar een specifieke zaak en naar een specifiek document (informatieobject) dat eerder is aangeboden ([[stable:applicatiebeheer:probleemoplossing:programmablokken:zgw_open_zaak_api_functionaliteit:upload_zgw_document]]) en zich bevind op de uploadmap van OpenWave (zie de kolom //Tekst// van de instelling  //Sectie: OWB en Item: TussenMapUploadFiles//) kan OpenWave nu dat document plaatsen bij de zaak.
+De eerste posities van de documentnaam op de uploadmap beginnen met de UUID-code die (vanaf de laatste slash) wordt doorgegeven in dit bericht bij item informatieobject.
+De uuid van de zaak (vanaf de laatste slash achter item zaak) wordt opgezocht in de kolom dvzgwuuid in tbomgvergunning of in tbovvergunningen. Bij die OpenWave zaak wordt een kaart aangemaakt in de geregistreerde documenten (tbcorrespondentie) met de verwijzing naar de plek waar het document uiteindelijk is opgeslagen (fileshare of in DMS).
+<adm warning Beperkte bewaartijd documenten op uploadmap>
+De documenten op de uploadmap worden maar een beperkte tijd bewaard. Default 24 uur, maar hier kan van afgeweken zijn met de waarde van //Getal1// van de instelling //Sectie: OWB en Item: MaxUurUpload//.
+Het is dus belangrijk dat dit vervolgbericht //Koppel document aan zaak// tijdig wordt verstuurd.
+</adm>
+====== Responsebericht =====
+Indien het document niet kon worden gekoppeld aan een zaak wordt een responsecode anders dan 200/201 geretourneerd met in de body de oorzaak van het falen.
+Indien het document succesvol is gekoppeld wordt onder de responsecode 201 het oorspronkelijke bericht geretourneerd aangevuld met de verplichte items, waarbij
+  *  in het item //uuid// de UUID-code wordt geretourneerd die OpenWave heeft toegekend aan de koppeling document en zaak. Deze UUID-code is opgeslagen bij de geregistreerde documenten in de kolom //tbcorrespondentie.dvzgwuuid//
+<adm example Voorbeeld resonsebody>
+  {
+  "zaak": "https://acc.rommeldam.open-wave.nl/api/zgw/zaken/api/v1/zaken/5d63649ae8164927a93a90b56d9bcddc",
+  "informatieobject": "https://acc.rommeldam.open-wave.nl/api/zgw/documenten/api/v1/enkelvoudiginformatieobjecten/79fdba5ed24543d48f7253e1e7623487",
+  "aardRelatieWeergave": "Hoort bij",
+  "registratiedatum": "2024-08-13T10:55:53",
+  "uuid": "f928a1b37309456e8d07ed773ec692af",
+  "url": "https://acc.rommeldam.open-wave.nl/api/zgw/zaken/api/v1/zaakinformatieobjecten/f928a1b37309456e8d07ed773ec692af"
+  }
+ </adm>