Documentatie

© REM Automatisering

Gebruikershulpmiddelen

Site-hulpmiddelen

Je bent hier: OpenWave Documentatie » Versie 1.35 » Applicatiebeheer » Probleemoplossing » Programmablokken » ZGW OpenZaak API Functionaliteit
dev:applicatiebeheer:probleemoplossing:programmablokken:zgw_open_zaak_api_functionaliteit

Verschillen

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

Link naar deze vergelijking

Beide kanten vorige revisieVorige revisie
Volgende revisie		Vorige revisie
dev:applicatiebeheer:probleemoplossing:programmablokken:zgw_open_zaak_api_functionaliteit [2026/07/15 10:16] – ↷ Pagina verplaatst van stable:applicatiebeheer:probleemoplossing:programmablokken:zgw_open_zaak_api_functionaliteit naar dev:applicatiebeheer:probleemoplossing:programmablokken:zgw_open_zaak_api_functionaliteit Kars Gottschaldev:applicatiebeheer:probleemoplossing:programmablokken:zgw_open_zaak_api_functionaliteit [2026/07/15 10:20] (huidige) – Kars Gottschal
Regel 1: Regel 1:
 ====== ZGW OpenZaak API Functionaliteit ====== ====== ZGW OpenZaak API Functionaliteit ======
  
-{{tag>openwave:1.34:applicatiebeheer:functionaliteiten:zgw}}+{{tag>dev:applicatiebeheer:functionaliteiten:zgw}}
  
 In het kader van Zaak Gericht Werken (ZGW) kan OpenWave zich gedragen als een Open Zaak Systeem waarmee gecommuniceerd kan worden conform de OpenZaak API. In het kader van Zaak Gericht Werken (ZGW) kan OpenWave zich gedragen als een Open Zaak Systeem waarmee gecommuniceerd kan worden conform de OpenZaak API.
  
-Zie voor snel inzicht van de vereisten die de functioneel beheerder moet uitvoeren: [[stable:applicatiebeheer:probleemoplossing:programmablokken:zgw_open_zaak_api_functionaliteit:vereiste_minimale_instellingen]].+Zie voor snel inzicht van de vereisten die de functioneel beheerder moet uitvoeren: [[dev:applicatiebeheer:probleemoplossing:programmablokken:zgw_open_zaak_api_functionaliteit:vereiste_minimale_instellingen]].
  
 Alle onderstaande POST en GET berichten moeten in de authorization header voorzien worden van een geldig Bearer JWT token, behalve het opvragen van de token zelf. Alle onderstaande POST en GET berichten moeten in de authorization header voorzien worden van een geldig Bearer JWT token, behalve het opvragen van de token zelf.
Regel 38: Regel 38:
  
 <adm warning Whitelist> <adm warning Whitelist>
-De zender die hier om een authorisatietoken vraagt 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//.+De zender die hier om een authorisatietoken vraagt zal gewhitelist moeten worden. Dit kan in de tabellen tbendpointlist en tbipauthorisationlist onder de tegel [[dev: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. 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.
Regel 50: Regel 50:
 In de tabel tbmedewerkers moet hiertoe een nieuwe medewerkerskaart aangemaakt worden met: In de tabel tbmedewerkers moet hiertoe een nieuwe medewerkerskaart aangemaakt worden met:
   * Loginnaam (dvloginnaam) = de uit te reiken //Username//   * Loginnaam (dvloginnaam) = de uit te reiken //Username//
