openwave:1.33: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 revisie Vorige revisie
openwave:1.33:applicatiebeheer:probleemoplossing:programmablokken:zgw_open_zaak_api_functionaliteit [2025/11/06 15:09] – [Opvragen zaakinformatie] Ton Pullensopenwave:1.33:applicatiebeheer:probleemoplossing:programmablokken:zgw_open_zaak_api_functionaliteit [2025/11/07 13:38] (huidige) – Lonneke van Dijk
Regel 10: Regel 10:
  
 **Ophalen catalogus-informatie**\\ **Ophalen catalogus-informatie**\\
-Om cataglogus-informatie (meta-informatie cq identifiers over zaaktypen, eigenschapen ,rollen, documenttypes e.d.) op te halen is het volgende berichtenverkeer mogelijk: +Om catalogus-informatie (meta-informatie c.q. identifiers over zaaktypen, eigenschapen, rollen, documenttypes e.d.) op te halen is het volgende berichtenverkeer mogelijk: 
  
 {{:openwave:1.33:applicatiebeheer:probleemoplossing:programmablokken:zgw_openzaak_catalogiberichtenflow.png?800|}} {{:openwave:1.33:applicatiebeheer:probleemoplossing:programmablokken:zgw_openzaak_catalogiberichtenflow.png?800|}}
Regel 73: Regel 73:
 Een token blijft 8 uur bestaan, daarna wordt deze opgeschoond. Van deze 8 uur kan afgeweken worden met //Getal2// van de instelling //Sectie: Logon en Item:  TokenExpireSeconds//. Bij de waarde 0 of kleiner wordt niet opgeschoond. Een token blijft 8 uur bestaan, daarna wordt deze opgeschoond. Van deze 8 uur kan afgeweken worden met //Getal2// van de instelling //Sectie: Logon en Item:  TokenExpireSeconds//. Bij de waarde 0 of kleiner wordt niet opgeschoond.
  
-===== GET berichten ophalen Catalogus-infromatie =====+===== GET berichten ophalen Catalogus-informatie =====
  
-Alle onderstaande  GET berichten moeten in de authorization header voorzien worden van een geldig Bearer JWT token+Alle onderstaande GET berichten moeten in de authorization header voorzien worden van een geldig Bearer JWT token.
  
 ==== Opvragen lijst van zaaktypen ==== ==== Opvragen lijst van zaaktypen ====
Regel 89: Regel 89:
 ==== Opvragen lijst van zaakobjecttypen ==== ==== Opvragen lijst van zaakobjecttypen ====
  
-Op het endpoint //base-url//<nowiki>/api/zgw/catalogi/api/v1/zaakobjecttypen/</nowiki> kan met een GET een lijst opgevraagd kan worden van de benaderbare zaakobjecttypen uit OpenWave. OpenWave ondersteunt vooralsnog alleen de objecttypen //adres// en //medewerker//+Op het endpoint //base-url//<nowiki>/api/zgw/catalogi/api/v1/zaakobjecttypen/</nowiki> kan met een GET een lijst opgevraagd kan worden van de benaderbare zaakobjecttypen uit OpenWave. OpenWave ondersteunt vooralsnog alleen de objecttypen //adres// en //medewerker//.
 Bij succes wordt de responsecode 200 geretourneerd met in de body een geneste array van deze zaakobjecttypes met eigenschappen.\\ Bij succes wordt de responsecode 200 geretourneerd met in de body een geneste array van deze zaakobjecttypes met eigenschappen.\\
 Zie [[.:zgw_open_zaak_api_functionaliteit:opvragen_lijst_met_zaakobjecttypen|]]|. Zie [[.:zgw_open_zaak_api_functionaliteit:opvragen_lijst_met_zaakobjecttypen|]]|.
Regel 102: Regel 102:
 ==== Opvragen lijst van eigenschappen ==== ==== Opvragen lijst van eigenschappen ====
  
-Op het endpoint //base-url//<nowiki>/api/zgw/catalogi/api/v1/eigenschappen/</nowiki> kan met een GET een lijst opgevraagd kan worden van de extra eigenschappen die aan een zaak kunnen worden toegvoegd met de zaaktypes waaraan deze eigenschappen gekoppeld zijn.\\ +Op het endpoint //base-url//<nowiki>/api/zgw/catalogi/api/v1/eigenschappen/</nowiki> kan met een GET een lijst opgevraagd kan worden van de extra eigenschappen die aan een zaak kunnen worden toegevoegd met de zaaktypes waaraan deze eigenschappen gekoppeld zijn.\\ 
-Bij succes wordt de responsecode 200 geretourneerd met in de body een geneste array van deze  eigenschappen. Bijv. om een zaak te kopelen aan een inrichting of om een domein toe te voegen: informatie die niet in de zaakobjecttypen en creeerzaak is opgenomen.\\ +Bij succes wordt de responsecode 200 geretourneerd met in de body een geneste array van deze  eigenschappen. Bijv. om een zaak te koppelen aan een inrichting of om een domein toe te voegen: informatie die niet in de zaakobjecttypen en creeerzaak is opgenomen.\\ 
-Zie [[.:zgw_open_zaak_api_functionaliteit:opvragen_lijst_eigenschappen|]]+Zie [[.:zgw_open_zaak_api_functionaliteit:opvragen_lijst_eigenschappen|]]. 
 + 
 +===== POST berichten creëren /complementeren zaak ===== 
 +Alle onderstaande POST berichten moeten in de authorization header voorzien worden van een geldig Bearer JWT token.
  
-===== POST berichten creeeren /complementeren zaak ===== 
-Alle onderstaande POST berichten moeten in de authorization header voorzien worden van een geldig Bearer JWT token 
 ==== Creëer Nieuwe Zaak ==== ==== Creëer Nieuwe Zaak ====
  
Regel 128: Regel 129:
 ==== 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 gecreeerde zaak ([[openwave:1.33: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 ([[openwave:1.33: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 142: Regel 143:
 ===== GET berichten opvragen informatie over één zaak ===== ===== GET berichten opvragen informatie over één zaak =====
 Alle onderstaande GET berichten moeten in de authorization header voorzien worden van een geldig Bearer JWT token Alle onderstaande GET berichten moeten in de authorization header voorzien worden van een geldig Bearer JWT token
 +
 ==== 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 gecreeerde zaak ([[openwave:1.33: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 ([[openwave:1.33: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|]].
  
  
 ===== Uploaden document ===== ===== Uploaden document =====
 Alle onderstaande POST  berichten moeten in de authorization header voorzien worden van een geldig Bearer JWT token Alle onderstaande POST  berichten moeten in de authorization header voorzien worden van een geldig Bearer JWT token
 +
 ==== Uploaden van een document ==== ==== Uploaden van een document ====
  
  • openwave/1.33/applicatiebeheer/probleemoplossing/programmablokken/zgw_open_zaak_api_functionaliteit.txt
  • Laatst gewijzigd: 2025/11/07 13:38
  • door Lonneke van Dijk