VNG Realisatie Documenten API

Een API om een documentregistratiecomponent (DRC) te benaderen.

GitHub OpenAPI

Operations 33

PUT /bestandsdelen/{uuid} Upload een bestandsdeel. #
GET /enkelvoudiginformatieobjecten Alle (ENKELVOUDIGe) INFORMATIEOBJECTen opvragen. #
POST /enkelvoudiginformatieobjecten Maak een (ENKELVOUDIG) INFORMATIEOBJECT aan. #
GET /enkelvoudiginformatieobjecten/{enkelvoudiginformatieobject_uuid}/audittrail Alle audit trail regels behorend bij het INFORMATIEOBJECT. #
GET /enkelvoudiginformatieobjecten/{enkelvoudiginformatieobject_uuid}/audittrail/{uuid} Een specifieke audit trail regel opvragen. #
GET /enkelvoudiginformatieobjecten/{uuid} Een specifiek (ENKELVOUDIG) INFORMATIEOBJECT opvragen. #
PUT /enkelvoudiginformatieobjecten/{uuid} Werk een (ENKELVOUDIG) INFORMATIEOBJECT in zijn geheel bij. #
PATCH /enkelvoudiginformatieobjecten/{uuid} Werk een (ENKELVOUDIG) INFORMATIEOBJECT deels bij. #
DELETE /enkelvoudiginformatieobjecten/{uuid} Verwijder een (ENKELVOUDIG) INFORMATIEOBJECT. #
HEAD /enkelvoudiginformatieobjecten/{uuid} De headers voor een specifiek(e) ENKELVOUDIG INFORMATIE OBJECT opvragen #
GET /enkelvoudiginformatieobjecten/{uuid}/download Download de binaire data van het (ENKELVOUDIG) INFORMATIEOBJECT. #
POST /enkelvoudiginformatieobjecten/{uuid}/lock Vergrendel een (ENKELVOUDIG) INFORMATIEOBJECT. #
POST /enkelvoudiginformatieobjecten/{uuid}/unlock Ontgrendel een (ENKELVOUDIG) INFORMATIEOBJECT. #
POST /enkelvoudiginformatieobjecten/_zoek Voer een zoekopdracht uit op (ENKELVOUDIG) INFORMATIEOBJECTen. #
GET /gebruiksrechten Alle GEBRUIKSRECHTen opvragen. #
POST /gebruiksrechten Maak een GEBRUIKSRECHT aan. #
GET /gebruiksrechten/{uuid} Een specifieke GEBRUIKSRECHT opvragen. #
PUT /gebruiksrechten/{uuid} Werk een GEBRUIKSRECHT in zijn geheel bij. #
PATCH /gebruiksrechten/{uuid} Werk een GEBRUIKSRECHT relatie deels bij. #
DELETE /gebruiksrechten/{uuid} Verwijder een GEBRUIKSRECHT. #
HEAD /gebruiksrechten/{uuid} De headers voor een specifiek(e) GEBRUIKSRECHT INFORMATIEOBJECT opvragen #
GET /objectinformatieobjecten Alle OBJECT-INFORMATIEOBJECT relaties opvragen. #
POST /objectinformatieobjecten Maak een OBJECT-INFORMATIEOBJECT relatie aan. #
GET /objectinformatieobjecten/{uuid} Een specifieke OBJECT-INFORMATIEOBJECT relatie opvragen. #
DELETE /objectinformatieobjecten/{uuid} Verwijder een OBJECT-INFORMATIEOBJECT relatie. #
HEAD /objectinformatieobjecten/{uuid} De headers voor een specifiek(e) OOBJECT-INFORMATIEOBJECT opvragen #
GET /verzendingen Alle VERZENDINGen opvragen. #
POST /verzendingen Maak een VERZENDING aan. #
GET /verzendingen/{uuid} Een specifieke VERZENDING opvragen. #
PUT /verzendingen/{uuid} Werk een VERZENDING in zijn geheel bij. #
PATCH /verzendingen/{uuid} Werk een VERZENDING relatie deels bij. #
DELETE /verzendingen/{uuid} Verwijder een VERZENDING #
HEAD /verzendingen/{uuid} De headers voor een specifiek(e) VERZENDING opvragen #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/vng-realisatie:vng-realisatie-documenten-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

