openapi: 3.2.0
info:
  title: Vng Realisatie Zaakobjecten API
  version: 1.5.1
  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 zaakobjecten across 2 of this provider''s published API definitions: vng-realisatie-zaken-openapi.yml, vng-realisatie-zaken-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://zaken-api.vng.cloud/api/v1/
  description: Productie Omgeving
tags:
- name: zaakobjecten
  description: ''
paths:
  /zaakobjecten:
    get:
      operationId: zaakobject_list
      description: Deze lijst kan gefilterd wordt met query-string parameters.
      summary: Alle ZAAKOBJECTen opvragen
      parameters:
      - name: zaak
        required: false
        in: query
        description: URL-referentie naar de ZAAK.
        schema:
          type: string
          format: uri
      - name: object
        required: false
        in: query
        description: URL-referentie naar de resource die het OBJECT beschrijft.
        schema:
          type: string
          format: uri
      - name: objectType
        required: false
        in: query
        description: Beschrijft het type OBJECT gerelateerd aan de ZAAK. Als er geen passend type is, dan moet het type worden opgegeven onder `objectTypeOverige`.
        schema:
          type: string
          enum:
          - adres
          - besluit
          - buurt
          - enkelvoudig_document
          - gemeente
          - gemeentelijke_openbare_ruimte
          - huishouden
          - inrichtingselement
          - kadastrale_onroerende_zaak
          - kunstwerkdeel
          - maatschappelijke_activiteit
          - medewerker
          - natuurlijk_persoon
          - niet_natuurlijk_persoon
          - openbare_ruimte
          - organisatorische_eenheid
          - pand
          - spoorbaandeel
          - status
          - terreindeel
          - terrein_gebouwd_object
          - vestiging
          - waterdeel
          - wegdeel
          - wijk
          - woonplaats
          - woz_deelobject
          - woz_object
          - woz_waarde
          - zakelijk_recht
          - overige
      - name: page
        required: false
        in: query
        description: Een pagina binnen de gepagineerde set resultaten.
        schema:
          type: integer
      tags:
      - zaakobjecten
      security:
      - JWT-Claims:
        - zaken.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/PaginatedZaakObjectList'
          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: zaakobject_create
      description: 'Maak een ZAAKOBJECT aan.


        **Er wordt gevalideerd op**

        - Indien de `object` URL opgegeveven is, dan moet deze een geldige response (HTTP 200) geven.

        - Indien opgegeven, dan wordt `objectIdentificatie` gevalideerd tegen de `objectType` discriminator.'
      summary: Maak een ZAAKOBJECT 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:
      - zaakobjecten
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ZaakObject'
        required: true
      security:
      - JWT-Claims:
        - (zaken.aanmaken | zaken.bijwerken | zaken.geforceerd-bijwerken)
      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/ZaakObject'
          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://zaken-api.vng.cloud/api/v1/
      description: Productie Omgeving
  /zaakobjecten/{uuid}:
    get:
      operationId: zaakobject_retrieve
      description: Een specifieke ZAAKOBJECT opvragen.
      summary: Een specifieke ZAAKOBJECT 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:
      - zaakobjecten
      security:
      - JWT-Claims:
        - zaken.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/ZaakObject'
          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: zaakobject_update
      description: '**Er wordt gevalideerd op**

        - De attributen `zaak`, `object` en `objectType` mogen niet gewijzigd worden.

        - Indien opgegeven, dan wordt `objectIdentificatie` gevalideerd tegen de objectType discriminator.'
      summary: Werk een ZAAKOBJECT 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
      tags:
      - zaakobjecten
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ZaakObject'
        required: true
      security:
      - JWT-Claims:
        - (zaken.bijwerken | zaken.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/ZaakObject'
          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: zaakobject_partial_update
      description: '**Er wordt gevalideerd op**

        - De attributen `zaak`, `object` en `objectType` mogen niet gewijzigd worden.

        - Indien opgegeven, dan wordt `objectIdentificatie` gevalideerd tegen de objectType discriminator.'
      summary: Werk een ZAAKOBJECT 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
      tags:
      - zaakobjecten
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedZaakObject'
      security:
      - JWT-Claims:
        - (zaken.bijwerken | zaken.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/ZaakObject'
          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: zaakobject_destroy
      description: Verbreek de relatie tussen een ZAAK en een OBJECT door de ZAAKOBJECT resource te verwijderen.
      summary: Verwijder een ZAAKOBJECT
      parameters:
      - in: path
        name: uuid
        schema:
          type: string
          format: uuid
          description: Unieke resource identifier (UUID4)
          title: uuid
        required: true
      tags:
      - zaakobjecten
      security:
      - JWT-Claims:
        - (zaken.bijwerken | zaken.geforceerd-bijwerken | zaken.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: zaakobject_headers
      description: Vraag de headers op die je bij een GET request zou krijgen.
      summary: De headers voor een specifiek(e) ZAAKOBJECT 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:
      - zaakobjecten
      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/ZaakObject'
          description: OK
    servers:
    - url: https://zaken-api.vng.cloud/api/v1/
      description: Productie Omgeving
components:
  schemas:
    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
    PaginatedZaakObjectList:
      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/ZaakObject'
    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
    ZaakObject:
      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
        uuid:
          type: string
          format: uuid
          readOnly: true
          description: Unieke resource identifier (UUID4)
          title: uuid
        zaak:
          type: string
          format: uri
          description: URL-referentie naar de ZAAK.
          title: zaak
          minLength: 1
          maxLength: 1000
        object:
          type: string
          format: uri
          description: URL-referentie naar de resource die het OBJECT beschrijft.
          title: object
          maxLength: 1000
        zaakobjecttype:
          type: string
          format: uri
          description: URL-referentie naar het ZAAKOBJECTTYPE (in de Catalogi API).
          title: zaakobjecttype
          maxLength: 1000
        objectType:
          allOf:
          - $ref: '#/components/schemas/ObjectTypeEnum'
          description: 'Beschrijft het type OBJECT gerelateerd aan de ZAAK. Als er geen passend type is, dan moet het type worden opgegeven onder `objectTypeOverige`.


            Uitleg bij mogelijke waarden:


            * `adres` - Adres

            * `besluit` - Besluit

            * `buurt` - Buurt

            * `enkelvoudig_document` - Enkelvoudig document

            * `gemeente` - Gemeente

            * `gemeentelijke_openbare_ruimte` - Gemeentelijke openbare ruimte

            * `huishouden` - Huishouden

            * `inrichtingselement` - Inrichtingselement

            * `kadastrale_onroerende_zaak` - Kadastrale onroerende zaak

            * `kunstwerkdeel` - Kunstwerkdeel

            * `maatschappelijke_activiteit` - Maatschappelijke activiteit

            * `medewerker` - Medewerker

            * `natuurlijk_persoon` - Natuurlijk persoon

            * `niet_natuurlijk_persoon` - Niet-natuurlijk persoon

            * `openbare_ruimte` - Openbare ruimte

            * `organisatorische_eenheid` - Organisatorische eenheid

            * `pand` - Pand

            * `spoorbaandeel` - Spoorbaandeel

            * `status` - Status

            * `terreindeel` - Terreindeel

            * `terrein_gebouwd_object` - Terrein gebouwd object

            * `vestiging` - Vestiging

            * `waterdeel` - Waterdeel

            * `wegdeel` - Wegdeel

            * `wijk` - Wijk

            * `woonplaats` - Woonplaats

            * `woz_deelobject` - Woz deel object

            * `woz_object` - Woz object

            * `woz_waarde` - Woz waarde

            * `zakelijk_recht` - Zakelijk recht

            * `overige` - Overige'
          title: object type
        objectTypeOverige:
          type: string
          description: Beschrijft het type OBJECT als `objectType` de waarde "overige" heeft.
          title: object type overige
          pattern: '[a-z\_]+'
          maxLength: 100
        objectTypeOverigeDefinitie:
          allOf:
          - $ref: '#/components/schemas/ObjectTypeOverigeDefinitie'
          title: definitie object type overige
          description: 'Verwijzing naar het schema van het type OBJECT als `objectType` de waarde "overige" heeft.


            * De URL referentie moet naar een JSON endpoint   wijzen waarin het objecttype gedefinieerd is, inclusief het   [JSON-schema](https://json-schema.org/).

            * Gebruik het `schema` attribuut om te verwijzen naar het schema binnen   de objecttype resource (deze gebruikt het   [jq](http://stedolan.github.io/jq/) formaat.

            * Gebruik het `objectData` attribuut om te verwijzen naar de gegevens   binnen het OBJECT. Deze gebruikt ook het   [jq](http://stedolan.github.io/jq/) formaat.


            Indien je hier gebruikt van maakt, dan moet je een OBJECT url opgeven en is het gebruik van objectIdentificatie niet mogelijk. De opgegeven OBJECT url wordt gevalideerd tegen het schema van het opgegeven objecttype.'
        relatieomschrijving:
          type: string
          description: Omschrijving van de betrekking tussen de ZAAK en het OBJECT.
          title: relatieomschrijving
          maxLength: 80
      required:
      - objectType
      - url
      - uuid
      - zaak
      discriminator:
        propertyName: objectType
        mapping:
          adres: '#/components/schemas/adres_ZaakObject'
          besluit: '#/components/schemas/besluit_ZaakObject'
          buurt: '#/components/schemas/buurt_ZaakObject'
          enkelvoudig_document: '#/components/schemas/enkelvoudig_document_ZaakObject'
          gemeente: '#/components/schemas/gemeente_ZaakObject'
          gemeentelijke_openbare_ruimte: '#/components/schemas/gemeentelijke_openbare_ruimte_ZaakObject'
          huishouden: '#/components/schemas/huishouden_ZaakObject'
          inrichtingselement: '#/components/schemas/inrichtingselement_ZaakObject'
          kadastrale_onroerende_zaak: '#/components/schemas/kadastrale_onroerende_zaak_ZaakObject'
          kunstwerkdeel: '#/components/schemas/kunstwerkdeel_ZaakObject'
          maatschappelijke_activiteit: '#/components/schemas/maatschappelijke_activiteit_ZaakObject'
          medewerker: '#/components/schemas/medewerker_ZaakObject'
          natuurlijk_persoon: '#/components/schemas/natuurlijk_persoon_ZaakObject'
          niet_natuurlijk_persoon: '#/components/schemas/niet_natuurlijk_persoon_ZaakObject'
          openbare_ruimte: '#/components/schemas/openbare_ruimte_ZaakObject'
          organisatorische_eenheid: '#/components/schemas/organisatorische_eenheid_ZaakObject'
          pand: '#/components/schemas/pand_ZaakObject'
          spoorbaandeel: '#/components/schemas/spoorbaandeel_ZaakObject'
          status: '#/components/schemas/status_ZaakObject'
          terreindeel: '#/components/schemas/terreindeel_ZaakObject'
          terrein_gebouwd_object: '#/components/schemas/terrein_gebouwd_object_ZaakObject'
          vestiging: '#/components/schemas/vestiging_ZaakObject'
          waterdeel: '#/components/schemas/waterdeel_ZaakObject'
          wegdeel: '#/components/schemas/wegdeel_ZaakObject'
          wijk: '#/components/schemas/wijk_ZaakObject'
          woonplaats: '#/components/schemas/woonplaats_ZaakObject'
          woz_deelobject: '#/components/schemas/woz_deelobject_ZaakObject'
          woz_object: '#/components/schemas/woz_object_ZaakObject'
          woz_waarde: '#/components/schemas/woz_waarde_ZaakObject'
          zakelijk_recht: '#/components/schemas/zakelijk_recht_ZaakObject'
          overige: '#/components/schemas/overige_ZaakObject'
    PatchedZaakObject:
      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
        uuid:
          type: string
          format: uuid
          readOnly: true
          description: Unieke resource identifier (UUID4)
          title: uuid
        zaak:
          type: string
          format: uri
          description: URL-referentie naar de ZAAK.
          title: zaak
          minLength: 1
          maxLength: 1000
        object:
          type: string
          format: uri
          description: URL-referentie naar de resource die het OBJECT beschrijft.
          title: object
          maxLength: 1000
        zaakobjecttype:
          type: string
          format: uri
          description: URL-referentie naar het ZAAKOBJECTTYPE (in de Catalogi API).
          title: zaakobjecttype
          maxLength: 1000
        objectType:
          allOf:
          - $ref: '#/components/schemas/ObjectTypeEnum'
          description: 'Beschrijft het type OBJECT gerelateerd aan de ZAAK. Als er geen passend type is, dan moet het type worden opgegeven onder `objectTypeOverige`.


            Uitleg bij mogelijke waarden:


            * `adres` - Adres

            * `besluit` - Besluit

            * `buurt` - Buurt

            * `enkelvoudig_document` - Enkelvoudig document

            * `gemeente` - Gemeente

            * `gemeentelijke_openbare_ruimte` - Gemeentelijke openbare ruimte

            * `huishouden` - Huishouden

            * `inrichtingselement` - Inrichtingselement

            * `kadastrale_onroerende_zaak` - Kadastrale onroerende zaak

            * `kunstwerkdeel` - Kunstwerkdeel

            * `maatschappelijke_activiteit` - Maatschappelijke activiteit

            * `medewerker` - Medewerker

            * `natuurlijk_persoon` - Natuurlijk persoon

            * `niet_natuurlijk_persoon` - Niet-natuurlijk persoon

            * `openbare_ruimte` - Openbare ruimte

            * `organisatorische_eenheid` - Organisatorische eenheid

            * `pand` - Pand

            * `spoorbaandeel` - Spoorbaandeel

            * `status` - Status

            * `terreindeel` - Terreindeel

            * `terrein_gebouwd_object` - Terrein gebouwd object

            * `vestiging` - Vestiging

            * `waterdeel` - Waterdeel

            * `wegdeel` - Wegdeel

            * `wijk` - Wijk

            * `woonplaats` - Woonplaats

            * `woz_deelobject` - Woz deel object

            * `woz_object` - Woz object

            * `woz_waarde` - Woz waarde

            * `zakelijk_recht` - Zakelijk recht

            * `overige` - Overige'
          title: object type
        objectTypeOverige:
          type: string
          description: Beschrijft het type OBJECT als `objectType` de waarde "overige" heeft.
          title: object type overige
          pattern: '[a-z\_]+'
          maxLength: 100
        objectTypeOverigeDefinitie:
          allOf:
          - $ref: '#/components/schemas/ObjectTypeOverigeDefinitie'
          title: definitie object type overige
          description: 'Verwijzing naar het schema van het type OBJECT als `objectType` de waarde "overige" heeft.


            * De URL referentie moet naar een JSON endpoint   wijzen waarin het objecttype gedefinieerd is, inclusief het   [JSON-schema](https://json-schema.org/).

            * Gebruik het `schema` attribuut om te verwijzen naar het schema binnen   de objecttype resource (deze gebruikt het   [jq](http://stedolan.github.io/jq/) formaat.

            * Gebruik het `objectData` attribuut om te verwijzen naar de gegevens   binnen het OBJECT. Deze gebruikt ook het   [jq](http://stedolan.github.io/jq/) formaat.


            Indien je hier gebruikt van maakt, dan moet je een OBJECT url opgeven en is het gebruik van objectIdentificatie niet mogelijk. De opgegeven OBJECT url wordt gevalideerd tegen het schema van het opgegeven objecttype.'
        relatieomschrijving:
          type: string
          description: Omschrijving van de betrekking tussen de ZAAK en het OBJECT.
          title: relatieomschrijving
          maxLength: 80
      discriminator:
        propertyName: objectType
        mapping:
          adres: '#/components/schemas/adres_PatchedZaakObject'
          besluit: '#/components/schemas/besluit_PatchedZaakObject'
          buurt: '#/components/schemas/buurt_PatchedZaakObject'
          enkelvoudig_document: '#/components/schemas/enkelvoudig_document_PatchedZaakObject'
          gemeente: '#/components/schemas/gemeente_PatchedZaakObject'
          gemeentelijke_openbare_ruimte: '#/components/schemas/gemeentelijke_openbare_ruimte_PatchedZaakObject'
          huishouden: '#/components/schemas/huishouden_PatchedZaakObject'
          inrichtingselement: '#/components/schemas/inrichtingselement_PatchedZaakObject'
          kadastrale_onroerende_zaak: '#/components/schemas/kadastrale_onroerende_zaak_PatchedZaakObject'
          kunstwerkdeel: '#/components/schemas/kunstwerkdeel_PatchedZaakObject'
          maatschappelijke_activiteit: '#/components/schemas/maatschappelijke_activiteit_PatchedZaakObject'
          medewerker: '#/components/schemas/medewerker_PatchedZaakObject'
          natuurlijk_persoon: '#/components/schemas/natuurlijk_persoon_PatchedZaakObject'
          niet_natuurlijk_persoon: '#/components/schemas/niet_natuurlijk_persoon_PatchedZaakObject'
          openbare_ruimte: '#/components/schemas/openbare_ruimte_PatchedZaakObject'
          organisatorische_eenheid: '#/components/schemas/organisatorische_eenheid_PatchedZaakObject'
          pand: '#/components/schemas/pand_PatchedZaakObject'
          spoorbaandeel: '#/components/schemas/spoorbaandeel_PatchedZaakObject'
          status: '#/components/schemas/status_PatchedZaakObject'
          terreindeel: '#/components/schemas/terreindeel_PatchedZaakObject'
          terrein_gebouwd_object: '#/components/schemas/terrein_gebouwd_object_PatchedZaakObject'
          vestiging: '#/components/schemas/vestiging_PatchedZaakObject'
          waterdeel: '#/components/schemas/waterdeel_PatchedZaakObject'
          wegdeel: '#/components/schemas/wegdeel_PatchedZaakObject'
          wijk: '#/components/schemas/wijk_PatchedZaakObject'
          woonplaats: '#/components/schemas/woonplaats_PatchedZaakObject'
          woz_deelobject: '#/components/schemas/woz_deelobject_PatchedZaakObject'
          woz_object: '#/components/schemas/woz_object_PatchedZaakObject'
          woz_waarde: '#/components/schemas/woz_waarde_PatchedZaakObject'
          zakelijk_recht: '#/components/schemas/zakelijk_recht_PatchedZaakObject'
          overige: '#/components/schemas/overige_PatchedZaakObject'
    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
    ObjectTypeEnum:
      enum:
      - adres
      - besluit
      - buurt
      - enkelvoudig_document
      - gemeente
      - gemeentelijke_openbare_ruimte
      - huishouden
      - inrichtingselement
      - kadastrale_onroerende_zaak
      - kunstwerkdeel
      - maatschappelijke_activiteit
      - medewerker
      - natuurlijk_persoon
      - niet_natuurlijk_persoon
      - openbare_ruimte
      - organisatorische_eenheid
      - pand
      - spoorbaandeel
      - status
      - terreindeel
      - terrein_gebouwd_object
      - vestiging
      - waterdeel
      - wegdeel
      - wijk
      - woonplaats
      - woz_deelobject
      - woz_object
      - woz_waarde
      - zakelijk_recht
      - overige
      type: string
    ObjectTypeOverigeDefinitie:
      type: object
      properties:
        url:
          type: string
          format: uri
          title: Objecttype-URL
          description: URL-referentie naar de objecttype resource in een API. Deze resource moet de [JSON-schema](https://json-schema.org/)-definitie van het objecttype bevatten.
          maxLength: 1000
        schema:
          type: string
          title: schema-pad
          description: 'Een geldige [jq](http://stedolan.github.io/jq/) expressie. Dit wordt gecombineerd met de resource uit het `url`-attribuut om het schema van het objecttype uit te lezen. Bijvoorbeeld: `.jsonSchema`.'
          maxLength: 100
        objectData:
          type: string
          title: objectgegevens-pad
          description: 'Een geldige [jq](http://stedolan.github.io/jq/) expressie. Dit wordt gecombineerd met de JSON data uit de OBJECT url om de objectgegevens uit te lezen en de vorm van de gegevens tegen het schema te valideren. Bijvoorbeeld: `.record.data`.'
          maxLength: 100
      required:
      - objectData
      - schema
      - url
  securitySchemes:
    JWT-Claims:
      type: http
      bearerFormat: JWT
      scheme: bearer
x-refined-from:
- vng-realisatie-zaken-openapi.yml
- vng-realisatie-zaken-openapi.yml