openapi: 3.2.0 info: title: Vng Realisatie Enkelvoudiginformatieobjecten API version: 1.5.0 contact: email: standaarden.ondersteuning@vng.nl url: https://vng-realisatie.github.io/gemma-zaken license: name: EUPL 1.2 url: https://opensource.org/licenses/EUPL-1.2 description: 'Operations tagged enkelvoudiginformatieobjecten across 2 of this provider''s published API definitions: vng-realisatie-documenten-openapi.yml, vng-realisatie-documenten-openapi.yml. Each path carries the servers of the definition it was published in.' servers: - url: https://documenten-api.vng.cloud/api/v1 description: Productie Omgeving tags: - name: enkelvoudiginformatieobjecten description: Opvragen en bewerken van (ENKELVOUDIG) INFORMATIEOBJECTen (documenten). paths: /enkelvoudiginformatieobjecten: get: operationId: enkelvoudiginformatieobject_list 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' summary: Alle (ENKELVOUDIGe) INFORMATIEOBJECTen opvragen parameters: - name: identificatie required: false in: query description: Een binnen een gegeven context ondubbelzinnige referentie naar het INFORMATIEOBJECT. schema: type: string - name: bronorganisatie required: false in: query description: Het RSIN van de Niet-natuurlijk persoon zijnde de organisatie die het informatieobject heeft gecreëerd of heeft ontvangen en als eerste in een samenwerkingsketen heeft vastgelegd. schema: type: string - name: trefwoorden required: false in: query description: Een lijst van trefwoorden gescheiden door comma's. schema: type: string - name: expand required: false in: query description: "Examples: \n`expand=zaaktype, status, status.statustype, hoofdzaak.status.statustype, hoofdzaak.deelzaken.status.statustype`\nHaal details van gelinkte resources direct op. Als je meerdere resources tegelijk wilt ophalen kun je deze scheiden met een komma. Voor het ophalen van resources die een laag dieper genest zijn wordt de punt-notatie gebruikt." schema: type: string - name: page required: false in: query description: Een pagina binnen de gepagineerde set resultaten. schema: type: integer tags: - enkelvoudiginformatieobjecten security: - JWT-Claims: - documenten.lezen responses: '200': 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/PaginatedEnkelvoudigInformatieObjectList' description: OK '400': 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' description: Bad request '401': 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' description: Unauthorized '403': 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' description: Forbidden '406': 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' description: Not acceptable '409': 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' description: Conflict '410': 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' description: Gone '415': 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' description: Unsupported media type '429': 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' description: Too many requests '500': 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' description: Internal server error post: operationId: enkelvoudiginformatieobject_create description: '**Er wordt gevalideerd op** - geldigheid `informatieobjecttype` URL - de resource moet opgevraagd kunnen worden uit de catalogi API en de vorm van een INFORMATIEOBJECTTYPE hebben. - publicatie `informatieobjecttype` - `concept` moet `false` zijn' summary: Maak een (ENKELVOUDIG) INFORMATIEOBJECT aan parameters: - in: header name: Content-Type schema: type: string enum: - application/json description: Content type van de verzoekinhoud. required: true - in: header name: X-NLX-Logrecord-ID schema: type: string description: Identifier of the request, traceable throughout the network - in: header name: X-Audit-Toelichting schema: type: string description: Toelichting waarom een bepaald verzoek wordt gedaan tags: - enkelvoudiginformatieobjecten requestBody: content: application/json: schema: $ref: '#/components/schemas/EnkelvoudigInformatieObjectCreateLockRequest' required: true security: - JWT-Claims: - documenten.aanmaken responses: '201': headers: Location: schema: type: string format: uri description: URL waar de resource leeft. 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/SchemaEIO' description: Created '400': 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' description: Bad request '401': 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' description: Unauthorized '403': 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' description: Forbidden '406': 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' description: Not acceptable '409': 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' description: Conflict '410': 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' description: Gone '415': 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' description: Unsupported media type '429': 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' description: Too many requests '500': 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' description: Internal server error servers: - url: https://documenten-api.vng.cloud/api/v1 description: Productie Omgeving /enkelvoudiginformatieobjecten/{enkelvoudiginformatieobject_uuid}/audittrail: get: operationId: audittrail_list description: Alle audit trail regels behorend bij het INFORMATIEOBJECT. summary: Alle audit trail regels behorend bij het INFORMATIEOBJECT parameters: - in: path name: enkelvoudiginformatieobject_uuid schema: type: string description: Unieke resource identifier (UUID4) required: true tags: - enkelvoudiginformatieobjecten security: - JWT-Claims: - audittrails.lezen responses: '200': 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' description: OK '401': 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' description: Unauthorized '403': 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' description: Forbidden '406': 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' description: Not acceptable '409': 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' description: Conflict '410': 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' description: Gone '415': 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' description: Unsupported media type '429': 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' description: Too many requests '500': 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' description: Internal server error servers: - url: https://documenten-api.vng.cloud/api/v1 description: Productie Omgeving /enkelvoudiginformatieobjecten/{enkelvoudiginformatieobject_uuid}/audittrail/{uuid}: get: operationId: audittrail_retrieve description: Een specifieke audit trail regel opvragen. summary: Een specifieke audit trail regel opvragen parameters: - in: path name: uuid schema: type: string format: uuid description: Unieke identificatie van de audit regel. title: uuid required: true - in: path name: enkelvoudiginformatieobject_uuid schema: type: string description: Unieke resource identifier (UUID4) required: true tags: - enkelvoudiginformatieobjecten security: - JWT-Claims: - audittrails.lezen responses: '200': 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' description: OK '401': 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' description: Unauthorized '403': 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' description: Forbidden '404': 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' description: Not found '406': 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' description: Not acceptable '409': 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' description: Conflict '410': 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' description: Gone '415': 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' description: Unsupported media type '429': 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' description: Too many requests '500': 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' description: Internal server error servers: - url: https://documenten-api.vng.cloud/api/v1 description: Productie Omgeving /enkelvoudiginformatieobjecten/{uuid}: get: operationId: enkelvoudiginformatieobject_retrieve 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. summary: Een specifiek (ENKELVOUDIG) INFORMATIEOBJECT opvragen parameters: - in: path name: uuid schema: type: string format: uuid description: Unieke resource identifier (UUID4) title: uuid required: true - in: header name: If-None-Match schema: type: string description: Voer een voorwaardelijk verzoek uit. Deze header moet één of meerdere ETag-waardes bevatten van resources die de consumer gecached heeft. Indien de waarde van de ETag van de huidige resource voorkomt in deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match) voor meer informatie. examples: OneValue: value: '"79054025255fb1a26e4bc422aef54eb4"' summary: Eén ETag-waarde MultipleValues: value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' summary: Meerdere ETag-waardes - in: query name: versie schema: type: integer description: Het (automatische) versienummer van het INFORMATIEOBJECT. - in: query name: registratieOp schema: type: string description: Een datumtijd in ISO8601 formaat. De versie van het INFORMATIEOBJECT die qua `begin_registratie` het kortst hiervoor zit wordt opgehaald. - in: query name: expand schema: type: string description: Haal details van gelinkte resources direct op. Als je meerdere resources tegelijk wilt ophalen kun je deze scheiden met een komma. Voor het ophalen van resources die een laag dieper genest zijn wordt de punt-notatie gebruikt. examples: ExpandZaaktype: value: zaaktype summary: expand zaaktype ExpandStatus: value: status summary: expand status ExpandStatus.statustype: value: status.statustype summary: expand status.statustype ExpandHoofdzaak.status.statustype: value: hoofdzaak.status.statustype summary: expand hoofdzaak.status.statustype ExpandHoofdzaak.deelzaken.status.statustype: value: hoofdzaak.deelzaken.status.statustype summary: expand hoofdzaak.deelzaken.status.statustype tags: - enkelvoudiginformatieobjecten security: - JWT-Claims: - documenten.lezen responses: '200': headers: ETag: schema: type: string description: De ETag berekend op de response body JSON. Indien twee resources exact dezelfde ETag hebben, dan zijn deze resources identiek aan elkaar. Je kan de ETag gebruiken om caching te implementeren. 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/SchemaEIO' description: OK '401': 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' description: Unauthorized '403': 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' description: Forbidden '404': 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' description: Not found '406': 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' description: Not acceptable '409': 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' description: Conflict '410': 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' description: Gone '415': 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' description: Unsupported media type '429': 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' description: Too many requests '500': 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' description: Internal server error put: operationId: enkelvoudiginformatieobject_update description: Dit creëert altijd een nieuwe versie van het (ENKELVOUDIG) INFORMATIEOBJECT. summary: Werk een (ENKELVOUDIG) INFORMATIEOBJECT in zijn geheel bij parameters: - in: path name: uuid schema: type: string format: uuid description: Unieke resource identifier (UUID4) title: uuid required: true - in: header name: Content-Type schema: type: string enum: - application/json description: Content type van de verzoekinhoud. required: true - in: header name: X-NLX-Logrecord-ID schema: type: string description: Identifier of the request, traceable throughout the network - in: header name: X-Audit-Toelichting schema: type: string description: Toelichting waarom een bepaald verzoek wordt gedaan tags: - enkelvoudiginformatieobjecten requestBody: content: application/json: schema: $ref: '#/components/schemas/EnkelvoudigInformatieObjectWithLockRequest' required: true security: - JWT-Claims: - (documenten.bijwerken | documenten.geforceerd-bijwerken) responses: '200': 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/EnkelvoudigInformatieObjectWithLock' description: OK '400': 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' description: Bad request '401': 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' description: Unauthorized '403': 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' description: Forbidden '404': 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' description: Not found '406': 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' description: Not acceptable '409': 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' description: Conflict '410': 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' description: Gone '415': 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' description: Unsupported media type '429': 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' description: Too many requests '500': 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' description: Internal server error patch: operationId: enkelvoudiginformatieobject_partial_update description: Dit creëert altijd een nieuwe versie van het (ENKELVOUDIG) INFORMATIEOBJECT. summary: Werk een (ENKELVOUDIG) INFORMATIEOBJECT deels bij parameters: - in: path name: uuid schema: type: string format: uuid description: Unieke resource identifier (UUID4) title: uuid required: true - in: header name: Content-Type schema: type: string enum: - application/json description: Content type van de verzoekinhoud. required: true - in: header name: X-NLX-Logrecord-ID schema: type: string description: Identifier of the request, traceable throughout the network - in: header name: X-Audit-Toelichting schema: type: string description: Toelichting waarom een bepaald verzoek wordt gedaan tags: - enkelvoudiginformatieobjecten requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedEnkelvoudigInformatieObjectWithLockRequest' security: - JWT-Claims: - (documenten.bijwerken | documenten.geforceerd-bijwerken) responses: '200': 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/EnkelvoudigInformatieObjectWithLock' description: OK '400': 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' description: Bad request '401': 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' description: Unauthorized '403': 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' description: Forbidden '404': 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' description: Not found '406': 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' description: Not acceptable '409': 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' description: Conflict '410': 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' description: Gone '415': 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' description: Unsupported media type '429': 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' description: Too many requests '500': 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' description: Internal server error delete: operationId: enkelvoudiginformatieobject_destroy 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' summary: Verwijder een (ENKELVOUDIG) INFORMATIEOBJECT parameters: - in: path name: uuid schema: type: string format: uuid description: Unieke resource identifier (UUID4) title: uuid required: true - in: header name: X-NLX-Logrecord-ID schema: type: string description: Identifier of the request, traceable throughout the network - in: header name: X-Audit-Toelichting schema: type: string description: Toelichting waarom een bepaald verzoek wordt gedaan tags: - enkelvoudiginformatieobjecten security: - JWT-Claims: - documenten.verwijderen responses: '204': description: No content '401': 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' description: Unauthorized '403': 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' description: Forbidden '404': 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' description: Not found '406': 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' description: Not acceptable '409': 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' description: Conflict '410': 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' description: Gone '415': 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' description: Unsupported media type '429': 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' description: Too many requests '500': 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' description: Internal server error head: operationId: enkelvoudiginformatieobject_headers description: Vraag de headers op die je bij een GET request zou krijgen. summary: De headers voor een specifiek(e) ENKELVOUDIG INFORMATIE OBJECT opvragen parameters: - in: path name: uuid schema: type: string format: uuid description: Unieke resource identifier (UUID4) title: uuid required: true - in: header name: If-None-Match schema: type: string description: Voer een voorwaardelijk verzoek uit. Deze header moet één of meerdere ETag-waardes bevatten van resources die de consumer gecached heeft. Indien de waarde van de ETag van de huidige resource voorkomt in deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match) voor meer informatie. examples: OneValue: value: '"79054025255fb1a26e4bc422aef54eb4"' summary: Eén ETag-waarde MultipleValues: value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' summary: Meerdere ETag-waardes tags: - enkelvoudiginformatieobjecten responses: '200': headers: ETag: schema: type: string description: De ETag berekend op de response body JSON. Indien twee resources exact dezelfde ETag hebben, dan zijn deze resources identiek aan elkaar. Je kan de ETag gebruiken om caching te implementeren. 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' description: OK servers: - url: https://documenten-api.vng.cloud/api/v1 description: Productie Omgeving /enkelvoudiginformatieobjecten/{uuid}/download: get: operationId: enkelvoudiginformatieobject_download description: Download de binaire data van het (ENKELVOUDIG) INFORMATIEOBJECT. summary: Download de binaire data van het (ENKELVOUDIG) INFORMATIEOBJECT parameters: - in: path name: uuid schema: type: string format: uuid description: Unieke resource identifier (UUID4) title: uuid required: true - in: query name: versie schema: type: integer description: Het (automatische) versienummer van het INFORMATIEOBJECT. - in: query name: registratieOp schema: type: string description: Een datumtijd in ISO8601 formaat. De versie van het INFORMATIEOBJECT die qua `begin_registratie` het kortst hiervoor zit wordt opgehaald. tags: - enkelvoudiginformatieobjecten security: - JWT-Claims: - documenten.lezen responses: '200': 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 description: OK '401': content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized '403': content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden '404': content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not found '406': content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable '410': content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone '415': content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type '429': content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests '500': content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error servers: - url: https://documenten-api.vng.cloud/api/v1 description: Productie Omgeving /enkelvoudiginformatieobjecten/{uuid}/lock: post: operationId: enkelvoudiginformatieobject_lock description: Voert een 'checkout' uit waardoor het (ENKELVOUDIG) INFORMATIEOBJECTvergrendeld wordt met een `lock` waarde. Alleen met deze waarde kan het(ENKELVOUDIG) INFORMATIEOBJECT bijgewerkt (`PUT`, `PATCH`) en weerontgrendeld worden. summary: Vergrendel een (ENKELVOUDIG) INFORMATIEOBJECT parameters: - in: path name: uuid schema: type: string format: uuid description: Unieke resource identifier (UUID4) title: uuid required: true - in: header name: Content-Type schema: type: string enum: - application/json description: Content type van de verzoekinhoud. required: true tags: - enkelvoudiginformatieobjecten security: - JWT-Claims: - documenten.lock responses: '200': 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' description: OK '400': content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Bad request '401': content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized '403': content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden '404': content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not found '406': content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable '410': content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone '415': content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type '429': content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests '500': content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error servers: - url: https://documenten-api.vng.cloud/api/v1 description: Productie Omgeving /enkelvoudiginformatieobjecten/{uuid}/unlock: post: operationId: enkelvoudiginformatieobject_unlock description: Heft de 'checkout' op waardoor het (ENKELVOUDIG) INFORMATIEOBJECTontgrendeld wordt. summary: Ontgrendel een (ENKELVOUDIG) INFORMATIEOBJECT parameters: - in: path name: uuid schema: type: string format: uuid description: Unieke resource identifier (UUID4) title: uuid required: true - in: header name: Content-Type schema: type: string enum: - application/json description: Content type van de verzoekinhoud. required: true tags: - enkelvoudiginformatieobjecten requestBody: content: application/json: schema: $ref: '#/components/schemas/UnlockEnkelvoudigInformatieObjectRequest' security: - JWT-Claims: - (documenten.lock | documenten.geforceerd-unlock) responses: '204': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' description: No content '400': content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Bad request '401': content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized '403': content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden '404': content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not found '406': content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable '410': content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone '415': content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type '429': content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests '500': content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error servers: - url: https://documenten-api.vng.cloud/api/v1 description: Productie Omgeving /enkelvoudiginformatieobjecten/_zoek: post: operationId: enkelvoudiginformatieobject__zoek description: Zoeken/filteren gaat normaal via de `list` operatie, deze is echter niet geschikt voor zoekopdrachten met UUIDs. summary: Voer een zoekopdracht uit op (ENKELVOUDIG) INFORMATIEOBJECTen parameters: - in: header name: Content-Type schema: type: string enum: - application/json description: Content type van de verzoekinhoud. required: true - in: query name: page schema: type: integer description: Een pagina binnen de gepagineerde set resultaten. tags: - enkelvoudiginformatieobjecten requestBody: content: application/json: schema: $ref: '#/components/schemas/EIOZoekRequest' required: true security: - JWT-Claims: - documenten.lezen responses: '200': 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/PaginatedEnkelvoudigInformatieObjectList' description: OK '400': 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' description: Bad request '401': 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' description: Unauthorized '403': 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' description: Forbidden '406': 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' description: Not acceptable '409': 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' description: Conflict '410': 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' description: Gone '415': 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' description: Unsupported media type '429': 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' description: Too many requests '500': 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' description: Internal server error servers: - url: https://documenten-api.vng.cloud/api/v1 description: Productie Omgeving components: schemas: Wijzigingen: type: object properties: oud: type: object additionalProperties: {} description: Volledige JSON body van het object zoals dat bestond voordat de actie heeft plaatsgevonden. title: oud nieuw: type: object additionalProperties: {} description: Volledige JSON body van het object na de actie. title: nieuw BronEnum: enum: - ac - nrc - zrc - ztc - drc - brc - cmc - kc - vrc type: string EnkelvoudigInformatieObject: type: object description: Serializer for the EnkelvoudigInformatieObject model properties: url: type: string format: uri readOnly: true title: url description: URL-referentie naar dit object. Dit is de unieke identificatie en locatie van dit object. minLength: 1 maxLength: 1000 identificatie: type: string description: Een binnen een gegeven context ondubbelzinnige referentie naar het INFORMATIEOBJECT. title: identificatie maxLength: 40 bronorganisatie: type: string description: Het RSIN van de Niet-natuurlijk persoon zijnde de organisatie die het informatieobject heeft gecreëerd of heeft ontvangen en als eerste in een samenwerkingsketen heeft vastgelegd. title: bronorganisatie maxLength: 9 creatiedatum: type: string format: date description: Een datum of een gebeurtenis in de levenscyclus van het INFORMATIEOBJECT. title: creatiedatum titel: type: string description: De naam waaronder het INFORMATIEOBJECT formeel bekend is. title: titel maxLength: 200 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' title: vertrouwelijkheidaanduiding oneOf: - $ref: '#/components/schemas/VertrouwelijkheidaanduidingEnum' - $ref: '#/components/schemas/BlankEnum' auteur: type: string description: De persoon of organisatie die in de eerste plaats verantwoordelijk is voor het creëren van de inhoud van het INFORMATIEOBJECT. title: auteur maxLength: 200 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. * `concept` - (Concept) Het document is inhoudelijk klaar om voorgelegd teworden aan anderen en zo nodig aangepast te worden opbasis van commentaar.. * `definitief` - (Definitief) Informatieobject door bevoegd iets of iemand vastgesteld dan wel ontvangen. * `ter_vaststelling` - (Ter vaststelling) Informatieobject gereed maar moet nog vastgesteld worden. * `vastgesteld` - (Vastgesteld) Het besluitvormingstraject is afgerond. * `gearchiveerd` - (Gearchiveerd) Informatieobject duurzaam bewaarbaar gemaakt; een gearchiveerd informatie-element.' title: status oneOf: - $ref: '#/components/schemas/StatusEnum' - $ref: '#/components/schemas/BlankEnum' formaat: type: string 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' title: formaat maxLength: 255 taal: type: string description: 'Een ISO 639-2/B taalcode waarin de inhoud van het INFORMATIEOBJECT is vastgelegd. Voorbeeld: `dut`. Zie: https://www.iso.org/standard/4767.html' title: taal maxLength: 3 minLength: 3 versie: type: integer readOnly: true description: Het (automatische) versienummer van het INFORMATIEOBJECT. Deze begint bij 1 als het INFORMATIEOBJECT aangemaakt wordt. title: versie beginRegistratie: type: string format: date-time readOnly: true description: Een datumtijd in ISO8601 formaat waarop deze versie van het INFORMATIEOBJECT is aangemaakt of gewijzigd. title: begin registratie bestandsnaam: type: string description: De naam van het fysieke bestand waarin de inhoud van het informatieobject is vastgelegd, inclusief extensie. title: bestandsnaam maxLength: 255 inhoud: type: - string - 'null' format: uri description: Download URL van de binaire inhoud. title: inhoud bestandsomvang: type: - integer - 'null' maximum: 9223372036854775807 minimum: 0 format: int64 description: Aantal bytes dat de inhoud van INFORMATIEOBJECT in beslag neemt. title: bestandsomvang link: type: string format: uri description: De URL waarmee de inhoud van het INFORMATIEOBJECT op te vragen is. title: link maxLength: 200 beschrijving: type: string description: Een generieke beschrijving van de inhoud van het INFORMATIEOBJECT. title: beschrijving maxLength: 1000 ontvangstdatum: type: - string - 'null' format: date description: "**DEPRECATED** Dit attribuut is verplaatst naar resource Verzending. \n\n 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." title: ontvangstdatum verzenddatum: type: - string - 'null' format: date description: "**DEPRECATED** Dit attribuut is verplaatst naar resource Verzending. \n\n 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." title: verzenddatum indicatieGebruiksrecht: type: - boolean - 'null' 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. title: indicatie gebruiksrecht verschijningsvorm: type: string description: De essentiële opmaakaspecten van een INFORMATIEOBJECT. title: verschijningsvorm ondertekening: allOf: - $ref: '#/components/schemas/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. title: ondertekening integriteit: allOf: - $ref: '#/components/schemas/Integriteit' description: Uitdrukking van mate van volledigheid en onbeschadigd zijn van digitaal bestand. title: integriteit informatieobjecttype: type: string format: uri description: URL-referentie naar het INFORMATIEOBJECTTYPE (in de Catalogi API). title: informatieobjecttype maxLength: 200 locked: type: boolean readOnly: true description: Geeft aan of het document gelocked is. Alleen als een document gelocked is, mogen er aanpassingen gemaakt worden. title: locked bestandsdelen: type: array items: $ref: '#/components/schemas/BestandsDeel' readOnly: true title: bestandsdelen trefwoorden: type: - array - 'null' items: type: string maxLength: 100 description: Een lijst van trefwoorden gescheiden door comma's. title: trefwoorden inhoudIsVervallen: type: - boolean - 'null' description: Geeft aan of de inhoud van het informatieobject vervallen (dus niet langer geldig) is. title: inhoud is vervallen required: - auteur - beginRegistratie - bestandsdelen - bronorganisatie - creatiedatum - informatieobjecttype - locked - taal - titel - url - versie EnkelvoudigInformatieObjectWithLockRequest: type: object description: 'This serializer class is used by EnkelvoudigInformatieObjectViewSet for update and partial_update operations' properties: identificatie: type: string description: Een binnen een gegeven context ondubbelzinnige referentie naar het INFORMATIEOBJECT. title: identificatie maxLength: 40 bronorganisatie: type: string minLength: 1 description: Het RSIN van de Niet-natuurlijk persoon zijnde de organisatie die het informatieobject heeft gecreëerd of heeft ontvangen en als eerste in een samenwerkingsketen heeft vastgelegd. title: bronorganisatie maxLength: 9 creatiedatum: type: string format: date description: Een datum of een gebeurtenis in de levenscyclus van het INFORMATIEOBJECT. title: creatiedatum titel: type: string minLength: 1 description: De naam waaronder het INFORMATIEOBJECT formeel bekend is. title: titel maxLength: 200 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' title: vertrouwelijkheidaanduiding oneOf: - $ref: '#/components/schemas/VertrouwelijkheidaanduidingEnum' - $ref: '#/components/schemas/BlankEnum' auteur: type: string minLength: 1 description: De persoon of organisatie die in de eerste plaats verantwoordelijk is voor het creëren van de inhoud van het INFORMATIEOBJECT. title: auteur maxLength: 200 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. * `concept` - (Concept) Het document is inhoudelijk klaar om voorgelegd teworden aan anderen en zo nodig aangepast te worden opbasis van commentaar.. * `definitief` - (Definitief) Informatieobject door bevoegd iets of iemand vastgesteld dan wel ontvangen. * `ter_vaststelling` - (Ter vaststelling) Informatieobject gereed maar moet nog vastgesteld worden. * `vastgesteld` - (Vastgesteld) Het besluitvormingstraject is afgerond. * `gearchiveerd` - (Gearchiveerd) Informatieobject duurzaam bewaarbaar gemaakt; een gearchiveerd informatie-element.' title: status oneOf: - $ref: '#/components/schemas/StatusEnum' - $ref: '#/components/schemas/BlankEnum' formaat: type: string 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' title: formaat maxLength: 255 taal: type: string minLength: 3 description: 'Een ISO 639-2/B taalcode waarin de inhoud van het INFORMATIEOBJECT is vastgelegd. Voorbeeld: `dut`. Zie: https://www.iso.org/standard/4767.html' title: taal maxLength: 3 bestandsnaam: type: string description: De naam van het fysieke bestand waarin de inhoud van het informatieobject is vastgelegd, inclusief extensie. title: bestandsnaam maxLength: 255 inhoud: type: - string - 'null' format: byte description: Binaire inhoud, in base64 geëncodeerd. title: inhoud bestandsomvang: type: - integer - 'null' maximum: 9223372036854775807 minimum: 0 format: int64 description: Aantal bytes dat de inhoud van INFORMATIEOBJECT in beslag neemt. title: bestandsomvang link: type: string format: uri description: De URL waarmee de inhoud van het INFORMATIEOBJECT op te vragen is. title: link maxLength: 200 beschrijving: type: string description: Een generieke beschrijving van de inhoud van het INFORMATIEOBJECT. title: beschrijving maxLength: 1000 ontvangstdatum: type: - string - 'null' format: date description: "**DEPRECATED** Dit attribuut is verplaatst naar resource Verzending. \n\n 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." title: ontvangstdatum verzenddatum: type: - string - 'null' format: date description: "**DEPRECATED** Dit attribuut is verplaatst naar resource Verzending. \n\n 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." title: verzenddatum indicatieGebruiksrecht: type: - boolean - 'null' 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. title: indicatie gebruiksrecht verschijningsvorm: type: string description: De essentiële opmaakaspecten van een INFORMATIEOBJECT. title: verschijningsvorm ondertekening: allOf: - $ref: '#/components/schemas/OndertekeningRequest' 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. title: ondertekening integriteit: allOf: - $ref: '#/components/schemas/IntegriteitRequest' description: Uitdrukking van mate van volledigheid en onbeschadigd zijn van digitaal bestand. title: integriteit informatieobjecttype: type: string format: uri minLength: 1 description: URL-referentie naar het INFORMATIEOBJECTTYPE (in de Catalogi API). title: informatieobjecttype maxLength: 200 trefwoorden: type: - array - 'null' items: type: string minLength: 1 maxLength: 100 description: Een lijst van trefwoorden gescheiden door comma's. title: trefwoorden inhoudIsVervallen: type: - boolean - 'null' description: Geeft aan of de inhoud van het informatieobject vervallen (dus niet langer geldig) is. title: inhoud is vervallen lock: type: string writeOnly: true minLength: 1 description: Tijdens het updaten van een document (PATCH, PUT) moet het `lock` veld opgegeven worden. Bij het aanmaken (POST) mag het geen waarde hebben. title: lock required: - auteur - bronorganisatie - creatiedatum - informatieobjecttype - lock - taal - titel Fout: type: object description: Formaat van HTTP 4xx en 5xx fouten. properties: type: type: string description: URI referentie naar het type fout, bedoeld voor developers title: type code: type: string description: Systeemcode die het type fout aangeeft title: code title: type: string description: Generieke titel voor het type fout title: title status: type: integer description: De HTTP status code title: status detail: type: string description: Extra informatie bij de fout, indien beschikbaar title: detail instance: type: string description: URI met referentie naar dit specifiek voorkomen van de fout. Deze kan gebruikt worden in combinatie met server logs, bijvoorbeeld. title: instance required: - code - detail - instance - status - title PaginatedEnkelvoudigInformatieObjectList: type: object properties: count: type: integer example: 123 next: type: - string - 'null' format: uri example: http://api.example.org/accounts/?page=4 previous: type: - string - 'null' format: uri example: http://api.example.org/accounts/?page=2 results: type: array items: $ref: '#/components/schemas/EnkelvoudigInformatieObject' BestandsDeel: type: object properties: url: type: string format: uri readOnly: true title: url description: URL-referentie naar dit object. Dit is de unieke identificatie en locatie van dit object. minLength: 1 maxLength: 1000 volgnummer: type: integer readOnly: true description: Een volgnummer dat de volgorde van de bestandsdelen aangeeft. title: volgnummer omvang: type: integer readOnly: true description: De grootte van dit specifieke bestandsdeel. title: omvang voltooid: type: boolean readOnly: true description: 'Indicatie of dit bestandsdeel volledig is geupload. Dat wil zeggen: het aantal bytes dat staat genoemd bij grootte is daadwerkelijk ontvangen.' title: voltooid lock: type: string description: Hash string, which represents id of the lock of related informatieobject title: lock required: - lock - omvang - url - volgnummer - voltooid SchemaBestandsDeel: type: object properties: url: type: string format: uri readOnly: true title: url description: URL-referentie naar dit object. Dit is de unieke identificatie en locatie van dit object. minLength: 1 maxLength: 1000 volgnummer: type: integer readOnly: true description: Een volgnummer dat de volgorde van de bestandsdelen aangeeft. title: volgnummer omvang: type: integer readOnly: true description: De grootte van dit specifieke bestandsdeel. title: omvang voltooid: type: boolean readOnly: true description: 'Indicatie of dit bestandsdeel volledig is geupload. Dat wil zeggen: het aantal bytes dat staat genoemd bij grootte is daadwerkelijk ontvangen.' title: voltooid lock: type: string description: Hash string, which represents id of the lock of related informatieobject title: lock required: - lock - omvang - url - volgnummer - voltooid EnkelvoudigInformatieObjectCreateLockRequest: type: object description: 'This serializer class is used by EnkelvoudigInformatieObjectViewSet for create operation for large files' properties: identificatie: type: string description: Een binnen een gegeven context ondubbelzinnige referentie naar het INFORMATIEOBJECT. title: identificatie maxLength: 40 bronorganisatie: type: string minLength: 1 description: Het RSIN van de Niet-natuurlijk persoon zijnde de organisatie die het informatieobject heeft gecreëerd of heeft ontvangen en als eerste in een samenwerkingsketen heeft vastgelegd. title: bronorganisatie maxLength: 9 creatiedatum: type: string format: date description: Een datum of een gebeurtenis in de levenscyclus van het INFORMATIEOBJECT. title: creatiedatum titel: type: string minLength: 1 description: De naam waaronder het INFORMATIEOBJECT formeel bekend is. title: titel maxLength: 200 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' title: vertrouwelijkheidaanduiding oneOf: - $ref: '#/components/schemas/VertrouwelijkheidaanduidingEnum' - $ref: '#/components/schemas/BlankEnum' auteur: type: string minLength: 1 description: De persoon of organisatie die in de eerste plaats verantwoordelijk is voor het creëren van de inhoud van het INFORMATIEOBJECT. title: auteur maxLength: 200 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. * `concept` - (Concept) Het document is inhoudelijk klaar om voorgelegd teworden aan anderen en zo nodig aangepast te worden opbasis van commentaar.. * `definitief` - (Definitief) Informatieobject door bevoegd iets of iemand vastgesteld dan wel ontvangen. * `ter_vaststelling` - (Ter vaststelling) Informatieobject gereed maar moet nog vastgesteld worden. * `vastgesteld` - (Vastgesteld) Het besluitvormingstraject is afgerond. * `gearchiveerd` - (Gearchiveerd) Informatieobject duurzaam bewaarbaar gemaakt; een gearchiveerd informatie-element.' title: status oneOf: - $ref: '#/components/schemas/StatusEnum' - $ref: '#/components/schemas/BlankEnum' formaat: type: string 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' title: formaat maxLength: 255 taal: type: string minLength: 3 description: 'Een ISO 639-2/B taalcode waarin de inhoud van het INFORMATIEOBJECT is vastgelegd. Voorbeeld: `dut`. Zie: https://www.iso.org/standard/4767.html' title: taal maxLength: 3 bestandsnaam: type: string description: De naam van het fysieke bestand waarin de inhoud van het informatieobject is vastgelegd, inclusief extensie. title: bestandsnaam maxLength: 255 inhoud: type: - string - 'null' format: byte description: Binaire inhoud, in base64 geëncodeerd. title: inhoud bestandsomvang: type: - integer - 'null' maximum: 9223372036854775807 minimum: 0 format: int64 description: Aantal bytes dat de inhoud van INFORMATIEOBJECT in beslag neemt. title: bestandsomvang link: type: string format: uri description: De URL waarmee de inhoud van het INFORMATIEOBJECT op te vragen is. title: link maxLength: 200 beschrijving: type: string description: Een generieke beschrijving van de inhoud van het INFORMATIEOBJECT. title: beschrijving maxLength: 1000 ontvangstdatum: type: - string - 'null' format: date description: "**DEPRECATED** Dit attribuut is verplaatst naar resource Verzending. \n\n 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." title: ontvangstdatum verzenddatum: type: - string - 'null' format: date description: "**DEPRECATED** Dit attribuut is verplaatst naar resource Verzending. \n\n 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." title: verzenddatum indicatieGebruiksrecht: type: - boolean - 'null' 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. title: indicatie gebruiksrecht verschijningsvorm: type: string description: De essentiële opmaakaspecten van een INFORMATIEOBJECT. title: verschijningsvorm ondertekening: allOf: - $ref: '#/components/schemas/OndertekeningRequest' 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. title: ondertekening integriteit: allOf: - $ref: '#/components/schemas/IntegriteitRequest' description: Uitdrukking van mate van volledigheid en onbeschadigd zijn van digitaal bestand. title: integriteit informatieobjecttype: type: string format: uri minLength: 1 description: URL-referentie naar het INFORMATIEOBJECTTYPE (in de Catalogi API). title: informatieobjecttype maxLength: 200 trefwoorden: type: - array - 'null' items: type: string minLength: 1 maxLength: 100 description: Een lijst van trefwoorden gescheiden door comma's. title: trefwoorden inhoudIsVervallen: type: - boolean - 'null' description: Geeft aan of de inhoud van het informatieobject vervallen (dus niet langer geldig) is. title: inhoud is vervallen required: - auteur - bronorganisatie - creatiedatum - informatieobjecttype - taal - titel BlankEnum: enum: - '' LockEnkelvoudigInformatieObject: type: object description: 'Serializer for the lock action of EnkelvoudigInformatieObjectCanonical model' properties: lock: type: string readOnly: true description: Hash string, wordt gebruikt als ID voor de lock title: lock required: - lock PatchedEnkelvoudigInformatieObjectWithLockRequest: type: object description: 'This serializer class is used by EnkelvoudigInformatieObjectViewSet for update and partial_update operations' properties: identificatie: type: string description: Een binnen een gegeven context ondubbelzinnige referentie naar het INFORMATIEOBJECT. title: identificatie maxLength: 40 bronorganisatie: type: string minLength: 1 description: Het RSIN van de Niet-natuurlijk persoon zijnde de organisatie die het informatieobject heeft gecreëerd of heeft ontvangen en als eerste in een samenwerkingsketen heeft vastgelegd. title: bronorganisatie maxLength: 9 creatiedatum: type: string format: date description: Een datum of een gebeurtenis in de levenscyclus van het INFORMATIEOBJECT. title: creatiedatum titel: type: string minLength: 1 description: De naam waaronder het INFORMATIEOBJECT formeel bekend is. title: titel maxLength: 200 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' title: vertrouwelijkheidaanduiding oneOf: - $ref: '#/components/schemas/VertrouwelijkheidaanduidingEnum' - $ref: '#/components/schemas/BlankEnum' auteur: type: string minLength: 1 description: De persoon of organisatie die in de eerste plaats verantwoordelijk is voor het creëren van de inhoud van het INFORMATIEOBJECT. title: auteur maxLength: 200 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. * `concept` - (Concept) Het document is inhoudelijk klaar om voorgelegd teworden aan anderen en zo nodig aangepast te worden opbasis van commentaar.. * `definitief` - (Definitief) Informatieobject door bevoegd iets of iemand vastgesteld dan wel ontvangen. * `ter_vaststelling` - (Ter vaststelling) Informatieobject gereed maar moet nog vastgesteld worden. * `vastgesteld` - (Vastgesteld) Het besluitvormingstraject is afgerond. * `gearchiveerd` - (Gearchiveerd) Informatieobject duurzaam bewaarbaar gemaakt; een gearchiveerd informatie-element.' title: status oneOf: - $ref: '#/components/schemas/StatusEnum' - $ref: '#/components/schemas/BlankEnum' formaat: type: string 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' title: formaat maxLength: 255 taal: type: string minLength: 3 description: 'Een ISO 639-2/B taalcode waarin de inhoud van het INFORMATIEOBJECT is vastgelegd. Voorbeeld: `dut`. Zie: https://www.iso.org/standard/4767.html' title: taal maxLength: 3 bestandsnaam: type: string description: De naam van het fysieke bestand waarin de inhoud van het informatieobject is vastgelegd, inclusief extensie. title: bestandsnaam maxLength: 255 inhoud: type: - string - 'null' format: byte description: Binaire inhoud, in base64 geëncodeerd. title: inhoud bestandsomvang: type: - integer - 'null' maximum: 9223372036854775807 minimum: 0 format: int64 description: Aantal bytes dat de inhoud van INFORMATIEOBJECT in beslag neemt. title: bestandsomvang link: type: string format: uri description: De URL waarmee de inhoud van het INFORMATIEOBJECT op te vragen is. title: link maxLength: 200 beschrijving: type: string description: Een generieke beschrijving van de inhoud van het INFORMATIEOBJECT. title: beschrijving maxLength: 1000 ontvangstdatum: type: - string - 'null' format: date description: "**DEPRECATED** Dit attribuut is verplaatst naar resource Verzending. \n\n 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." title: ontvangstdatum verzenddatum: type: - string - 'null' format: date description: "**DEPRECATED** Dit attribuut is verplaatst naar resource Verzending. \n\n 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." title: verzenddatum indicatieGebruiksrecht: type: - boolean - 'null' 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. title: indicatie gebruiksrecht verschijningsvorm: type: string description: De essentiële opmaakaspecten van een INFORMATIEOBJECT. title: verschijningsvorm ondertekening: allOf: - $ref: '#/components/schemas/OndertekeningRequest' 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. title: ondertekening integriteit: allOf: - $ref: '#/components/schemas/IntegriteitRequest' description: Uitdrukking van mate van volledigheid en onbeschadigd zijn van digitaal bestand. title: integriteit informatieobjecttype: type: string format: uri minLength: 1 description: URL-referentie naar het INFORMATIEOBJECTTYPE (in de Catalogi API). title: informatieobjecttype maxLength: 200 trefwoorden: type: - array - 'null' items: type: string minLength: 1 maxLength: 100 description: Een lijst van trefwoorden gescheiden door comma's. title: trefwoorden inhoudIsVervallen: type: - boolean - 'null' description: Geeft aan of de inhoud van het informatieobject vervallen (dus niet langer geldig) is. title: inhoud is vervallen lock: type: string writeOnly: true minLength: 1 description: Tijdens het updaten van een document (PATCH, PUT) moet het `lock` veld opgegeven worden. Bij het aanmaken (POST) mag het geen waarde hebben. title: lock VertrouwelijkheidaanduidingEnum: enum: - openbaar - beperkt_openbaar - intern - zaakvertrouwelijk - vertrouwelijk - confidentieel - geheim - zeer_geheim type: string FieldValidationError: type: object description: Formaat van validatiefouten. properties: name: type: string description: Naam van het veld met ongeldige gegevens title: name code: type: string description: Systeemcode die het type fout aangeeft title: code reason: type: string description: Uitleg wat er precies fout is met de gegevens title: reason required: - code - name - reason OndertekeningRequest: type: - object - 'null' 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. properties: soort: allOf: - $ref: '#/components/schemas/SoortEnum' title: Ondertekeningsoort description: 'Aanduiding van de wijze van ondertekening van het INFORMATIEOBJECT Uitleg bij mogelijke waarden: * `analoog` - Analoog * `digitaal` - Digitaal * `pki` - PKI' datum: type: string format: date title: Ondertekeningdatum description: De datum waarop de ondertekening van het INFORMATIEOBJECT heeft plaatsgevonden. required: - datum - soort Ondertekening: type: - object - 'null' 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. properties: soort: allOf: - $ref: '#/components/schemas/SoortEnum' title: Ondertekeningsoort description: 'Aanduiding van de wijze van ondertekening van het INFORMATIEOBJECT Uitleg bij mogelijke waarden: * `analoog` - Analoog * `digitaal` - Digitaal * `pki` - PKI' datum: type: string format: date title: Ondertekeningdatum description: De datum waarop de ondertekening van het INFORMATIEOBJECT heeft plaatsgevonden. required: - datum - soort IntegriteitRequest: type: - object - 'null' description: Uitdrukking van mate van volledigheid en onbeschadigd zijn van digitaal bestand. properties: algoritme: allOf: - $ref: '#/components/schemas/AlgoritmeEnum' 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' title: integriteit algoritme waarde: type: string minLength: 1 description: De waarde van de checksum. title: integriteit waarde maxLength: 128 datum: type: string format: date description: Datum waarop de checksum is gemaakt. title: integriteit datum required: - algoritme - datum - waarde Integriteit: type: - object - 'null' description: Uitdrukking van mate van volledigheid en onbeschadigd zijn van digitaal bestand. properties: algoritme: allOf: - $ref: '#/components/schemas/AlgoritmeEnum' 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' title: integriteit algoritme waarde: type: string description: De waarde van de checksum. title: integriteit waarde maxLength: 128 datum: type: string format: date description: Datum waarop de checksum is gemaakt. title: integriteit datum required: - algoritme - datum - waarde StatusEnum: enum: - in_bewerking - concept - definitief - ter_vaststelling - vastgesteld - gearchiveerd type: string ValidatieFout: type: object description: Formaat van HTTP 4xx en 5xx fouten. properties: type: type: string description: URI referentie naar het type fout, bedoeld voor developers title: type code: type: string description: Systeemcode die het type fout aangeeft title: code title: type: string description: Generieke titel voor het type fout title: title status: type: integer description: De HTTP status code title: status detail: type: string description: Extra informatie bij de fout, indien beschikbaar title: detail instance: type: string description: URI met referentie naar dit specifiek voorkomen van de fout. Deze kan gebruikt worden in combinatie met server logs, bijvoorbeeld. title: instance invalidParams: type: array items: $ref: '#/components/schemas/FieldValidationError' title: invalidParams required: - code - detail - instance - invalidParams - status - title SoortEnum: enum: - analoog - digitaal - pki type: string UnlockEnkelvoudigInformatieObjectRequest: type: object description: 'Serializer for the unlock action of EnkelvoudigInformatieObjectCanonical model' properties: lock: type: string description: Hash string, wordt gebruikt als ID voor de lock title: lock maxLength: 100 EnkelvoudigInformatieObjectWithLock: type: object description: 'This serializer class is used by EnkelvoudigInformatieObjectViewSet for update and partial_update operations' properties: url: type: string format: uri readOnly: true title: url description: URL-referentie naar dit object. Dit is de unieke identificatie en locatie van dit object. minLength: 1 maxLength: 1000 identificatie: type: string description: Een binnen een gegeven context ondubbelzinnige referentie naar het INFORMATIEOBJECT. title: identificatie maxLength: 40 bronorganisatie: type: string description: Het RSIN van de Niet-natuurlijk persoon zijnde de organisatie die het informatieobject heeft gecreëerd of heeft ontvangen en als eerste in een samenwerkingsketen heeft vastgelegd. title: bronorganisatie maxLength: 9 creatiedatum: type: string format: date description: Een datum of een gebeurtenis in de levenscyclus van het INFORMATIEOBJECT. title: creatiedatum titel: type: string description: De naam waaronder het INFORMATIEOBJECT formeel bekend is. title: titel maxLength: 200 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' title: vertrouwelijkheidaanduiding oneOf: - $ref: '#/components/schemas/VertrouwelijkheidaanduidingEnum' - $ref: '#/components/schemas/BlankEnum' auteur: type: string description: De persoon of organisatie die in de eerste plaats verantwoordelijk is voor het creëren van de inhoud van het INFORMATIEOBJECT. title: auteur maxLength: 200 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. * `concept` - (Concept) Het document is inhoudelijk klaar om voorgelegd teworden aan anderen en zo nodig aangepast te worden opbasis van commentaar.. * `definitief` - (Definitief) Informatieobject door bevoegd iets of iemand vastgesteld dan wel ontvangen. * `ter_vaststelling` - (Ter vaststelling) Informatieobject gereed maar moet nog vastgesteld worden. * `vastgesteld` - (Vastgesteld) Het besluitvormingstraject is afgerond. * `gearchiveerd` - (Gearchiveerd) Informatieobject duurzaam bewaarbaar gemaakt; een gearchiveerd informatie-element.' title: status oneOf: - $ref: '#/components/schemas/StatusEnum' - $ref: '#/components/schemas/BlankEnum' formaat: type: string 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' title: formaat maxLength: 255 taal: type: string description: 'Een ISO 639-2/B taalcode waarin de inhoud van het INFORMATIEOBJECT is vastgelegd. Voorbeeld: `dut`. Zie: https://www.iso.org/standard/4767.html' title: taal maxLength: 3 minLength: 3 versie: type: integer readOnly: true description: Het (automatische) versienummer van het INFORMATIEOBJECT. Deze begint bij 1 als het INFORMATIEOBJECT aangemaakt wordt. title: versie beginRegistratie: type: string format: date-time readOnly: true description: Een datumtijd in ISO8601 formaat waarop deze versie van het INFORMATIEOBJECT is aangemaakt of gewijzigd. title: begin registratie bestandsnaam: type: string description: De naam van het fysieke bestand waarin de inhoud van het informatieobject is vastgelegd, inclusief extensie. title: bestandsnaam maxLength: 255 inhoud: type: - string - 'null' format: uri description: Download URL van de binaire inhoud. title: inhoud bestandsomvang: type: - integer - 'null' maximum: 9223372036854775807 minimum: 0 format: int64 description: Aantal bytes dat de inhoud van INFORMATIEOBJECT in beslag neemt. title: bestandsomvang link: type: string format: uri description: De URL waarmee de inhoud van het INFORMATIEOBJECT op te vragen is. title: link maxLength: 200 beschrijving: type: string description: Een generieke beschrijving van de inhoud van het INFORMATIEOBJECT. title: beschrijving maxLength: 1000 ontvangstdatum: type: - string - 'null' format: date description: "**DEPRECATED** Dit attribuut is verplaatst naar resource Verzending. \n\n 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." title: ontvangstdatum verzenddatum: type: - string - 'null' format: date description: "**DEPRECATED** Dit attribuut is verplaatst naar resource Verzending. \n\n 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." title: verzenddatum indicatieGebruiksrecht: type: - boolean - 'null' 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. title: indicatie gebruiksrecht verschijningsvorm: type: string description: De essentiële opmaakaspecten van een INFORMATIEOBJECT. title: verschijningsvorm ondertekening: allOf: - $ref: '#/components/schemas/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. title: ondertekening integriteit: allOf: - $ref: '#/components/schemas/Integriteit' description: Uitdrukking van mate van volledigheid en onbeschadigd zijn van digitaal bestand. title: integriteit informatieobjecttype: type: string format: uri description: URL-referentie naar het INFORMATIEOBJECTTYPE (in de Catalogi API). title: informatieobjecttype maxLength: 200 locked: type: boolean readOnly: true description: Geeft aan of het document gelocked is. Alleen als een document gelocked is, mogen er aanpassingen gemaakt worden. title: locked bestandsdelen: type: array items: $ref: '#/components/schemas/BestandsDeel' readOnly: true title: bestandsdelen trefwoorden: type: - array - 'null' items: type: string maxLength: 100 description: Een lijst van trefwoorden gescheiden door comma's. title: trefwoorden inhoudIsVervallen: type: - boolean - 'null' description: Geeft aan of de inhoud van het informatieobject vervallen (dus niet langer geldig) is. title: inhoud is vervallen required: - auteur - beginRegistratie - bestandsdelen - bronorganisatie - creatiedatum - informatieobjecttype - locked - taal - titel - url - versie AuditTrail: type: object properties: uuid: type: string format: uuid description: Unieke identificatie van de audit regel. title: uuid bron: allOf: - $ref: '#/components/schemas/BronEnum' 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 * `cmc` - Contactmomenten API * `kc` - Klanten API * `vrc` - Verzoeken API' title: bron applicatieId: type: string description: Unieke identificatie van de applicatie, binnen de organisatie. title: applicatie id maxLength: 100 applicatieWeergave: type: string description: Vriendelijke naam van de applicatie. title: applicatie weergave maxLength: 200 gebruikersId: type: string description: Unieke identificatie van de gebruiker die binnen de organisatie herleid kan worden naar een persoon. title: gebruikers id maxLength: 255 gebruikersWeergave: type: string description: Vriendelijke naam van de gebruiker. title: gebruikers weergave maxLength: 255 actie: type: string 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' title: actie maxLength: 50 actieWeergave: type: string description: Vriendelijke naam van de actie. title: actie weergave maxLength: 200 resultaat: type: integer maximum: 599 minimum: 100 description: HTTP status code van de API response van de uitgevoerde handeling. title: resultaat hoofdObject: type: string format: uri description: De URL naar het hoofdobject van een component. title: hoofd object maxLength: 1000 resource: type: string description: Het type resource waarop de actie gebeurde. title: resource maxLength: 50 resourceUrl: type: string format: uri description: De URL naar het object. title: resource url maxLength: 1000 toelichting: type: string description: Toelichting waarom de handeling is uitgevoerd. title: toelichting resourceWeergave: type: string description: Vriendelijke identificatie van het object. title: resource weergave maxLength: 200 aanmaakdatum: type: string format: date-time readOnly: true description: De datum waarop de handeling is gedaan. title: aanmaakdatum wijzigingen: allOf: - $ref: '#/components/schemas/Wijzigingen' title: wijzigingen required: - aanmaakdatum - actie - bron - hoofdObject - resource - resourceUrl - resourceWeergave - resultaat - wijzigingen SchemaEIO: type: object description: Serializer for the EnkelvoudigInformatieObject model properties: url: type: string format: uri readOnly: true title: url description: URL-referentie naar dit object. Dit is de unieke identificatie en locatie van dit object. minLength: 1 maxLength: 1000 identificatie: type: string description: Een binnen een gegeven context ondubbelzinnige referentie naar het INFORMATIEOBJECT. title: identificatie maxLength: 40 bronorganisatie: type: string description: Het RSIN van de Niet-natuurlijk persoon zijnde de organisatie die het informatieobject heeft gecreëerd of heeft ontvangen en als eerste in een samenwerkingsketen heeft vastgelegd. title: bronorganisatie maxLength: 9 creatiedatum: type: string format: date description: Een datum of een gebeurtenis in de levenscyclus van het INFORMATIEOBJECT. title: creatiedatum titel: type: string description: De naam waaronder het INFORMATIEOBJECT formeel bekend is. title: titel maxLength: 200 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' title: vertrouwelijkheidaanduiding oneOf: - $ref: '#/components/schemas/VertrouwelijkheidaanduidingEnum' - $ref: '#/components/schemas/BlankEnum' auteur: type: string description: De persoon of organisatie die in de eerste plaats verantwoordelijk is voor het creëren van de inhoud van het INFORMATIEOBJECT. title: auteur maxLength: 200 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. * `concept` - (Concept) Het document is inhoudelijk klaar om voorgelegd teworden aan anderen en zo nodig aangepast te worden opbasis van commentaar.. * `definitief` - (Definitief) Informatieobject door bevoegd iets of iemand vastgesteld dan wel ontvangen. * `ter_vaststelling` - (Ter vaststelling) Informatieobject gereed maar moet nog vastgesteld worden. * `vastgesteld` - (Vastgesteld) Het besluitvormingstraject is afgerond. * `gearchiveerd` - (Gearchiveerd) Informatieobject duurzaam bewaarbaar gemaakt; een gearchiveerd informatie-element.' title: status oneOf: - $ref: '#/components/schemas/StatusEnum' - $ref: '#/components/schemas/BlankEnum' formaat: type: string 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' title: formaat maxLength: 255 taal: type: string description: 'Een ISO 639-2/B taalcode waarin de inhoud van het INFORMATIEOBJECT is vastgelegd. Voorbeeld: `dut`. Zie: https://www.iso.org/standard/4767.html' title: taal maxLength: 3 minLength: 3 versie: type: integer readOnly: true description: Het (automatische) versienummer van het INFORMATIEOBJECT. Deze begint bij 1 als het INFORMATIEOBJECT aangemaakt wordt. title: versie beginRegistratie: type: string format: date-time readOnly: true description: Een datumtijd in ISO8601 formaat waarop deze versie van het INFORMATIEOBJECT is aangemaakt of gewijzigd. title: begin registratie bestandsnaam: type: string description: De naam van het fysieke bestand waarin de inhoud van het informatieobject is vastgelegd, inclusief extensie. title: bestandsnaam maxLength: 255 inhoud: type: - string - 'null' format: uri description: Download URL van de binaire inhoud. title: inhoud bestandsomvang: type: - integer - 'null' maximum: 9223372036854775807 minimum: 0 format: int64 description: Aantal bytes dat de inhoud van INFORMATIEOBJECT in beslag neemt. title: bestandsomvang link: type: string format: uri description: De URL waarmee de inhoud van het INFORMATIEOBJECT op te vragen is. title: link maxLength: 200 beschrijving: type: string description: Een generieke beschrijving van de inhoud van het INFORMATIEOBJECT. title: beschrijving maxLength: 1000 ontvangstdatum: type: - string - 'null' format: date description: "**DEPRECATED** Dit attribuut is verplaatst naar resource Verzending. \n\n 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." title: ontvangstdatum verzenddatum: type: - string - 'null' format: date description: "**DEPRECATED** Dit attribuut is verplaatst naar resource Verzending. \n\n 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." title: verzenddatum indicatieGebruiksrecht: type: - boolean - 'null' 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. title: indicatie gebruiksrecht verschijningsvorm: type: string description: De essentiële opmaakaspecten van een INFORMATIEOBJECT. title: verschijningsvorm ondertekening: allOf: - $ref: '#/components/schemas/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. title: ondertekening integriteit: allOf: - $ref: '#/components/schemas/Integriteit' description: Uitdrukking van mate van volledigheid en onbeschadigd zijn van digitaal bestand. title: integriteit informatieobjecttype: type: string format: uri description: URL-referentie naar het INFORMATIEOBJECTTYPE (in de Catalogi API). title: informatieobjecttype maxLength: 200 locked: type: boolean readOnly: true description: Geeft aan of het document gelocked is. Alleen als een document gelocked is, mogen er aanpassingen gemaakt worden. title: locked bestandsdelen: type: array items: $ref: '#/components/schemas/SchemaBestandsDeel' readOnly: true title: bestandsdelen trefwoorden: type: - array - 'null' items: type: string maxLength: 100 description: Een lijst van trefwoorden gescheiden door comma's. title: trefwoorden inhoudIsVervallen: type: - boolean - 'null' description: Geeft aan of de inhoud van het informatieobject vervallen (dus niet langer geldig) is. title: inhoud is vervallen required: - auteur - beginRegistratie - bestandsdelen - bronorganisatie - creatiedatum - informatieobjecttype - locked - taal - titel - url - versie EIOZoekRequest: type: object properties: uuid_In: type: array items: type: string format: uuid title: '' description: Array of unieke resource identifiers (UUID4) title: uuid__in expand: type: string minLength: 1 description: "Examples: \n`expand=zaaktype, status, status.statustype, hoofdzaak.status.statustype, hoofdzaak.deelzaken.status.statustype`\nHaal details van gelinkte resources direct op. Als je meerdere resources tegelijk wilt ophalen kun je deze scheiden met een komma. Voor het ophalen van resources die een laag dieper genest zijn wordt de punt-notatie gebruikt." title: expand required: - uuid_In AlgoritmeEnum: 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 type: string securitySchemes: JWT-Claims: type: http bearerFormat: JWT scheme: bearer x-refined-from: - vng-realisatie-documenten-openapi.yml - vng-realisatie-documenten-openapi.yml