openapi: 3.2.0
info:
  title: Vng Realisatie Eigenschappen API
  version: 1.3.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 eigenschappen across 2 of this provider''s published API definitions: vng-realisatie-catalogi-openapi.yml, vng-realisatie-catalogi-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://catalogi-api.vng.cloud/api/v1
  description: Productie Omgeving
tags:
- name: eigenschappen
  description: Opvragen en bewerken van EIGENSCHAPpen van een ZAAKTYPE. Een relevant inhoudelijk gegeven dat bij ZAAKen van dit ZAAKTYPE geregistreerd moet kunnen worden en geen standaard kenmerk is van een zaak.
paths:
  /eigenschappen:
    get:
      operationId: eigenschap_list
      description: Deze lijst kan gefilterd wordt met query-string parameters.
      summary: Alle EIGENSCHAPpen opvragen
      parameters:
      - name: zaaktype
        required: false
        in: query
        description: URL-referentie naar het ZAAKTYPE van de ZAAKen waarvoor deze EIGENSCHAP van belang is.
        schema:
          type: string
          format: uri
      - name: zaaktypeIdentificatie
        required: false
        in: query
        description: zaaktype_identificatie
        schema:
          type: string
      - name: status
        required: false
        in: query
        description: 'filter objects depending on their concept status:

          * `alles`: Toon objecten waarvan het attribuut `concept` true of false is.

          * `concept`: Toon objecten waarvan het attribuut `concept` true is.

          * `definitief`: Toon objecten waarvan het attribuut `concept` false is (standaard).

          '
        schema:
          type: string
      - name: datumGeldigheid
        required: false
        in: query
        description: filter objecten op hun geldigheids datum.
        schema:
          type: string
      - name: page
        required: false
        in: query
        description: Een pagina binnen de gepagineerde set resultaten.
        schema:
          type: integer
      tags:
      - eigenschappen
      security:
      - JWT-Claims:
        - catalogi.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/PaginatedEigenschapList'
          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: eigenschap_create
      description: Maak een EIGENSCHAP aan. Dit kan alleen als het bijbehorende ZAAKTYPE een concept betreft.
      summary: Maak een EIGENSCHAP aan
      parameters:
      - in: header
        name: Content-Type
        schema:
          type: string
          enum:
          - application/json
        description: Content type van de verzoekinhoud.
        required: true
      tags:
      - eigenschappen
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Eigenschap'
        required: true
      security:
      - JWT-Claims:
        - (catalogi.schrijven | catalogi.geforceerd-schrijven)
      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/Eigenschap'
          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://catalogi-api.vng.cloud/api/v1
      description: Productie Omgeving
  /eigenschappen/{uuid}:
    get:
      operationId: eigenschap_retrieve
      description: Een specifieke EIGENSCHAP opvragen.
      summary: Een specifieke EIGENSCHAP 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:
      - eigenschappen
      security:
      - JWT-Claims:
        - catalogi.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/Eigenschap'
          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: eigenschap_update
      description: Werk een EIGENSCHAP in zijn geheel bij. Dit kan alleen als het bijbehorende ZAAKTYPE een concept betreft.
      summary: Werk een EIGENSCHAP 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
      tags:
      - eigenschappen
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Eigenschap'
        required: true
      security:
      - JWT-Claims:
        - (catalogi.schrijven | catalogi.geforceerd-schrijven)
      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/Eigenschap'
          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: eigenschap_partial_update
      description: Werk een EIGENSCHAP deels bij. Dit kan alleen als het bijbehorende ZAAKTYPE een concept betreft.
      summary: Werk een EIGENSCHAP 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:
      - eigenschappen
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedEigenschap'
      security:
      - JWT-Claims:
        - (catalogi.schrijven | catalogi.geforceerd-schrijven)
      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/Eigenschap'
          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: eigenschap_destroy
      description: Verwijder een EIGENSCHAP. Dit kan alleen als het bijbehorende ZAAKTYPE een concept betreft.
      summary: Verwijder een EIGENSCHAP
      parameters:
      - in: path
        name: uuid
        schema:
          type: string
          format: uuid
          description: Unieke resource identifier (UUID4)
          title: uuid
        required: true
      tags:
      - eigenschappen
      security:
      - JWT-Claims:
        - (catalogi.schrijven | catalogi.geforceerd-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: eigenschap_headers
      description: Vraag de headers op die je bij een GET request zou krijgen.
      summary: De headers voor een specifiek(e) EIGENSCHAP 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:
      - eigenschappen
      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/Eigenschap'
          description: OK
    servers:
    - url: https://catalogi-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
    FormaatEnum:
      enum:
      - tekst
      - getal
      - datum
      - datum_tijd
      type: string
    Eigenschap:
      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
        naam:
          type: string
          description: De naam van de EIGENSCHAP
          title: eigenschapnaam
          maxLength: 20
        catalogus:
          type: string
          format: uri
          readOnly: true
          title: catalogus
        definitie:
          type: string
          description: De beschrijving van de betekenis van deze EIGENSCHAP
          title: definitie
          maxLength: 255
        specificatie:
          allOf:
          - $ref: '#/components/schemas/EigenschapSpecificatie'
          title: specificatie van eigenschap
        toelichting:
          type: string
          description: Een toelichting op deze EIGENSCHAP en het belang hiervan voor zaken van dit ZAAKTYPE.
          title: toelichting
          maxLength: 1000
        zaaktype:
          type: string
          format: uri
          description: URL-referentie naar het ZAAKTYPE van de ZAAKen waarvoor deze EIGENSCHAP van belang is.
          title: Zaaktype
        zaaktypeIdentificatie:
          type: string
          readOnly: true
          description: Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin het ZAAKTYPE voorkomt.
          title: Zaaktype
        statustype:
          type:
          - string
          - 'null'
          format: uri
          title: Status type
          description: Status type moet (onder andere) deze EIGENSCHAP hebben, voordat een STATUS van het STATUSTYPE kan worden gezet.
        beginGeldigheid:
          type:
          - string
          - 'null'
          format: date
          description: De datum waarop de EIGENSCHAP is ontstaan.
          title: datum begin geldigheid
        eindeGeldigheid:
          type:
          - string
          - 'null'
          format: date
          description: De datum waarop de EIGENSCHAP is opgeheven.
          title: datum einde geldigheid
        beginObject:
          type:
          - string
          - 'null'
          format: date
          description: De datum waarop de eerst versie van het object ontstaan is.
          title: datum begin object
        eindeObject:
          type:
          - string
          - 'null'
          format: date
          description: De datum van de aller laatste versie van het object.
          title: datum einde object
      required:
      - catalogus
      - definitie
      - naam
      - specificatie
      - url
      - zaaktype
      - zaaktypeIdentificatie
    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
    EigenschapSpecificatie:
      type: object
      properties:
        groep:
          type: string
          description: Benaming van het object of groepattribuut waarvan de EIGENSCHAP een inhoudelijk gegeven specificeert.
          title: groep
          maxLength: 32
        formaat:
          allOf:
          - $ref: '#/components/schemas/FormaatEnum'
          description: 'Het soort tekens waarmee waarden van de EIGENSCHAP kunnen worden vastgelegd.


            Uitleg bij mogelijke waarden:


            * `tekst` - Tekst

            * `getal` - Getal

            * `datum` - Datum

            * `datum_tijd` - Datum/tijd'
          title: formaat
        lengte:
          type: string
          description: Het aantal karakters (lengte) waarmee waarden van de EIGENSCHAP worden vastgelegd.
          title: lengte
          maxLength: 14
        kardinaliteit:
          type: string
          description: Het aantal mogelijke voorkomens van waarden van deze EIGENSCHAP bij een zaak van het ZAAKTYPE.
          title: kardinaliteit
          maxLength: 3
        waardenverzameling:
          type: array
          items:
            type: string
            maxLength: 100
          description: Waarden die deze EIGENSCHAP kan hebben.
          title: waardenverzameling
      required:
      - formaat
      - kardinaliteit
      - lengte
    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
    PaginatedEigenschapList:
      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/Eigenschap'
    PatchedEigenschap:
      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
        naam:
          type: string
          description: De naam van de EIGENSCHAP
          title: eigenschapnaam
          maxLength: 20
        catalogus:
          type: string
          format: uri
          readOnly: true
          title: catalogus
        definitie:
          type: string
          description: De beschrijving van de betekenis van deze EIGENSCHAP
          title: definitie
          maxLength: 255
        specificatie:
          allOf:
          - $ref: '#/components/schemas/EigenschapSpecificatie'
          title: specificatie van eigenschap
        toelichting:
          type: string
          description: Een toelichting op deze EIGENSCHAP en het belang hiervan voor zaken van dit ZAAKTYPE.
          title: toelichting
          maxLength: 1000
        zaaktype:
          type: string
          format: uri
          description: URL-referentie naar het ZAAKTYPE van de ZAAKen waarvoor deze EIGENSCHAP van belang is.
          title: Zaaktype
        zaaktypeIdentificatie:
          type: string
          readOnly: true
          description: Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin het ZAAKTYPE voorkomt.
          title: Zaaktype
        statustype:
          type:
          - string
          - 'null'
          format: uri
          title: Status type
          description: Status type moet (onder andere) deze EIGENSCHAP hebben, voordat een STATUS van het STATUSTYPE kan worden gezet.
        beginGeldigheid:
          type:
          - string
          - 'null'
          format: date
          description: De datum waarop de EIGENSCHAP is ontstaan.
          title: datum begin geldigheid
        eindeGeldigheid:
          type:
          - string
          - 'null'
          format: date
          description: De datum waarop de EIGENSCHAP is opgeheven.
          title: datum einde geldigheid
        beginObject:
          type:
          - string
          - 'null'
          format: date
          description: De datum waarop de eerst versie van het object ontstaan is.
          title: datum begin object
        eindeObject:
          type:
          - string
          - 'null'
          format: date
          description: De datum van de aller laatste versie van het object.
          title: datum einde object
  securitySchemes:
    JWT-Claims:
      type: http
      bearerFormat: JWT
      scheme: bearer
x-refined-from:
- vng-realisatie-catalogi-openapi.yml
- vng-realisatie-catalogi-openapi.yml