-  * Client secret bij loginnaam t.b.v. accesstoken (dvclientsecret) = het uit te reiken //Password//. Let op: De ingetoetste waarde kan door OpenWave automatisch gecrypt worden opgeslagen indien //Getal1// van de instelling //Sectie: Encryption en Item: Method// de waarde 3 heeft. Zie [[stable:applicatiebeheer:instellen_inrichten:2way_encryptie_externe_wachtwoorden]]. Aan de zender moet dus de ongecrypte versie worden uitgereikt.+  * Client secret bij loginnaam t.b.v. accesstoken (dvclientsecret) = het uit te reiken //Password//. Let op: De ingetoetste waarde kan door OpenWave automatisch gecrypt worden opgeslagen indien //Getal1// van de instelling //Sectie: Encryption en Item: Method// de waarde 3 heeft. Zie [[dev:applicatiebeheer:instellen_inrichten:2way_encryptie_externe_wachtwoorden]]. Aan de zender moet dus de ongecrypte versie worden uitgereikt.
  
 De (robot)-medewerker moet in dienst zijn (vervaldatum leeg of > vandaag) en de kolom met de omschrijving //1=robot, 2=browser, 3=beide// (dnmaginmap) moet de waarde  1 (robot) hebben. De (robot)-medewerker moet in dienst zijn (vervaldatum leeg of > vandaag) en de kolom met de omschrijving //1=robot, 2=browser, 3=beide// (dnmaginmap) moet de waarde  1 (robot) hebben.
Regel 80: Regel 80:
 ==== Opvragen lijst van zaaktypen ==== ==== Opvragen lijst van zaaktypen ====
  
-Op het endpoint //base-url//<nowiki>/api/zgw/catalogi/api/v1/zaaktypen/</nowiki> kan met een GET een lijst opgevraagd kan worden van de benaderbare zaaktype-uuids uit OpenWave met bijbehorende roltype-uuids en informatieobjecttype-uuids (documenttypes). Bij succes wordt de responsecode 200 geretourneerd met in de body een geneste array van deze zaaktypes met eigenschappen. Zie [[stable:applicatiebeheer:probleemoplossing:programmablokken:zgw_open_zaak_api_functionaliteit:opvragenlijstmetzgwzaaktypen]].+Op het endpoint //base-url//<nowiki>/api/zgw/catalogi/api/v1/zaaktypen/</nowiki> kan met een GET een lijst opgevraagd kan worden van de benaderbare zaaktype-uuids uit OpenWave met bijbehorende roltype-uuids en informatieobjecttype-uuids (documenttypes). Bij succes wordt de responsecode 200 geretourneerd met in de body een geneste array van deze zaaktypes met eigenschappen. Zie [[dev:applicatiebeheer:probleemoplossing:programmablokken:zgw_open_zaak_api_functionaliteit:opvragenlijstmetzgwzaaktypen]].
  
 ==== Opvragen lijst van informatieobjecttypen ==== ==== Opvragen lijst van informatieobjecttypen ====
Regel 114: Regel 114:
 Op het endpoint //base-url//<nowiki>/api/zgw/zaken/api/v1/zaken/</nowiki> kan een POST worden geplaatst waarmee OpenWave een nieuwe zaak kan aanmaken. Op het endpoint //base-url//<nowiki>/api/zgw/zaken/api/v1/zaken/</nowiki> kan een POST worden geplaatst waarmee OpenWave een nieuwe zaak kan aanmaken.
 Bij succes wordt de responsecode 201 geretourneerd met in de body onder meer de uitgetrokken unieke UUID-code voor de zaak, waarmee in een vervolgbericht een contactrol kan worden aangemaakt en waarmee één of meer geüploade documenten aan deze zaak kunnen worden gekoppeld.  Bij succes wordt de responsecode 201 geretourneerd met in de body onder meer de uitgetrokken unieke UUID-code voor de zaak, waarmee in een vervolgbericht een contactrol kan worden aangemaakt en waarmee één of meer geüploade documenten aan deze zaak kunnen worden gekoppeld. 
-Zie [[stable:applicatiebeheer:probleemoplossing:programmablokken:zgw_open_zaak_api_functionaliteit:creeer_zgw_zaak]].   +Zie [[dev:applicatiebeheer:probleemoplossing:programmablokken:zgw_open_zaak_api_functionaliteit:creeer_zgw_zaak]].   
  
 ==== Creëer zaakobject  bij zaak ==== ==== Creëer zaakobject  bij zaak ====
