VNG Realisatie Statussen API

openapi: 3.2.0
info:
  title: Vng Realisatie Statussen 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 statussen 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: statussen
  description: ''
paths:
  /statussen:
    get:
      operationId: status_list
      description: Deze lijst kan gefilterd wordt met query-string parameters.
      summary: Alle STATUSsen bij ZAAKen opvragen
      parameters:
      - name: zaak
        required: false
        in: query
        description: URL-referentie naar de ZAAK.
        schema:
          type: string
          format: uri
      - name: statustype
        required: false
        in: query
        description: URL-referentie naar het STATUSTYPE (in de Catalogi API).
        schema:
          type: string
          format: uri
      - name: indicatieLaatstGezetteStatus
        required: false
        in: query
        description: Het gegeven is afleidbaar uit de historie van de attribuutsoort Datum status gezet van van alle statussen bij de desbetreffende zaak.
        schema:
          type: string
      - name: page
        required: false
        in: query
        description: Een pagina binnen de gepagineerde set resultaten.
        schema:
          type: integer
      tags:
      - statussen
      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/PaginatedStatusList'
          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: status_create
      description: '**Er wordt gevalideerd op**

        - geldigheid URL naar de ZAAK

        - geldigheid URL naar het STATUSTYPE

        - indien het de eindstatus betreft, dan moet het attribuut `indicatieGebruiksrecht` gezet zijn op alle informatieobjecten dieaan de zaak gerelateerd zijn


        **Opmerkingen**

        - Indien het statustype de eindstatus is (volgens het ZTC), dan wordt de zaak afgesloten door de einddatum te zetten.'
      summary: Maak een STATUS aan voor een ZAAK
      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:
      - statussen
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Status'
        required: true
      security:
      - JWT-Claims:
        - (zaken.aanmaken | zaken.statussen.toevoegen | zaken.heropenen)
      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/Status'
          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
  /statussen/{uuid}:
    get:
      operationId: status_retrieve
      description: Een specifieke STATUS van een ZAAK opvragen.
      summary: Een specifieke STATUS van een ZAAK 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:
      - statussen
      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/Status'
          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
    head:
      operationId: status_headers
      description: Vraag de headers op die je bij een GET request zou krijgen.
      summary: De headers voor een specifiek(e) STATUS 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:
      - statussen
      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/Status'
          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
    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
    PaginatedStatusList:
      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/Status'
    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
    Status:
      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
        statustype:
          type: string
          format: uri
          description: URL-referentie naar het STATUSTYPE (in de Catalogi API).
          title: statustype
          maxLength: 1000
        datumStatusGezet:
          type: string
          format: date-time
          description: De datum waarop de ZAAK de status heeft verkregen.
          title: datum status gezet
        statustoelichting:
          type: string
          description: Een, voor de initiator van de zaak relevante, toelichting op de status van een zaak.
          title: statustoelichting
          maxLength: 1000
        indicatieLaatstGezetteStatus:
          type: boolean
          readOnly: true
          description: Het gegeven is afleidbaar uit de historie van de attribuutsoort Datum status gezet van van alle statussen bij de desbetreffende zaak.
          title: indicatieLaatstGezetteStatus
        gezetdoor:
          type: string
          format: uri
          title: Gezet door
          description: De BETROKKENE die in zijn/haar ROL in een ZAAK heeft geregistreerd dat STATUSsen in die ZAAK bereikt zijn.
          maxLength: 200
        zaakinformatieobjecten:
          type: array
          items:
            type: string
            format: uri
            title: ''
            minLength: 1
            maxLength: 1000
          readOnly: true
          title: status
          uniqueItems: true
      required:
      - datumStatusGezet
      - indicatieLaatstGezetteStatus
      - statustype
      - url
      - uuid
      - zaak
      - zaakinformatieobjecten
  securitySchemes:
    JWT-Claims:
      type: http
      bearerFormat: JWT
      scheme: bearer
x-refined-from:
- vng-realisatie-zaken-openapi.yml
- vng-realisatie-zaken-openapi.yml