openapi: 3.0.0 info: title: Documenten API description: "Een API om een documentregistratiecomponent (DRC) te benaderen.\n\n\ In een documentregistratiecomponent worden INFORMATIEOBJECTen opgeslagen. Een\n\ INFORMATIEOBJECT is een digitaal document voorzien van meta-gegevens.\nINFORMATIEOBJECTen\ \ kunnen aan andere objecten zoals zaken en besluiten worden\ngerelateerd (maar\ \ dat hoeft niet) en kunnen gebruiksrechten hebben.\n\nGEBRUIKSRECHTEN leggen\ \ voorwaarden op aan het gebruik van het INFORMATIEOBJECT\n(buiten raadpleging).\ \ Deze GEBRUIKSRECHTEN worden niet door de API gevalideerd\nof gehandhaafd.\n\n\ De typering van INFORMATIEOBJECTen is in de Catalogi API (ZTC) ondergebracht in\n\ de vorm van INFORMATIEOBJECTTYPEn.\n\n**Uploaden van bestanden**\n\nBinnen deze\ \ API bestaan een aantal endpoints die binaire data ontvangen, al\ndan niet base64-encoded.\ \ Webservers moeten op deze endpoints een minimale\nrequest body size van 4.0\ \ GiB ondersteunen. Dit omvat de JSON van de\nmetadata EN de base64-encoded bestandsdata.\ \ Hou hierbij rekening met de\noverhead van base64, die ongeveer 33% bedraagt\ \ in worst-case scenario's. Dit\nbetekent dat bij een limiet van 4GB het bestand\ \ maximaal ongeveer 3GB groot\nmag zijn.\n\n**Afhankelijkheden**\n\nDeze API is\ \ afhankelijk van:\n\n* Catalogi API\n* Notificaties API\n* Autorisaties API *(optioneel)*\n\ * Zaken API *(optioneel)*\n\n**Autorisatie**\n\nDeze API vereist autorisatie.\ \ Je kan de\n[token-tool](https://zaken-auth.vng.cloud/) gebruiken om JWT-tokens\ \ te\ngenereren.\n\n### Notificaties\n\nDeze API publiceert notificaties op het\ \ kanaal `documenten`.\n\n**Main resource**\n\n`enkelvoudiginformatieobject`\n\ \n\n\n**Kenmerken**\n\n* `bronorganisatie`: Het RSIN van de Niet-natuurlijk persoon\ \ zijnde de organisatie die het informatieobject heeft gecre\xEBerd of heeft ontvangen\ \ en als eerste in een samenwerkingsketen heeft vastgelegd.\n* `informatieobjecttype`:\ \ URL-referentie naar het INFORMATIEOBJECTTYPE (in de Catalogi API).\n* `vertrouwelijkheidaanduiding`:\ \ Aanduiding van de mate waarin het INFORMATIEOBJECT voor de openbaarheid bestemd\ \ is.\n\n**Resources en acties**\n\n\n**Handige links**\n\n* [Documentatie](https://vng-realisatie.github.io/gemma-zaken/standaard)\n\ * [Zaakgericht werken](https://vng-realisatie.github.io/gemma-zaken)\n" contact: url: https://vng-realisatie.github.io/gemma-zaken email: standaarden.ondersteuning@vng.nl license: name: EUPL 1.2 url: https://opensource.org/licenses/EUPL-1.2 version: 1.0.1 security: - JWT-Claims: [] paths: /enkelvoudiginformatieobjecten: get: operationId: enkelvoudiginformatieobject_list summary: Alle (ENKELVOUDIGe) INFORMATIEOBJECTen opvragen. description: 'Deze lijst kan gefilterd wordt met query-string parameters. De objecten bevatten metadata over de documenten en de downloadlink (`inhoud`) naar de binary data. Alleen de laatste versie van elk (ENKELVOUDIG) INFORMATIEOBJECT wordt getoond. Specifieke versies kunnen alleen' parameters: - name: identificatie in: query description: Een binnen een gegeven context ondubbelzinnige referentie naar het INFORMATIEOBJECT. required: false schema: type: string - name: bronorganisatie in: query description: "Het RSIN van de Niet-natuurlijk persoon zijnde de organisatie\ \ die het informatieobject heeft gecre\xEBerd of heeft ontvangen en als\ \ eerste in een samenwerkingsketen heeft vastgelegd." required: false schema: type: string - name: page in: query description: Een pagina binnen de gepagineerde set resultaten. required: false schema: type: integer responses: '200': description: OK headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: schema: required: - count - results type: object properties: count: type: integer next: type: string format: uri nullable: true previous: type: string format: uri nullable: true results: type: array items: $ref: '#/components/schemas/EnkelvoudigInformatieObject' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '406': $ref: '#/components/responses/406' '409': $ref: '#/components/responses/409' '410': $ref: '#/components/responses/410' '415': $ref: '#/components/responses/415' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' tags: - enkelvoudiginformatieobjecten security: - JWT-Claims: - documenten.lezen post: operationId: enkelvoudiginformatieobject_create summary: Maak een (ENKELVOUDIG) INFORMATIEOBJECT aan. description: "**Er wordt gevalideerd op**\n- geldigheid `informatieobjecttype`\ \ URL - de resource moet opgevraagd kunnen\n worden uit de catalogi API en\ \ de vorm van een INFORMATIEOBJECTTYPE hebben.\n- publicatie `informatieobjecttype`\ \ - `concept` moet `false` zijn" parameters: - name: X-NLX-Logrecord-ID in: header description: Identifier of the request, traceable throughout the network required: false schema: type: string - name: X-Audit-Toelichting in: header description: Toelichting waarom een bepaald verzoek wordt gedaan required: false schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/EnkelvoudigInformatieObjectData' required: true responses: '201': description: Created headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' Location: schema: type: string format: uri description: URL waar de resource leeft. content: application/json: schema: $ref: '#/components/schemas/EnkelvoudigInformatieObjectData' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '406': $ref: '#/components/responses/406' '409': $ref: '#/components/responses/409' '410': $ref: '#/components/responses/410' '413': description: Request entity too large headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: schema: $ref: '#/components/schemas/Fout' '415': $ref: '#/components/responses/415' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' tags: - enkelvoudiginformatieobjecten security: - JWT-Claims: - documenten.aanmaken parameters: [] /enkelvoudiginformatieobjecten/{enkelvoudiginformatieobject_uuid}/audittrail: get: operationId: audittrail_list summary: Alle audit trail regels behorend bij het INFORMATIEOBJECT. description: Alle audit trail regels behorend bij het INFORMATIEOBJECT. responses: '200': description: OK headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: schema: type: array items: $ref: '#/components/schemas/AuditTrail' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '406': $ref: '#/components/responses/406' '409': $ref: '#/components/responses/409' '410': $ref: '#/components/responses/410' '415': $ref: '#/components/responses/415' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' tags: - enkelvoudiginformatieobjecten security: - JWT-Claims: - audittrails.lezen parameters: - name: enkelvoudiginformatieobject_uuid in: path required: true description: Unieke resource identifier (UUID4) schema: type: string format: uuid /enkelvoudiginformatieobjecten/{enkelvoudiginformatieobject_uuid}/audittrail/{uuid}: get: operationId: audittrail_read summary: Een specifieke audit trail regel opvragen. description: Een specifieke audit trail regel opvragen. responses: '200': description: OK headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: schema: $ref: '#/components/schemas/AuditTrail' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '406': $ref: '#/components/responses/406' '409': $ref: '#/components/responses/409' '410': $ref: '#/components/responses/410' '415': $ref: '#/components/responses/415' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' tags: - enkelvoudiginformatieobjecten security: - JWT-Claims: - audittrails.lezen parameters: - name: enkelvoudiginformatieobject_uuid in: path required: true description: Unieke resource identifier (UUID4) schema: type: string format: uuid - name: uuid in: path description: Unieke identificatie van de audit regel. required: true schema: type: string format: uuid /enkelvoudiginformatieobjecten/{uuid}: get: operationId: enkelvoudiginformatieobject_read summary: Een specifiek (ENKELVOUDIG) INFORMATIEOBJECT opvragen. description: 'Het object bevat metadata over het document en de downloadlink (`inhoud`) naar de binary data. Dit geeft standaard de laatste versie van het (ENKELVOUDIG) INFORMATIEOBJECT. Specifieke versies kunnen middels query-string parameters worden opgevraagd.' parameters: - name: versie in: query description: Het (automatische) versienummer van het INFORMATIEOBJECT. schema: type: integer - name: registratieOp in: query description: Een datumtijd in ISO8601 formaat. De versie van het INFORMATIEOBJECT die qua `begin_registratie` het kortst hiervoor zit wordt opgehaald. schema: type: string responses: '200': description: OK headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: schema: $ref: '#/components/schemas/EnkelvoudigInformatieObject' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '406': $ref: '#/components/responses/406' '409': $ref: '#/components/responses/409' '410': $ref: '#/components/responses/410' '415': $ref: '#/components/responses/415' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' tags: - enkelvoudiginformatieobjecten security: - JWT-Claims: - documenten.lezen put: operationId: enkelvoudiginformatieobject_update summary: Werk een (ENKELVOUDIG) INFORMATIEOBJECT in zijn geheel bij. description: "Dit cre\xEBert altijd een nieuwe versie van het (ENKELVOUDIG)\ \ INFORMATIEOBJECT.\n\n**Er wordt gevalideerd op**\n- correcte `lock` waarde\n\ - het `informatieobjecttype` mag niet gewijzigd worden\n- status NIET `definitief`" parameters: - name: X-NLX-Logrecord-ID in: header description: Identifier of the request, traceable throughout the network required: false schema: type: string - name: X-Audit-Toelichting in: header description: Toelichting waarom een bepaald verzoek wordt gedaan required: false schema: type: string requestBody: $ref: '#/components/requestBodies/EnkelvoudigInformatieObjectWithLockData' responses: '200': description: OK headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: schema: $ref: '#/components/schemas/EnkelvoudigInformatieObjectWithLockData' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '406': $ref: '#/components/responses/406' '409': $ref: '#/components/responses/409' '410': $ref: '#/components/responses/410' '413': description: Request entity too large headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: schema: $ref: '#/components/schemas/Fout' '415': $ref: '#/components/responses/415' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' tags: - enkelvoudiginformatieobjecten security: - JWT-Claims: - documenten.bijwerken patch: operationId: enkelvoudiginformatieobject_partial_update summary: Werk een (ENKELVOUDIG) INFORMATIEOBJECT deels bij. description: "Dit cre\xEBert altijd een nieuwe versie van het (ENKELVOUDIG)\ \ INFORMATIEOBJECT.\n\n**Er wordt gevalideerd op**\n- correcte `lock` waarde\n\ - het `informatieobjecttype` mag niet gewijzigd worden\n- status NIET `definitief`" parameters: - name: X-NLX-Logrecord-ID in: header description: Identifier of the request, traceable throughout the network required: false schema: type: string - name: X-Audit-Toelichting in: header description: Toelichting waarom een bepaald verzoek wordt gedaan required: false schema: type: string requestBody: $ref: '#/components/requestBodies/EnkelvoudigInformatieObjectWithLockData' responses: '200': description: OK headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: schema: $ref: '#/components/schemas/EnkelvoudigInformatieObjectWithLockData' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '406': $ref: '#/components/responses/406' '409': $ref: '#/components/responses/409' '410': $ref: '#/components/responses/410' '413': description: Request entity too large headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: schema: $ref: '#/components/schemas/Fout' '415': $ref: '#/components/responses/415' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' tags: - enkelvoudiginformatieobjecten security: - JWT-Claims: - documenten.bijwerken delete: operationId: enkelvoudiginformatieobject_delete summary: Verwijder een (ENKELVOUDIG) INFORMATIEOBJECT. description: 'Verwijder een (ENKELVOUDIG) INFORMATIEOBJECT en alle bijbehorende versies, samen met alle gerelateerde resources binnen deze API. Dit is alleen mogelijk als er geen OBJECTINFORMATIEOBJECTen relateerd zijn aan het (ENKELVOUDIG) INFORMATIEOBJECT. **Gerelateerde resources** - GEBRUIKSRECHTen - audit trail regels' parameters: - name: X-NLX-Logrecord-ID in: header description: Identifier of the request, traceable throughout the network required: false schema: type: string - name: X-Audit-Toelichting in: header description: Toelichting waarom een bepaald verzoek wordt gedaan required: false schema: type: string responses: '204': description: No content headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '406': $ref: '#/components/responses/406' '409': $ref: '#/components/responses/409' '410': $ref: '#/components/responses/410' '415': $ref: '#/components/responses/415' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' tags: - enkelvoudiginformatieobjecten security: - JWT-Claims: - documenten.verwijderen parameters: - name: uuid in: path description: Unieke resource identifier (UUID4) required: true schema: type: string format: uuid /enkelvoudiginformatieobjecten/{uuid}/download: get: operationId: enkelvoudiginformatieobject_download summary: Download de binaire data van het (ENKELVOUDIG) INFORMATIEOBJECT. description: Download de binaire data van het (ENKELVOUDIG) INFORMATIEOBJECT. parameters: - name: versie in: query description: Het (automatische) versienummer van het INFORMATIEOBJECT. schema: type: integer - name: registratieOp in: query description: Een datumtijd in ISO8601 formaat. De versie van het INFORMATIEOBJECT die qua `begin_registratie` het kortst hiervoor zit wordt opgehaald. schema: type: string responses: '200': description: De binaire bestandsinhoud headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/octet-stream: schema: type: string format: binary '401': description: Unauthorized headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/octet-stream: schema: $ref: '#/components/schemas/Fout' '403': description: Forbidden headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/octet-stream: schema: $ref: '#/components/schemas/Fout' '404': description: Not found headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/octet-stream: schema: $ref: '#/components/schemas/Fout' '406': description: Not acceptable headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/octet-stream: schema: $ref: '#/components/schemas/Fout' '410': description: Gone headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/octet-stream: schema: $ref: '#/components/schemas/Fout' '415': description: Unsupported media type headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/octet-stream: schema: $ref: '#/components/schemas/Fout' '429': description: Throttled headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/octet-stream: schema: $ref: '#/components/schemas/Fout' '500': description: Internal server error headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/octet-stream: schema: $ref: '#/components/schemas/Fout' tags: - enkelvoudiginformatieobjecten security: - JWT-Claims: - documenten.lezen parameters: - name: uuid in: path description: Unieke resource identifier (UUID4) required: true schema: type: string format: uuid /enkelvoudiginformatieobjecten/{uuid}/lock: post: operationId: enkelvoudiginformatieobject_lock summary: Vergrendel een (ENKELVOUDIG) INFORMATIEOBJECT. description: 'Voert een "checkout" uit waardoor het (ENKELVOUDIG) INFORMATIEOBJECT vergrendeld wordt met een `lock` waarde. Alleen met deze waarde kan het (ENKELVOUDIG) INFORMATIEOBJECT bijgewerkt (`PUT`, `PATCH`) en weer ontgrendeld worden.' requestBody: content: application/json: schema: $ref: '#/components/schemas/LockEnkelvoudigInformatieObject' required: true responses: '200': description: '' headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: schema: $ref: '#/components/schemas/LockEnkelvoudigInformatieObject' '400': description: Bad request headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: schema: $ref: '#/components/schemas/Fout' '401': description: Unauthorized headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: schema: $ref: '#/components/schemas/Fout' '403': description: Forbidden headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: schema: $ref: '#/components/schemas/Fout' '404': description: Not found headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: schema: $ref: '#/components/schemas/Fout' '406': description: Not acceptable headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: schema: $ref: '#/components/schemas/Fout' '410': description: Gone headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: schema: $ref: '#/components/schemas/Fout' '415': description: Unsupported media type headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: schema: $ref: '#/components/schemas/Fout' '429': description: Throttled headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: schema: $ref: '#/components/schemas/Fout' '500': description: Internal server error headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: schema: $ref: '#/components/schemas/Fout' tags: - enkelvoudiginformatieobjecten security: - JWT-Claims: - documenten.lock parameters: - name: uuid in: path description: Unieke resource identifier (UUID4) required: true schema: type: string format: uuid /enkelvoudiginformatieobjecten/{uuid}/unlock: post: operationId: enkelvoudiginformatieobject_unlock summary: Ontgrendel een (ENKELVOUDIG) INFORMATIEOBJECT. description: 'Heft de "checkout" op waardoor het (ENKELVOUDIG) INFORMATIEOBJECT ontgrendeld wordt.' requestBody: content: application/json: schema: $ref: '#/components/schemas/UnlockEnkelvoudigInformatieObject' required: true responses: '204': description: No content headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' '400': description: Bad request headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: schema: $ref: '#/components/schemas/Fout' '401': description: Unauthorized headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: schema: $ref: '#/components/schemas/Fout' '403': description: Forbidden headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: schema: $ref: '#/components/schemas/Fout' '404': description: Not found headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: schema: $ref: '#/components/schemas/Fout' '406': description: Not acceptable headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: schema: $ref: '#/components/schemas/Fout' '410': description: Gone headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: schema: $ref: '#/components/schemas/Fout' '415': description: Unsupported media type headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: schema: $ref: '#/components/schemas/Fout' '429': description: Throttled headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: schema: $ref: '#/components/schemas/Fout' '500': description: Internal server error headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: schema: $ref: '#/components/schemas/Fout' tags: - enkelvoudiginformatieobjecten security: - JWT-Claims: - (documenten.lock | documenten.geforceerd-unlock) parameters: - name: uuid in: path description: Unieke resource identifier (UUID4) required: true schema: type: string format: uuid /gebruiksrechten: get: operationId: gebruiksrechten_list summary: Alle GEBRUIKSRECHTen opvragen. description: Deze lijst kan gefilterd wordt met query-string parameters. parameters: - name: informatieobject in: query description: URL-referentie naar het INFORMATIEOBJECT. required: false schema: type: string format: uri - name: startdatum__lt in: query description: Begindatum van de periode waarin de gebruiksrechtvoorwaarden van toepassing zijn. Doorgaans is de datum van creatie van het informatieobject de startdatum. required: false schema: type: string - name: startdatum__lte in: query description: Begindatum van de periode waarin de gebruiksrechtvoorwaarden van toepassing zijn. Doorgaans is de datum van creatie van het informatieobject de startdatum. required: false schema: type: string - name: startdatum__gt in: query description: Begindatum van de periode waarin de gebruiksrechtvoorwaarden van toepassing zijn. Doorgaans is de datum van creatie van het informatieobject de startdatum. required: false schema: type: string - name: startdatum__gte in: query description: Begindatum van de periode waarin de gebruiksrechtvoorwaarden van toepassing zijn. Doorgaans is de datum van creatie van het informatieobject de startdatum. required: false schema: type: string - name: einddatum__lt in: query description: Einddatum van de periode waarin de gebruiksrechtvoorwaarden van toepassing zijn. required: false schema: type: string - name: einddatum__lte in: query description: Einddatum van de periode waarin de gebruiksrechtvoorwaarden van toepassing zijn. required: false schema: type: string - name: einddatum__gt in: query description: Einddatum van de periode waarin de gebruiksrechtvoorwaarden van toepassing zijn. required: false schema: type: string - name: einddatum__gte in: query description: Einddatum van de periode waarin de gebruiksrechtvoorwaarden van toepassing zijn. required: false schema: type: string responses: '200': description: OK headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: schema: type: array items: $ref: '#/components/schemas/Gebruiksrechten' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '406': $ref: '#/components/responses/406' '409': $ref: '#/components/responses/409' '410': $ref: '#/components/responses/410' '415': $ref: '#/components/responses/415' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' tags: - gebruiksrechten security: - JWT-Claims: - documenten.lezen post: operationId: gebruiksrechten_create summary: Maak een GEBRUIKSRECHT aan. description: "Voeg GEBRUIKSRECHTen toe voor een INFORMATIEOBJECT.\n\n**Opmerkingen**\n\ \ - Het toevoegen van gebruiksrechten zorgt ervoor dat de\n `indicatieGebruiksrecht`\ \ op het informatieobject op `true` gezet wordt." parameters: - name: X-NLX-Logrecord-ID in: header description: Identifier of the request, traceable throughout the network required: false schema: type: string - name: X-Audit-Toelichting in: header description: Toelichting waarom een bepaald verzoek wordt gedaan required: false schema: type: string requestBody: $ref: '#/components/requestBodies/Gebruiksrechten' responses: '201': description: Created headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' Location: schema: type: string format: uri description: URL waar de resource leeft. content: application/json: schema: $ref: '#/components/schemas/Gebruiksrechten' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '406': $ref: '#/components/responses/406' '409': $ref: '#/components/responses/409' '410': $ref: '#/components/responses/410' '415': $ref: '#/components/responses/415' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' tags: - gebruiksrechten security: - JWT-Claims: - documenten.aanmaken parameters: [] /gebruiksrechten/{uuid}: get: operationId: gebruiksrechten_read summary: Een specifieke GEBRUIKSRECHT opvragen. description: Een specifieke GEBRUIKSRECHT opvragen. responses: '200': description: OK headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: schema: $ref: '#/components/schemas/Gebruiksrechten' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '406': $ref: '#/components/responses/406' '409': $ref: '#/components/responses/409' '410': $ref: '#/components/responses/410' '415': $ref: '#/components/responses/415' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' tags: - gebruiksrechten security: - JWT-Claims: - documenten.lezen put: operationId: gebruiksrechten_update summary: Werk een GEBRUIKSRECHT in zijn geheel bij. description: Werk een GEBRUIKSRECHT in zijn geheel bij. parameters: - name: X-NLX-Logrecord-ID in: header description: Identifier of the request, traceable throughout the network required: false schema: type: string - name: X-Audit-Toelichting in: header description: Toelichting waarom een bepaald verzoek wordt gedaan required: false schema: type: string requestBody: $ref: '#/components/requestBodies/Gebruiksrechten' responses: '200': description: OK headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: schema: $ref: '#/components/schemas/Gebruiksrechten' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '406': $ref: '#/components/responses/406' '409': $ref: '#/components/responses/409' '410': $ref: '#/components/responses/410' '415': $ref: '#/components/responses/415' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' tags: - gebruiksrechten security: - JWT-Claims: - documenten.bijwerken patch: operationId: gebruiksrechten_partial_update summary: Werk een GEBRUIKSRECHT relatie deels bij. description: Werk een GEBRUIKSRECHT relatie deels bij. parameters: - name: X-NLX-Logrecord-ID in: header description: Identifier of the request, traceable throughout the network required: false schema: type: string - name: X-Audit-Toelichting in: header description: Toelichting waarom een bepaald verzoek wordt gedaan required: false schema: type: string requestBody: $ref: '#/components/requestBodies/Gebruiksrechten' responses: '200': description: OK headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: schema: $ref: '#/components/schemas/Gebruiksrechten' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '406': $ref: '#/components/responses/406' '409': $ref: '#/components/responses/409' '410': $ref: '#/components/responses/410' '415': $ref: '#/components/responses/415' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' tags: - gebruiksrechten security: - JWT-Claims: - documenten.bijwerken delete: operationId: gebruiksrechten_delete summary: Verwijder een GEBRUIKSRECHT. description: "**Opmerkingen**\n - Indien het laatste GEBRUIKSRECHT van een\ \ INFORMATIEOBJECT verwijderd\n wordt, dan wordt de `indicatieGebruiksrecht`\ \ van het INFORMATIEOBJECT op\n `null` gezet." parameters: - name: X-NLX-Logrecord-ID in: header description: Identifier of the request, traceable throughout the network required: false schema: type: string - name: X-Audit-Toelichting in: header description: Toelichting waarom een bepaald verzoek wordt gedaan required: false schema: type: string responses: '204': description: No content headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '406': $ref: '#/components/responses/406' '409': $ref: '#/components/responses/409' '410': $ref: '#/components/responses/410' '415': $ref: '#/components/responses/415' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' tags: - gebruiksrechten security: - JWT-Claims: - documenten.verwijderen parameters: - name: uuid in: path description: Unieke resource identifier (UUID4) required: true schema: type: string format: uuid /objectinformatieobjecten: get: operationId: objectinformatieobject_list summary: Alle OBJECT-INFORMATIEOBJECT relaties opvragen. description: Deze lijst kan gefilterd wordt met query-string parameters. parameters: - name: object in: query description: URL-referentie naar het gerelateerde OBJECT (in deze of een andere API). required: false schema: type: string format: uri - name: informatieobject in: query description: URL-referentie naar het INFORMATIEOBJECT. required: false schema: type: string format: uri responses: '200': description: OK headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: schema: type: array items: $ref: '#/components/schemas/ObjectInformatieObject' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '406': $ref: '#/components/responses/406' '409': $ref: '#/components/responses/409' '410': $ref: '#/components/responses/410' '415': $ref: '#/components/responses/415' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' tags: - objectinformatieobjecten security: - JWT-Claims: - documenten.lezen post: operationId: objectinformatieobject_create summary: Maak een OBJECT-INFORMATIEOBJECT relatie aan. description: '**LET OP: Dit endpoint hoor je als consumer niet zelf aan te spreken.** Andere API''s, zoals de Zaken API en de Besluiten API, gebruiken dit endpoint bij het synchroniseren van relaties. **Er wordt gevalideerd op** - geldigheid `informatieobject` URL - de combinatie `informatieobject` en `object` moet uniek zijn - bestaan van `object` URL' requestBody: content: application/json: schema: $ref: '#/components/schemas/ObjectInformatieObject' required: true responses: '201': description: Created headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' Location: schema: type: string format: uri description: URL waar de resource leeft. content: application/json: schema: $ref: '#/components/schemas/ObjectInformatieObject' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '406': $ref: '#/components/responses/406' '409': $ref: '#/components/responses/409' '410': $ref: '#/components/responses/410' '415': $ref: '#/components/responses/415' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' tags: - objectinformatieobjecten security: - JWT-Claims: - documenten.aanmaken parameters: [] /objectinformatieobjecten/{uuid}: get: operationId: objectinformatieobject_read summary: Een specifieke OBJECT-INFORMATIEOBJECT relatie opvragen. description: Een specifieke OBJECT-INFORMATIEOBJECT relatie opvragen. responses: '200': description: OK headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: schema: $ref: '#/components/schemas/ObjectInformatieObject' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '406': $ref: '#/components/responses/406' '409': $ref: '#/components/responses/409' '410': $ref: '#/components/responses/410' '415': $ref: '#/components/responses/415' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' tags: - objectinformatieobjecten security: - JWT-Claims: - documenten.lezen delete: operationId: objectinformatieobject_delete summary: Verwijder een OBJECT-INFORMATIEOBJECT relatie. description: '**LET OP: Dit endpoint hoor je als consumer niet zelf aan te spreken.** Andere API''s, zoals de Zaken API en de Besluiten API, gebruiken dit endpoint bij het synchroniseren van relaties.' responses: '204': description: No content headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '406': $ref: '#/components/responses/406' '409': $ref: '#/components/responses/409' '410': $ref: '#/components/responses/410' '415': $ref: '#/components/responses/415' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' tags: - objectinformatieobjecten security: - JWT-Claims: - documenten.verwijderen parameters: - name: uuid in: path description: Unieke resource identifier (UUID4) required: true schema: type: string format: uuid servers: - url: /api/v1 components: responses: '400': description: Bad request headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/ValidatieFout' '401': description: Unauthorized headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' '403': description: Forbidden headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' '404': description: Not found headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' '406': description: Not acceptable headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' '409': description: Conflict headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' '410': description: Gone headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' '412': description: Precondition failed headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' '415': description: Unsupported media type headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' '429': description: Too many requests headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' '500': description: Internal server error headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' requestBodies: EnkelvoudigInformatieObjectWithLockData: content: application/json: schema: $ref: '#/components/schemas/EnkelvoudigInformatieObjectWithLockData' required: true Gebruiksrechten: content: application/json: schema: $ref: '#/components/schemas/Gebruiksrechten' required: true securitySchemes: JWT-Claims: bearerFormat: JWT scheme: bearer type: http schemas: Ondertekening: title: ondertekening description: Aanduiding van de rechtskracht van een informatieobject. Mag niet van een waarde zijn voorzien als de `status` de waarde 'in bewerking' of 'ter vaststelling' heeft. required: - soort - datum type: object properties: soort: title: Ondertekeningsoort description: 'Aanduiding van de wijze van ondertekening van het INFORMATIEOBJECT Uitleg bij mogelijke waarden: * `analoog` - Analoog * `digitaal` - Digitaal * `pki` - PKI' type: string enum: - analoog - digitaal - pki datum: title: Ondertekeningdatum description: De datum waarop de ondertekening van het INFORMATIEOBJECT heeft plaatsgevonden. type: string format: date nullable: true Integriteit: title: integriteit description: Uitdrukking van mate van volledigheid en onbeschadigd zijn van digitaal bestand. required: - algoritme - waarde - datum type: object properties: algoritme: title: Algoritme description: 'Aanduiding van algoritme, gebruikt om de checksum te maken. Uitleg bij mogelijke waarden: * `crc_16` - CRC-16 * `crc_32` - CRC-32 * `crc_64` - CRC-64 * `fletcher_4` - Fletcher-4 * `fletcher_8` - Fletcher-8 * `fletcher_16` - Fletcher-16 * `fletcher_32` - Fletcher-32 * `hmac` - HMAC * `md5` - MD5 * `sha_1` - SHA-1 * `sha_256` - SHA-256 * `sha_512` - SHA-512 * `sha_3` - SHA-3' type: string enum: - crc_16 - crc_32 - crc_64 - fletcher_4 - fletcher_8 - fletcher_16 - fletcher_32 - hmac - md5 - sha_1 - sha_256 - sha_512 - sha_3 waarde: title: Waarde description: De waarde van de checksum. type: string maxLength: 128 minLength: 1 datum: title: Datum description: Datum waarop de checksum is gemaakt. type: string format: date nullable: true EnkelvoudigInformatieObject: required: - bronorganisatie - creatiedatum - titel - auteur - taal - informatieobjecttype type: object properties: url: title: Url description: URL-referentie naar dit object. Dit is de unieke identificatie en locatie van dit object. type: string format: uri readOnly: true maxLength: 1000 minLength: 1 identificatie: title: Identificatie description: Een binnen een gegeven context ondubbelzinnige referentie naar het INFORMATIEOBJECT. type: string maxLength: 40 bronorganisatie: title: Bronorganisatie description: "Het RSIN van de Niet-natuurlijk persoon zijnde de organisatie\ \ die het informatieobject heeft gecre\xEBerd of heeft ontvangen en als\ \ eerste in een samenwerkingsketen heeft vastgelegd." type: string maxLength: 9 minLength: 1 creatiedatum: title: Creatiedatum description: Een datum of een gebeurtenis in de levenscyclus van het INFORMATIEOBJECT. type: string format: date titel: title: Titel description: De naam waaronder het INFORMATIEOBJECT formeel bekend is. type: string maxLength: 200 minLength: 1 vertrouwelijkheidaanduiding: title: Vertrouwelijkheidaanduiding description: 'Aanduiding van de mate waarin het INFORMATIEOBJECT voor de openbaarheid bestemd is. Uitleg bij mogelijke waarden: * `openbaar` - Openbaar * `beperkt_openbaar` - Beperkt openbaar * `intern` - Intern * `zaakvertrouwelijk` - Zaakvertrouwelijk * `vertrouwelijk` - Vertrouwelijk * `confidentieel` - Confidentieel * `geheim` - Geheim * `zeer_geheim` - Zeer geheim' type: string enum: - openbaar - beperkt_openbaar - intern - zaakvertrouwelijk - vertrouwelijk - confidentieel - geheim - zeer_geheim auteur: title: Auteur description: "De persoon of organisatie die in de eerste plaats verantwoordelijk\ \ is voor het cre\xEBren van de inhoud van het INFORMATIEOBJECT." type: string maxLength: 200 minLength: 1 status: title: Status description: 'Aanduiding van de stand van zaken van een INFORMATIEOBJECT. De waarden ''in bewerking'' en ''ter vaststelling'' komen niet voor als het attribuut `ontvangstdatum` van een waarde is voorzien. Wijziging van de Status in ''gearchiveerd'' impliceert dat het informatieobject een duurzaam, niet-wijzigbaar Formaat dient te hebben. Uitleg bij mogelijke waarden: * `in_bewerking` - (In bewerking) Aan het informatieobject wordt nog gewerkt. * `ter_vaststelling` - (Ter vaststelling) Informatieobject gereed maar moet nog vastgesteld worden. * `definitief` - (Definitief) Informatieobject door bevoegd iets of iemand vastgesteld dan wel ontvangen. * `gearchiveerd` - (Gearchiveerd) Informatieobject duurzaam bewaarbaar gemaakt; een gearchiveerd informatie-element.' type: string enum: - in_bewerking - ter_vaststelling - definitief - gearchiveerd formaat: title: Formaat description: 'Het "Media Type" (voorheen "MIME type") voor de wijze waaropde inhoud van het INFORMATIEOBJECT is vastgelegd in een computerbestand. Voorbeeld: `application/msword`. Zie: https://www.iana.org/assignments/media-types/media-types.xhtml' type: string maxLength: 255 taal: title: Taal description: 'Een ISO 639-2/B taalcode waarin de inhoud van het INFORMATIEOBJECT is vastgelegd. Voorbeeld: `nld`. Zie: https://www.iso.org/standard/4767.html' type: string maxLength: 3 minLength: 3 versie: title: Versie description: Het (automatische) versienummer van het INFORMATIEOBJECT. Deze begint bij 1 als het INFORMATIEOBJECT aangemaakt wordt. type: integer readOnly: true beginRegistratie: title: Begin registratie description: Een datumtijd in ISO8601 formaat waarop deze versie van het INFORMATIEOBJECT is aangemaakt of gewijzigd. type: string format: date-time readOnly: true bestandsnaam: title: Bestandsnaam description: De naam van het fysieke bestand waarin de inhoud van het informatieobject is vastgelegd, inclusief extensie. type: string maxLength: 255 inhoud: title: Inhoud description: Download URL van de binaire inhoud. type: string format: uri readOnly: true bestandsomvang: title: Bestandsomvang description: Aantal bytes dat de inhoud van INFORMATIEOBJECT in beslag neemt. type: integer readOnly: true minimum: 0 link: title: Link description: De URL waarmee de inhoud van het INFORMATIEOBJECT op te vragen is. type: string format: uri maxLength: 200 beschrijving: title: Beschrijving description: Een generieke beschrijving van de inhoud van het INFORMATIEOBJECT. type: string maxLength: 1000 ontvangstdatum: title: Ontvangstdatum description: De datum waarop het INFORMATIEOBJECT ontvangen is. Verplicht te registreren voor INFORMATIEOBJECTen die van buiten de zaakbehandelende organisatie(s) ontvangen zijn. Ontvangst en verzending is voorbehouden aan documenten die van of naar andere personen ontvangen of verzonden zijn waarbij die personen niet deel uit maken van de behandeling van de zaak waarin het document een rol speelt. type: string format: date nullable: true verzenddatum: title: Verzenddatum description: De datum waarop het INFORMATIEOBJECT verzonden is, zoals deze op het INFORMATIEOBJECT vermeld is. Dit geldt voor zowel inkomende als uitgaande INFORMATIEOBJECTen. Eenzelfde informatieobject kan niet tegelijk inkomend en uitgaand zijn. Ontvangst en verzending is voorbehouden aan documenten die van of naar andere personen ontvangen of verzonden zijn waarbij die personen niet deel uit maken van de behandeling van de zaak waarin het document een rol speelt. type: string format: date nullable: true indicatieGebruiksrecht: title: Indicatie gebruiksrecht description: Indicatie of er beperkingen gelden aangaande het gebruik van het informatieobject anders dan raadpleging. Dit veld mag `null` zijn om aan te geven dat de indicatie nog niet bekend is. Als de indicatie gezet is, dan kan je de gebruiksrechten die van toepassing zijn raadplegen via de GEBRUIKSRECHTen resource. type: boolean nullable: true ondertekening: $ref: '#/components/schemas/Ondertekening' integriteit: $ref: '#/components/schemas/Integriteit' informatieobjecttype: title: Informatieobjecttype description: URL-referentie naar het INFORMATIEOBJECTTYPE (in de Catalogi API). type: string format: uri maxLength: 200 minLength: 1 locked: title: locked description: Geeft aan of het document gelocked is. Alleen als een document gelocked is, mogen er aanpassingen gemaakt worden. type: boolean readOnly: true Fout: required: - code - title - status - detail - instance type: object properties: type: title: Type description: URI referentie naar het type fout, bedoeld voor developers type: string code: title: Code description: Systeemcode die het type fout aangeeft type: string minLength: 1 title: title: Title description: Generieke titel voor het type fout type: string minLength: 1 status: title: Status description: De HTTP status code type: integer detail: title: Detail description: Extra informatie bij de fout, indien beschikbaar type: string minLength: 1 instance: title: Instance description: URI met referentie naar dit specifiek voorkomen van de fout. Deze kan gebruikt worden in combinatie met server logs, bijvoorbeeld. type: string minLength: 1 FieldValidationError: required: - name - code - reason type: object properties: name: title: Name description: Naam van het veld met ongeldige gegevens type: string minLength: 1 code: title: Code description: Systeemcode die het type fout aangeeft type: string minLength: 1 reason: title: Reason description: Uitleg wat er precies fout is met de gegevens type: string minLength: 1 ValidatieFout: required: - code - title - status - detail - instance - invalidParams type: object properties: type: title: Type description: URI referentie naar het type fout, bedoeld voor developers type: string code: title: Code description: Systeemcode die het type fout aangeeft type: string minLength: 1 title: title: Title description: Generieke titel voor het type fout type: string minLength: 1 status: title: Status description: De HTTP status code type: integer detail: title: Detail description: Extra informatie bij de fout, indien beschikbaar type: string minLength: 1 instance: title: Instance description: URI met referentie naar dit specifiek voorkomen van de fout. Deze kan gebruikt worden in combinatie met server logs, bijvoorbeeld. type: string minLength: 1 invalidParams: type: array items: $ref: '#/components/schemas/FieldValidationError' EnkelvoudigInformatieObjectData: required: - bronorganisatie - creatiedatum - titel - auteur - taal - inhoud - informatieobjecttype type: object properties: url: title: Url description: URL-referentie naar dit object. Dit is de unieke identificatie en locatie van dit object. type: string format: uri readOnly: true maxLength: 1000 minLength: 1 identificatie: title: Identificatie description: Een binnen een gegeven context ondubbelzinnige referentie naar het INFORMATIEOBJECT. type: string maxLength: 40 bronorganisatie: title: Bronorganisatie description: "Het RSIN van de Niet-natuurlijk persoon zijnde de organisatie\ \ die het informatieobject heeft gecre\xEBerd of heeft ontvangen en als\ \ eerste in een samenwerkingsketen heeft vastgelegd." type: string maxLength: 9 minLength: 1 creatiedatum: title: Creatiedatum description: Een datum of een gebeurtenis in de levenscyclus van het INFORMATIEOBJECT. type: string format: date titel: title: Titel description: De naam waaronder het INFORMATIEOBJECT formeel bekend is. type: string maxLength: 200 minLength: 1 vertrouwelijkheidaanduiding: title: Vertrouwelijkheidaanduiding description: 'Aanduiding van de mate waarin het INFORMATIEOBJECT voor de openbaarheid bestemd is. Uitleg bij mogelijke waarden: * `openbaar` - Openbaar * `beperkt_openbaar` - Beperkt openbaar * `intern` - Intern * `zaakvertrouwelijk` - Zaakvertrouwelijk * `vertrouwelijk` - Vertrouwelijk * `confidentieel` - Confidentieel * `geheim` - Geheim * `zeer_geheim` - Zeer geheim' type: string enum: - openbaar - beperkt_openbaar - intern - zaakvertrouwelijk - vertrouwelijk - confidentieel - geheim - zeer_geheim auteur: title: Auteur description: "De persoon of organisatie die in de eerste plaats verantwoordelijk\ \ is voor het cre\xEBren van de inhoud van het INFORMATIEOBJECT." type: string maxLength: 200 minLength: 1 status: title: Status description: 'Aanduiding van de stand van zaken van een INFORMATIEOBJECT. De waarden ''in bewerking'' en ''ter vaststelling'' komen niet voor als het attribuut `ontvangstdatum` van een waarde is voorzien. Wijziging van de Status in ''gearchiveerd'' impliceert dat het informatieobject een duurzaam, niet-wijzigbaar Formaat dient te hebben. Uitleg bij mogelijke waarden: * `in_bewerking` - (In bewerking) Aan het informatieobject wordt nog gewerkt. * `ter_vaststelling` - (Ter vaststelling) Informatieobject gereed maar moet nog vastgesteld worden. * `definitief` - (Definitief) Informatieobject door bevoegd iets of iemand vastgesteld dan wel ontvangen. * `gearchiveerd` - (Gearchiveerd) Informatieobject duurzaam bewaarbaar gemaakt; een gearchiveerd informatie-element.' type: string enum: - in_bewerking - ter_vaststelling - definitief - gearchiveerd formaat: title: Formaat description: 'Het "Media Type" (voorheen "MIME type") voor de wijze waaropde inhoud van het INFORMATIEOBJECT is vastgelegd in een computerbestand. Voorbeeld: `application/msword`. Zie: https://www.iana.org/assignments/media-types/media-types.xhtml' type: string maxLength: 255 taal: title: Taal description: 'Een ISO 639-2/B taalcode waarin de inhoud van het INFORMATIEOBJECT is vastgelegd. Voorbeeld: `nld`. Zie: https://www.iso.org/standard/4767.html' type: string maxLength: 3 minLength: 3 versie: title: Versie description: Het (automatische) versienummer van het INFORMATIEOBJECT. Deze begint bij 1 als het INFORMATIEOBJECT aangemaakt wordt. type: integer readOnly: true beginRegistratie: title: Begin registratie description: Een datumtijd in ISO8601 formaat waarop deze versie van het INFORMATIEOBJECT is aangemaakt of gewijzigd. type: string format: date-time readOnly: true bestandsnaam: title: Bestandsnaam description: De naam van het fysieke bestand waarin de inhoud van het informatieobject is vastgelegd, inclusief extensie. type: string maxLength: 255 inhoud: title: Inhoud description: "Binaire inhoud, in base64 ge\xEBncodeerd." type: string format: bytes bestandsomvang: title: Bestandsomvang description: Aantal bytes dat de inhoud van INFORMATIEOBJECT in beslag neemt. type: integer readOnly: true minimum: 0 link: title: Link description: De URL waarmee de inhoud van het INFORMATIEOBJECT op te vragen is. type: string format: uri maxLength: 200 beschrijving: title: Beschrijving description: Een generieke beschrijving van de inhoud van het INFORMATIEOBJECT. type: string maxLength: 1000 ontvangstdatum: title: Ontvangstdatum description: De datum waarop het INFORMATIEOBJECT ontvangen is. Verplicht te registreren voor INFORMATIEOBJECTen die van buiten de zaakbehandelende organisatie(s) ontvangen zijn. Ontvangst en verzending is voorbehouden aan documenten die van of naar andere personen ontvangen of verzonden zijn waarbij die personen niet deel uit maken van de behandeling van de zaak waarin het document een rol speelt. type: string format: date nullable: true verzenddatum: title: Verzenddatum description: De datum waarop het INFORMATIEOBJECT verzonden is, zoals deze op het INFORMATIEOBJECT vermeld is. Dit geldt voor zowel inkomende als uitgaande INFORMATIEOBJECTen. Eenzelfde informatieobject kan niet tegelijk inkomend en uitgaand zijn. Ontvangst en verzending is voorbehouden aan documenten die van of naar andere personen ontvangen of verzonden zijn waarbij die personen niet deel uit maken van de behandeling van de zaak waarin het document een rol speelt. type: string format: date nullable: true indicatieGebruiksrecht: title: Indicatie gebruiksrecht description: Indicatie of er beperkingen gelden aangaande het gebruik van het informatieobject anders dan raadpleging. Dit veld mag `null` zijn om aan te geven dat de indicatie nog niet bekend is. Als de indicatie gezet is, dan kan je de gebruiksrechten die van toepassing zijn raadplegen via de GEBRUIKSRECHTen resource. type: boolean nullable: true ondertekening: $ref: '#/components/schemas/Ondertekening' integriteit: $ref: '#/components/schemas/Integriteit' informatieobjecttype: title: Informatieobjecttype description: URL-referentie naar het INFORMATIEOBJECTTYPE (in de Catalogi API). type: string format: uri maxLength: 200 minLength: 1 locked: title: locked description: Geeft aan of het document gelocked is. Alleen als een document gelocked is, mogen er aanpassingen gemaakt worden. type: boolean readOnly: true Wijzigingen: title: Wijzigingen type: object properties: oud: title: Oud description: Volledige JSON body van het object zoals dat bestond voordat de actie heeft plaatsgevonden. type: object nieuw: title: Nieuw description: Volledige JSON body van het object na de actie. type: object AuditTrail: required: - bron - actie - resultaat - hoofdObject - resource - resourceUrl - resourceWeergave - wijzigingen type: object properties: uuid: title: Uuid description: Unieke identificatie van de audit regel. type: string format: uuid bron: title: Bron description: 'De naam van het component waar de wijziging in is gedaan. Uitleg bij mogelijke waarden: * `ac` - Autorisaties API * `nrc` - Notificaties API * `zrc` - Zaken API * `ztc` - Catalogi API * `drc` - Documenten API * `brc` - Besluiten API' type: string enum: - ac - nrc - zrc - ztc - drc - brc applicatieId: title: Applicatie id description: Unieke identificatie van de applicatie, binnen de organisatie. type: string maxLength: 100 applicatieWeergave: title: Applicatie weergave description: Vriendelijke naam van de applicatie. type: string maxLength: 200 gebruikersId: title: Gebruikers id description: Unieke identificatie van de gebruiker die binnen de organisatie herleid kan worden naar een persoon. type: string maxLength: 255 gebruikersWeergave: title: Gebruikers weergave description: Vriendelijke naam van de gebruiker. type: string maxLength: 255 actie: title: Actie description: 'De uitgevoerde handeling. De bekende waardes voor dit veld zijn hieronder aangegeven, maar andere waardes zijn ook toegestaan Uitleg bij mogelijke waarden: * `create` - Object aangemaakt * `list` - Lijst van objecten opgehaald * `retrieve` - Object opgehaald * `destroy` - Object verwijderd * `update` - Object bijgewerkt * `partial_update` - Object deels bijgewerkt' type: string maxLength: 50 minLength: 1 actieWeergave: title: Actie weergave description: Vriendelijke naam van de actie. type: string maxLength: 200 resultaat: title: Resultaat description: HTTP status code van de API response van de uitgevoerde handeling. type: integer maximum: 599 minimum: 100 hoofdObject: title: Hoofd object description: De URL naar het hoofdobject van een component. type: string format: uri maxLength: 1000 minLength: 1 resource: title: Resource description: Het type resource waarop de actie gebeurde. type: string maxLength: 50 minLength: 1 resourceUrl: title: Resource url description: De URL naar het object. type: string format: uri maxLength: 1000 minLength: 1 toelichting: title: Toelichting description: Toelichting waarom de handeling is uitgevoerd. type: string resourceWeergave: title: Resource weergave description: Vriendelijke identificatie van het object. type: string maxLength: 200 minLength: 1 aanmaakdatum: title: Aanmaakdatum description: De datum waarop de handeling is gedaan. type: string format: date-time readOnly: true wijzigingen: $ref: '#/components/schemas/Wijzigingen' EnkelvoudigInformatieObjectWithLockData: required: - bronorganisatie - creatiedatum - titel - auteur - taal - inhoud - informatieobjecttype - lock type: object properties: url: title: Url description: URL-referentie naar dit object. Dit is de unieke identificatie en locatie van dit object. type: string format: uri readOnly: true maxLength: 1000 minLength: 1 identificatie: title: Identificatie description: Een binnen een gegeven context ondubbelzinnige referentie naar het INFORMATIEOBJECT. type: string maxLength: 40 bronorganisatie: title: Bronorganisatie description: "Het RSIN van de Niet-natuurlijk persoon zijnde de organisatie\ \ die het informatieobject heeft gecre\xEBerd of heeft ontvangen en als\ \ eerste in een samenwerkingsketen heeft vastgelegd." type: string maxLength: 9 minLength: 1 creatiedatum: title: Creatiedatum description: Een datum of een gebeurtenis in de levenscyclus van het INFORMATIEOBJECT. type: string format: date titel: title: Titel description: De naam waaronder het INFORMATIEOBJECT formeel bekend is. type: string maxLength: 200 minLength: 1 vertrouwelijkheidaanduiding: title: Vertrouwelijkheidaanduiding description: 'Aanduiding van de mate waarin het INFORMATIEOBJECT voor de openbaarheid bestemd is. Uitleg bij mogelijke waarden: * `openbaar` - Openbaar * `beperkt_openbaar` - Beperkt openbaar * `intern` - Intern * `zaakvertrouwelijk` - Zaakvertrouwelijk * `vertrouwelijk` - Vertrouwelijk * `confidentieel` - Confidentieel * `geheim` - Geheim * `zeer_geheim` - Zeer geheim' type: string enum: - openbaar - beperkt_openbaar - intern - zaakvertrouwelijk - vertrouwelijk - confidentieel - geheim - zeer_geheim auteur: title: Auteur description: "De persoon of organisatie die in de eerste plaats verantwoordelijk\ \ is voor het cre\xEBren van de inhoud van het INFORMATIEOBJECT." type: string maxLength: 200 minLength: 1 status: title: Status description: 'Aanduiding van de stand van zaken van een INFORMATIEOBJECT. De waarden ''in bewerking'' en ''ter vaststelling'' komen niet voor als het attribuut `ontvangstdatum` van een waarde is voorzien. Wijziging van de Status in ''gearchiveerd'' impliceert dat het informatieobject een duurzaam, niet-wijzigbaar Formaat dient te hebben. Uitleg bij mogelijke waarden: * `in_bewerking` - (In bewerking) Aan het informatieobject wordt nog gewerkt. * `ter_vaststelling` - (Ter vaststelling) Informatieobject gereed maar moet nog vastgesteld worden. * `definitief` - (Definitief) Informatieobject door bevoegd iets of iemand vastgesteld dan wel ontvangen. * `gearchiveerd` - (Gearchiveerd) Informatieobject duurzaam bewaarbaar gemaakt; een gearchiveerd informatie-element.' type: string enum: - in_bewerking - ter_vaststelling - definitief - gearchiveerd formaat: title: Formaat description: 'Het "Media Type" (voorheen "MIME type") voor de wijze waaropde inhoud van het INFORMATIEOBJECT is vastgelegd in een computerbestand. Voorbeeld: `application/msword`. Zie: https://www.iana.org/assignments/media-types/media-types.xhtml' type: string maxLength: 255 taal: title: Taal description: 'Een ISO 639-2/B taalcode waarin de inhoud van het INFORMATIEOBJECT is vastgelegd. Voorbeeld: `nld`. Zie: https://www.iso.org/standard/4767.html' type: string maxLength: 3 minLength: 3 versie: title: Versie description: Het (automatische) versienummer van het INFORMATIEOBJECT. Deze begint bij 1 als het INFORMATIEOBJECT aangemaakt wordt. type: integer readOnly: true beginRegistratie: title: Begin registratie description: Een datumtijd in ISO8601 formaat waarop deze versie van het INFORMATIEOBJECT is aangemaakt of gewijzigd. type: string format: date-time readOnly: true bestandsnaam: title: Bestandsnaam description: De naam van het fysieke bestand waarin de inhoud van het informatieobject is vastgelegd, inclusief extensie. type: string maxLength: 255 inhoud: title: Inhoud description: "Binaire inhoud, in base64 ge\xEBncodeerd." type: string format: bytes bestandsomvang: title: Bestandsomvang description: Aantal bytes dat de inhoud van INFORMATIEOBJECT in beslag neemt. type: integer readOnly: true minimum: 0 link: title: Link description: De URL waarmee de inhoud van het INFORMATIEOBJECT op te vragen is. type: string format: uri maxLength: 200 beschrijving: title: Beschrijving description: Een generieke beschrijving van de inhoud van het INFORMATIEOBJECT. type: string maxLength: 1000 ontvangstdatum: title: Ontvangstdatum description: De datum waarop het INFORMATIEOBJECT ontvangen is. Verplicht te registreren voor INFORMATIEOBJECTen die van buiten de zaakbehandelende organisatie(s) ontvangen zijn. Ontvangst en verzending is voorbehouden aan documenten die van of naar andere personen ontvangen of verzonden zijn waarbij die personen niet deel uit maken van de behandeling van de zaak waarin het document een rol speelt. type: string format: date nullable: true verzenddatum: title: Verzenddatum description: De datum waarop het INFORMATIEOBJECT verzonden is, zoals deze op het INFORMATIEOBJECT vermeld is. Dit geldt voor zowel inkomende als uitgaande INFORMATIEOBJECTen. Eenzelfde informatieobject kan niet tegelijk inkomend en uitgaand zijn. Ontvangst en verzending is voorbehouden aan documenten die van of naar andere personen ontvangen of verzonden zijn waarbij die personen niet deel uit maken van de behandeling van de zaak waarin het document een rol speelt. type: string format: date nullable: true indicatieGebruiksrecht: title: Indicatie gebruiksrecht description: Indicatie of er beperkingen gelden aangaande het gebruik van het informatieobject anders dan raadpleging. Dit veld mag `null` zijn om aan te geven dat de indicatie nog niet bekend is. Als de indicatie gezet is, dan kan je de gebruiksrechten die van toepassing zijn raadplegen via de GEBRUIKSRECHTen resource. type: boolean nullable: true ondertekening: $ref: '#/components/schemas/Ondertekening' integriteit: $ref: '#/components/schemas/Integriteit' informatieobjecttype: title: Informatieobjecttype description: URL-referentie naar het INFORMATIEOBJECTTYPE (in de Catalogi API). type: string format: uri maxLength: 200 minLength: 1 locked: title: locked description: Geeft aan of het document gelocked is. Alleen als een document gelocked is, mogen er aanpassingen gemaakt worden. type: boolean readOnly: true lock: title: Lock description: Tijdens het updaten van een document (PATCH, PUT) moet het `lock` veld opgegeven worden. Bij het aanmaken (POST) mag het geen waarde hebben. type: string minLength: 1 LockEnkelvoudigInformatieObject: type: object properties: lock: title: Lock description: Hash string, wordt gebruikt als ID voor de lock type: string readOnly: true minLength: 1 UnlockEnkelvoudigInformatieObject: type: object properties: lock: title: Lock description: Hash string, wordt gebruikt als ID voor de lock type: string maxLength: 100 Gebruiksrechten: required: - informatieobject - startdatum - omschrijvingVoorwaarden type: object properties: url: title: Url description: URL-referentie naar dit object. Dit is de unieke identificatie en locatie van dit object. type: string format: uri readOnly: true maxLength: 1000 minLength: 1 informatieobject: title: Informatieobject description: URL-referentie naar het INFORMATIEOBJECT. type: string format: uri startdatum: title: Startdatum description: Begindatum van de periode waarin de gebruiksrechtvoorwaarden van toepassing zijn. Doorgaans is de datum van creatie van het informatieobject de startdatum. type: string format: date-time einddatum: title: Startdatum description: Einddatum van de periode waarin de gebruiksrechtvoorwaarden van toepassing zijn. type: string format: date-time nullable: true omschrijvingVoorwaarden: title: Omschrijving voorwaarden description: Omschrijving van de van toepassing zijnde voorwaarden aan het gebruik anders dan raadpleging type: string minLength: 1 ObjectInformatieObject: required: - informatieobject - object - objectType type: object properties: url: title: Url description: URL-referentie naar dit object. Dit is de unieke identificatie en locatie van dit object. type: string format: uri readOnly: true maxLength: 1000 minLength: 1 informatieobject: title: Informatieobject description: URL-referentie naar het INFORMATIEOBJECT. type: string format: uri object: title: Object description: URL-referentie naar het gerelateerde OBJECT (in deze of een andere API). type: string format: uri maxLength: 1000 minLength: 1 objectType: title: Objecttype description: 'Het type van het gerelateerde OBJECT. Uitleg bij mogelijke waarden: * `besluit` - Besluit * `zaak` - Zaak' type: string enum: - besluit - zaak