vng-realisatie-documenten-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Documenten API
  version: 1.5.0
  description: "Een API om een documentregistratiecomponent (DRC) te benaderen.\n\nIn een documentregistratiecomponent worden INFORMATIEOBJECTen opgeslagen. Een\nINFORMATIEOBJECT is een digitaal document voorzien van meta-gegevens.\nINFORMATIEOBJECTen kunnen aan andere objecten zoals zaken en besluiten worden\ngerelateerd (maar dat hoeft niet) en kunnen gebruiksrechten hebben.\n\nGEBRUIKSRECHTEN leggen voorwaarden op aan het gebruik van het INFORMATIEOBJECT\n(buiten raadpleging). Deze GEBRUIKSRECHTEN worden niet door de API gevalideerd\nof gehandhaafd.\n\nDe typering van INFORMATIEOBJECTen is in de Catalogi API (ZTC) ondergebracht in\nde vorm van INFORMATIEOBJECTTYPEn.\n\n**Uploaden van bestanden**\n\nBinnen deze API bestaan een aantal endpoints die binaire data ontvangen, al\ndan niet base64-encoded. Webservers moeten op deze endpoints een minimale\nrequest body size van 4.0 GiB ondersteunen. Dit omvat de JSON van de\nmetadata EN de base64-encoded bestandsdata. Hou hierbij rekening met de\noverhead van base64, die ongeveer 33% bedraagt in worst-case scenario's. Dit\nbetekent dat bij een limiet van 4GB het bestand maximaal ongeveer 3GB groot\nmag zijn.\n\n_Nieuw in 1.1.0_\n\nBestanden kunnen groter zijn dan de minimale die door providers\nondersteund moet worden. De consumer moet dan:\n\n1. Het INFORMATIEOBJECT aanmaken in de API, waarbij de totale bestandsgrootte\n   meegestuurd wordt en de inhoud leeggelaten wordt.\n   De API antwoordt met een lijst van BESTANDSDEELen, elk met een volgnummer\n   en bestandsgrootte. De API lockt tegelijkertijd het INFORMATIEOBJECT.\n2. Het bestand opsplitsen: ieder BESTANDSDEEL moet de bestandsgrootte hebben\n   zoals dit aangegeven werd in de response bij 1.\n3. Voor elk stuk van het bestand de binaire data naar de overeenkomstige\n   BESTANDSDEEL-url gestuurd worden, samen met het lock ID.\n4. Het INFORMATIEOBJECT unlocken. De provider valideert op dat moment dat alle\n   bestandsdelen correct opgestuurd werden, en voegt deze samen tot het\n   resulterende bestand.\n\nHet bijwerken van een INFORMATIEOBJECT heeft een gelijkaardig verloop.\n\nDe 1.0.x manier van uploaden is ook beschikbaar voor kleine(re) bestanden die\nniet gesplitst hoeven te worden.\n\n**Afhankelijkheden**\n\nDeze API is afhankelijk van:\n\n* Catalogi API\n* Notificaties API\n* Autorisaties API *(optioneel)*\n* Zaken API *(optioneel)*\n\n**Autorisatie**\n\nDeze API vereist autorisatie. Je kan de\n[token-tool](https://zaken-auth.vng.cloud/) gebruiken om JWT-tokens te\ngenereren.\n\n### Notificaties\n\nDeze API publiceert notificaties op het kanaal `documenten`.\n\n**Main resource**\n\n`enkelvoudiginformatieobject`\n\n\n\n**Kenmerken**\n\n* `bronorganisatie`: Het RSIN van de Niet-natuurlijk persoon zijnde de organisatie die het informatieobject heeft gecreëerd of heeft ontvangen en als eerste in een samenwerkingsketen heeft vastgelegd.\n* `informatieobjecttype`: URL-referentie naar het INFORMATIEOBJECTTYPE (in de Catalogi API).\n* `vertrouwelijkheidaanduiding`: Aanduiding van de mate waarin het INFORMATIEOBJECT voor de openbaarheid bestemd is.\n\n**Resources en acties**\n\n\n**Handige links**\n\n* [Documentatie](https://vng-realisatie.github.io/gemma-zaken/standaard)\n* [Zaakgericht werken](https://vng-realisatie.github.io/gemma-zaken)\n"
  contact:
    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
paths:
  /bestandsdelen/{uuid}:
    put:
      operationId: bestandsdeel_update
      description: based on DRF mixin but without partial_update
      summary: Upload een bestandsdeel.
      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/x-www-form-urlencoded
          - multipart/form-data
        description: Content type van de verzoekinhoud.
        required: true
      tags:
      - bestandsdelen
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/BestandsDeelRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/BestandsDeelRequest'
        required: true
      security:
      - JWT-Claims:
        - documenten.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/BestandsDeelResponse'
          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
  /enkelvoudiginformatieobjecten:
    get:
      operationId: enkelvoudiginformatieobject_list
      description: "Deze lijst kan gefilterd wordt met query-string parameters. \nDe 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** \n - geldigheid `informatieobjecttype` URL - de resource moet opgevraagd kunnen worden uit de catalogi API en de vorm van een INFORMATIEOBJECTTYPE hebben. \n- 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
  /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
  /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
  /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 g

# --- truncated at 32 KB (265 KB total) ---
# Full source: https://artifacts.apis.io/vng-realisatie/openapi/vng-realisatie-documenten-openapi.yml