Regel 120: Regel 120:
 Op het endpoint //base-url//<nowiki>/api/zgw/zaken/api/v1/zaakobjecten/</nowiki> kan een POST worden geplaatst waarmee OpenWave een zaakobject van objecttype //adres// kan aanmaken en koppelen aan een zaak. Op het endpoint //base-url//<nowiki>/api/zgw/zaken/api/v1/zaakobjecten/</nowiki> kan een POST worden geplaatst waarmee OpenWave een zaakobject van objecttype //adres// kan aanmaken en koppelen aan een zaak.
 Bij succes wordt de responsecode 201 geretourneerd met in de body onder meer de uitgetrokken unieke UUID-code voor de combinatie zaak/zaakobject. Bij succes wordt de responsecode 201 geretourneerd met in de body onder meer de uitgetrokken unieke UUID-code voor de combinatie zaak/zaakobject.
-Zie [[stable:applicatiebeheer:probleemoplossing:programmablokken:zgw_open_zaak_api_functionaliteit:creeerzgwzaakobject]].+Zie [[dev:applicatiebeheer:probleemoplossing:programmablokken:zgw_open_zaak_api_functionaliteit:creeerzgwzaakobject]].
  
 ==== Creëer Rol en contactpersoon bij zaak ==== ==== Creëer Rol en contactpersoon bij zaak ====
Regel 126: Regel 126:
 Op het endpoint //base-url//<nowiki>/api/zgw/zaken/api/v1/rollen/</nowiki> kan een POST worden geplaatst waarmee OpenWave een contactpersoon onder een bepaalde rol kan aanmaken. Op het endpoint //base-url//<nowiki>/api/zgw/zaken/api/v1/rollen/</nowiki> kan een POST worden geplaatst waarmee OpenWave een contactpersoon onder een bepaalde rol kan aanmaken.
 Bij succes wordt de responsecode 201 geretourneerd met in de body onder meer de uitgetrokken unieke UUID-code voor de combinatie zaak/rol/contactadres. Bij succes wordt de responsecode 201 geretourneerd met in de body onder meer de uitgetrokken unieke UUID-code voor de combinatie zaak/rol/contactadres.
-Zie [[stable:applicatiebeheer:probleemoplossing:programmablokken:zgw_open_zaak_api_functionaliteit:creeer_zgw_rol]].   +Zie [[dev:applicatiebeheer:probleemoplossing:programmablokken:zgw_open_zaak_api_functionaliteit:creeer_zgw_rol]].   
  
 ==== Maak zaakeigenschap aan bij zaak ==== ==== Maak zaakeigenschap aan bij zaak ====
  
 Op het endpoint //base-url//<nowiki>/api/zgw/zaken/api/v1/zaken/{identifier}/zaakeigenschappen</nowiki> kan een POST worden geplaatst waarmee OpenWave een bepaalde zaakeigenschap kan toevoegen: bijv. een inrichtingsnr op grond waarvan de eerder aangemaakte zaak gekoppeld kan worden aan die inrichting. Op het endpoint //base-url//<nowiki>/api/zgw/zaken/api/v1/zaken/{identifier}/zaakeigenschappen</nowiki> kan een POST worden geplaatst waarmee OpenWave een bepaalde zaakeigenschap kan toevoegen: bijv. een inrichtingsnr op grond waarvan de eerder aangemaakte zaak gekoppeld kan worden aan die inrichting.
-De {identifier} in bovengenoemd endpoint is de UUID die geretourneerd is aan een eerder gecreëerde zaak ([[stable:applicatiebeheer:probleemoplossing:programmablokken:zgw_open_zaak_api_functionaliteit:creeer_zgw_zaak]]).+De {identifier} in bovengenoemd endpoint is de UUID die geretourneerd is aan een eerder gecreëerde zaak ([[dev:applicatiebeheer:probleemoplossing:programmablokken:zgw_open_zaak_api_functionaliteit:creeer_zgw_zaak]]).
 Bij succes wordt de responsecode 201 geretourneerd met in de body onder meer een uitgetrokken fake unieke UUID-code.  Bij succes wordt de responsecode 201 geretourneerd met in de body onder meer een uitgetrokken fake unieke UUID-code. 
 Zie [[.:zgw_open_zaak_api_functionaliteit:maakzgwzaakeigenschap|]]. Zie [[.:zgw_open_zaak_api_functionaliteit:maakzgwzaakeigenschap|]].
