Koppel Document aan Zaak conform OpenZaak API
Op het endpoint base-url/api/zgw/zaken/api/v1/zaakinformatieobjecten/ 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: https://acc.rommeldam.open-wave.nl
Whitelist
De zender die hier een koppeldocumentaanzaak-bericht POST zal gewhitelist moeten worden. Dit kan in de tabellen tbendpointlist en tbipauthorisationlist onder de tegel 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.
Authorisation Token
In de Authorization header van dit POST bericht moet een valide JWT-token worden meegegeven onder Bearer Token. Zie voorbeeld bij Creëer ZGW zaak conform OpenZaak API
Voor het verkrijgen van een token (met beperkte geldigheidsduur!) zie: ZGW OpenZaak API Functionaliteit
De token wordt opgezocht in de tabel tbaccesstoken en het tijdstip van aanvraag wordt getoetst aan de geldigheidsduur van de gevonden rij.
(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
Headers
De enige verplichte header variabele is: Content-Type met als waarde application/json
Body
In application/json.
voorbeeld
{
"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"
}
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
In principe leidt de inhoud van de body tot het opslaan van het aangeleverde document op de uploadmap van OpenWave (zie de kolom Tekst van de instelling Sectie: OWB en Item: TussenMapUploadFiles). OpenWave weet nog niet bij welke zaak dit document hoort, die informatie komt pas in het vervolgbericht. Wel wordt alvast een unieke UUID uitgetrokken voor dit document die terug gecommuniceerd wordt aan de zender. De eerste posities van de documentnaam op de uploadmap beginnen met deze UUID-code. Deze metadata worden opgeslagen in de tabel tbupload onder de uitgetrokken UUID. Dit, mits aan de nodige voorwaarden in de OpenWave implementatie is voldaan:
- Er moet tenminste één valide kaart zijn in de OpenWave documenttype tabel (tbdocumenttype) met een gevulde unieke UUID-code in de kolom dvzgwuuid die gelijk is aan de waarde (een UUID-code) vanaf de laatste slash van item informatieobjecttype.
- De robotmedewerker die verbonden is aan de uitgereikte token moet gekoppeld zijn aan de rechtengroep die het functionele recht tbomgrechten.dlbomgins (insertrecht op de omgevingstabel) aangevinkt heeft staan.
Het document wordt ontbased64 opgeslagen op uploadmap van OpenWave. Dit gebeurt onder de samengestelde naam van de op dat moment - door OpenWave - uitgetrokken UUID-code plus een underscore plus de inhoud van item bestandsnaam (indien het item bestandsnaam niet bestaat of leeg is, dan wordt de inhoud van item titel gebruikt).
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.
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
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"
}