Regel 140: Regel 140:
 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.\\  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.\\ 
 Bij succes wordt de responsecode 200 geretourneerd met in de body onder meer de uitgetrokken unieke UUID-code voor de combinatie document/zaak. Bij succes wordt de responsecode 200 geretourneerd met in de body onder meer de uitgetrokken unieke UUID-code voor de combinatie document/zaak.
-Zie [[stable:applicatiebeheer:probleemoplossing:programmablokken:zgw_open_zaak_api_functionaliteit:koppel_zgw_documentaanzaak]].   +Zie [[dev:applicatiebeheer:probleemoplossing:programmablokken:zgw_open_zaak_api_functionaliteit:koppel_zgw_documentaanzaak]].   
  
 ===== GET berichten opvragen informatie over één zaak ===== ===== GET berichten opvragen informatie over één zaak =====
Regel 147: Regel 147:
 ==== Opvragen zaakinformatie ==== ==== Opvragen zaakinformatie ====
 Op het endpoint //base-url//<nowiki>/api/zgw/zaken/api/v1/zaken/{identifier}</nowiki> kan met een GET de zaakinformatie van een specifieke zaak opgehaald worden uit OpenWave. Op het endpoint //base-url//<nowiki>/api/zgw/zaken/api/v1/zaken/{identifier}</nowiki> kan met een GET de zaakinformatie van een specifieke zaak opgehaald worden uit OpenWave.
-De {identifier} in bovengenoemd endpoint (de pathparameter) is de UUID die geretourneerd is aan een eerder gecreëerde zaak ([[stable:applicatiebeheer:probleemoplossing:programmablokken:zgw_open_zaak_api_functionaliteit:creeer_zgw_zaak]]).+De {identifier} in bovengenoemd endpoint (de pathparameter) is de UUID die geretourneerd is aan een eerder gecreëerde zaak ([[dev:applicatiebeheer:probleemoplossing:programmablokken:zgw_open_zaak_api_functionaliteit:creeer_zgw_zaak]]).
 Bij succes wordt de responsecode 200 geretourneerd met in de body de gevraagde zaakinformatie. Bij succes wordt de responsecode 200 geretourneerd met in de body de gevraagde zaakinformatie.
 Zie: [[.:zgw_open_zaak_api_functionaliteit:opvragen_informatievaneenzaak|]]. Zie: [[.:zgw_open_zaak_api_functionaliteit:opvragen_informatievaneenzaak|]].
Regel 159: Regel 159:
 Op het endpoint //base-url//<nowiki>/api/zgw/documenten/api/v1/enkelvoudiginformatieobjecten/</nowiki> kan een POST worden geplaatst met een document dat in het  vervolgbericht //Koppel Document Aan Zaak// aan een zaak wordt gekoppeld. Op het endpoint //base-url//<nowiki>/api/zgw/documenten/api/v1/enkelvoudiginformatieobjecten/</nowiki> kan een POST worden geplaatst met een document dat in het  vervolgbericht //Koppel Document Aan Zaak// aan een zaak wordt gekoppeld.
 Bij succes wordt de responsecode 201 geretourneerd met in de body onder meer de uitgetrokken unieke UUID-code voor het document. Bij succes wordt de responsecode 201 geretourneerd met in de body onder meer de uitgetrokken unieke UUID-code voor het document.
-Zie [[stable:applicatiebeheer:probleemoplossing:programmablokken:zgw_open_zaak_api_functionaliteit:upload_zgw_document]].  +Zie [[dev:applicatiebeheer:probleemoplossing:programmablokken:zgw_open_zaak_api_functionaliteit:upload_zgw_document]].  
    
dev/applicatiebeheer/probleemoplossing/programmablokken/zgw_open_zaak_api_functionaliteit.1784103378.txt.gz · Laatst gewijzigd: door Kars Gottschal