components:
  parameters:
    _sort:
      description: Het veld waarop gesorteerd moet worden. Door een minteken (“-”)
        voor de veldnaam te zetten wordt het veld in aflopende volgorde gesorteerd.
      in: query
      name: _sort
      required: false
      schema:
        default: URN
        enum:
        - -URN
        - URN
        - -OMSCHRIJVING
        - OMSCHRIJVING
        type: string
    _sortByUrn:
      description: |
        Sortering van de resultaten:
          - URN: alfabetisch oplopend op URN
          - -URN: alfabetisch aflopend op URN
      in: query
      name: _sort
      required: false
      schema:
        default: URN
        enum:
        - -URN
        - URN
        type: string
    WerkzaamheidUrn:
      description: De urn van de werkzaamheid
      in: path
      name: urn
      required: true
      schema:
        description: Urn van de werkzaamheid
        example: BoomKappen
        pattern: ^\w{1,100}$
        type: string
    WerkzaamheidUrnFilter:
      description: Komma-gescheiden lijst van werkzaamheid urn's waarvan de versies
        worden opgevraagd. Indien geen urn's worden meegegeven, is het verplicht om
        een geldigOp datum mee te geven.
      explode: false
      in: query
      name: urns
      required: false
      schema:
        items:
          description: Urn van de werkzaamheid
          example: BoomKappen
          pattern: ^\w{1,100}$
          type: string
        maxItems: 50
        type: array
    datumActiefFilter:
      description: Datum waarop de versie van de werkzaamheid geldig is.
      in: query
      name: geldigOp
      schema:
        description: Datum in het formaat yyyy-MM-dd
        example: "2023-01-01"
        format: date
        pattern: ^\d{4}-\d{2}-\d{2}$
        type: string
    expand:
      description: Indien true, worden sub-resources genest teruggegeven als onderdeel
        van het antwoordbericht. De parameter _expandScope is in dit geval verplicht
        om aan te geven welke sub-resources het betreft.
      in: query
      name: _expand
      schema:
        type: boolean
    expandScope:
      description: Geeft aan welke geneste resources teruggegeven worden als onderdeel
        van het antwoordbericht. Heeft alleen effect als de parameter _expand de waarde
        true heeft. De waarde is een komma gescheiden lijst.
      explode: false
      in: query
      name: _expandScope
      schema:
        items:
          enum:
          - TREFWOORDEN
          - LOGISCHE_RELATIES
          maxItems: 2
          type: string
        type: array
    page:
      description: De pagina die geretourneerd moet worden in een gepagineerde response.
      in: query
      name: page
      required: false
      schema:
        default: 1
        minimum: 1
        type: integer
    pageSizeEnum:
      description: Het gewenste aantal items per pagina in een gepagineerde response.
      in: query
      name: pageSize
      required: false
      schema:
        enum:
        - 10
        - 20
        - 50
        - 100
        - 200
        type: integer
  responses:
    "400":
      content:
        application/problem+json:
          schema:
            allOf:
            - properties:
                detail:
                  description: Meer detail informatie over de opgetreden fout
                  type: string
                instance:
                  description: Het unieke instance id van het request dat resulteerde
                    in de foutmelding.
                  type: string
                status:
                  description: De statuscode van de fout (= 400) overeenkomend met
                    de http-status code van de response.
                  format: int64
                  type: integer
                title:
                  description: Informatie over de opgetreden fout.
                  type: string
                type:
                  description: Het type fout dat opgetreden is. Bijvoorbeeld VALIDATIE_FOUT
                    of ONVERWACHTE_FOUT.
                  type: string
              required:
              - type
              - title
              - status
            - properties:
                invalid-params:
                  items:
                    properties:
                      name:
                        description: '''Naam van de parameter die een fout bevat,
                          bijvoorbeeld: activiteitFunctioneleStructuurRef'''
                        type: string
                      reason:
                        description: Bijvoorbeeld 'de activiteitFunctioneleStructuurRef
                          mag geen speciale karakters bevatten.'
                        type: string
                      type:
                        description: Een type van de fout, bijvoorbeeld 'Validatie
                          melding'
                        type: string
                    required:
                    - type
                    - name
                    - reason
                  type: array
      description: Fouten (missing parameter; niet bestaande parameter; invalide waarde
        voor parameter)
    "404":
      content:
        application/problem+json:
          schema:
            allOf:
            - properties:
                detail:
                  description: Meer detail informatie over de opgetreden fout
                  type: string
                instance:
                  description: Het unieke instance id van het request dat resulteerde
                    in de foutmelding.
                  type: string
                status:
                  description: De statuscode van de fout (= 404) overeenkomend met
                    de http-status code van de response.
                  format: int64
                  type: integer
                title:
                  description: Informatie over de opgetreden fout.
                  type: string
                type:
                  description: Het type resource dat niet gevonden is.
                  type: string
              required:
              - type
              - title
              - status
            - properties:
                detail:
                  description: De identifier van het object dat niet gevonden is.
                    Bijvoorbeeld de URN van een activiteit.
                  type: string
                type:
                  description: Bevat informatie over het type object dat niet gevonden
                    is. Bijvoorbeeld ACTIVITY_NOT_FOUND of SUBACTIVITY_NOT_FOUND
                  type: string
      description: De gevraagde resource is niet gevonden
    "429":
      description: Te veel requests (binnen een bepaalde tijd)
    "500":
      content:
        application/problem+json:
          schema:
            properties:
              detail:
                description: Meer detail informatie over de opgetreden fout
                type: string
              instance:
                description: Het unieke instance id van het request dat resulteerde
                  in de foutmelding.
                type: string
              status:
                description: De statuscode (= 500) van de fout overeenkomend met de
                  http-status code van de response.
                format: int64
                type: integer
              title:
                description: Informatie over de opgetreden fout.
                type: string
              type:
                description: Het type fout dat opgetreden is. Bijvoorbeeld VALIDATIE_FOUT
                  of ONVERWACHTE_FOUT.
                type: string
            required:
            - type
            - title
            - status
      description: Er is een onverwachte technische fout opgetreden
  schemas:
    Datum:
      description: Datum in het formaat yyyy-MM-dd
      example: "2023-01-01"
      format: date
      pattern: ^\d{4}-\d{2}-\d{2}$
      type: string
    HalLink:
      description: HAL link
      properties:
        href:
          description: URI
          type: string
      required:
      - href
    HalPaginationLinks:
      description: Links om te navigeren door de paginering
      properties:
        first:
          allOf:
          - description: HAL link
            properties:
              href:
                description: URI
                type: string
            required:
            - href
          description: uri voor het opvragen van de eerste pagina van deze collectie
        last:
          allOf:
          - description: HAL link
            properties:
              href:
                description: URI
                type: string
            required:
            - href
          description: uri voor het opvragen van de laatste pagina van deze collectie
        next:
          allOf:
          - description: HAL link
            properties:
              href:
                description: URI
                type: string
            required:
            - href
          description: uri voor het opvragen van de volgende pagina van deze collectie
        prev:
          allOf:
          - description: HAL link
            properties:
              href:
                description: URI
                type: string
            required:
            - href
          description: uri voor het opvragen van de vorige pagina van deze collectie
        self:
          allOf:
          - description: HAL link
            properties:
              href:
                description: URI
                type: string
            required:
            - href
          description: uri voor het opvragen van de huidige pagina van deze collectie
      required:
      - self
      - first
      - last
    Omschrijving:
      description: Omschrijving van de werkzaamheid versie
      example: Vellen van een houtopstand
      maxLength: 250
      minLength: 1
      type: string
    Page:
      description: Info voor paginering.
      properties:
        number:
          description: het huidige paginanummer
          minimum: 1
          type: integer
        size:
          description: het aantal items op de huidige pagina
          minimum: 0
          type: integer
        totalElements:
          description: het totaal aantal items in deze collectie
          minimum: 0
          type: integer
        totalPages:
          description: het totaal aantal pagina's in deze collectie
          minimum: 0
          type: integer
      required:
      - size
      - totalElements
      - totalPages
      - number
      type: object
    Trefwoord:
      description: Trefwoord van de werkzaamheid versie
      example: Omhakken
      maxLength: 250
      minLength: 1
      type: string
    Trefwoorden:
      description: Trefwoorden van de werkzaamheid versie
      example:
      - Omhakken
      - Boom
      items:
        description: Trefwoord van de werkzaamheid versie
        example: Omhakken
        maxLength: 250
        minLength: 1
        type: string
      maxItems: 500
      type: array
    WerkzaamheidHALResponse:
      allOf:
      - description: Werkzaamheid gegevens
        properties:
          urn:
            description: Urn van de werkzaamheid
            example: BoomKappen
            pattern: ^\w{1,100}$
            type: string
        required:
        - urn
      - properties:
          _links:
            properties:
              versies:
                allOf:
                - description: HAL link
                  properties:
                    href:
                      description: URI
                      type: string
                  required:
                  - href
                description: HAL link om alle versies van de werkzaamheid op te halen
            required:
            - versies
        required:
        - _links
      description: Werkzaamheid met HAL links
    WerkzaamheidHALResponseList:
      description: Lijst van werkzaamheden met HAL links.
      properties:
        _embedded:
          properties:
            werkzaamheden:
              items:
                allOf:
                - description: Werkzaamheid gegevens
                  properties:
                    urn:
                      description: Urn van de werkzaamheid
                      example: BoomKappen
                      pattern: ^\w{1,100}$
                      type: string
                  required:
                  - urn
                - properties:
                    _links:
                      properties:
                        versies:
                          allOf:
                          - description: HAL link
                            properties:
                              href:
                                description: URI
                                type: string
                            required:
                            - href
                          description: HAL link om alle versies van de werkzaamheid
                            op te halen
                      required:
                      - versies
                  required:
                  - _links
                description: Werkzaamheid met HAL links
              minItems: 1
              type: array
          required:
          - werkzaamheden
        _links:
          description: Links om te navigeren door de paginering
          properties:
            first:
              allOf:
              - description: HAL link
                properties:
                  href:
                    description: URI
                    type: string
                required:
                - href
              description: uri voor het opvragen van de eerste pagina van deze collectie
            last:
              allOf:
              - description: HAL link
                properties:
                  href:
                    description: URI
                    type: string
                required:
                - href
              description: uri voor het opvragen van de laatste pagina van deze collectie
            next:
              allOf:
              - description: HAL link
                properties:
                  href:
                    description: URI
                    type: string
                required:
                - href
              description: uri voor het opvragen van de volgende pagina van deze collectie
            prev:
              allOf:
              - description: HAL link
                properties:
                  href:
                    description: URI
                    type: string
                required:
                - href
              description: uri voor het opvragen van de vorige pagina van deze collectie
            self:
              allOf:
              - description: HAL link
                properties:
                  href:
                    description: URI
                    type: string
                required:
                - href
              description: uri voor het opvragen van de huidige pagina van deze collectie
          required:
          - self
          - first
          - last
        page:
          description: Info voor paginering.
          properties:
            number:
              description: het huidige paginanummer
              minimum: 1
              type: integer
            size:
              description: het aantal items op de huidige pagina
              minimum: 0
              type: integer
            totalElements:
              description: het totaal aantal items in deze collectie
              minimum: 0
              type: integer
            totalPages:
              description: het totaal aantal pagina's in deze collectie
              minimum: 0
              type: integer
          required:
          - size
          - totalElements
          - totalPages
          - number
          type: object
      required:
      - _links
      - page
    WerkzaamheidResponse:
      description: Werkzaamheid gegevens
      properties:
        urn:
          description: Urn van de werkzaamheid
          example: BoomKappen
          pattern: ^\w{1,100}$
          type: string
      required:
      - urn
    WerkzaamheidUrn:
      description: Urn van de werkzaamheid
      example: BoomKappen
      pattern: ^\w{1,100}$
      type: string
    WerkzaamheidVersieHALResponse:
      allOf:
      - description: Werkzaamheid versie gegevens
        properties:
          beginDatum:
            allOf:
            - description: Datum in het formaat yyyy-MM-dd
              example: "2023-01-01"
              format: date
              pattern: ^\d{4}-\d{2}-\d{2}$
              type: string
            description: De datum vanaf wanneer de werkzaamheid versie geldig is.
            type: string
          eindDatum:
            allOf:
            - description: Datum in het formaat yyyy-MM-dd
              example: "2023-01-01"
              format: date
              pattern: ^\d{4}-\d{2}-\d{2}$
              type: string
            description: De datum tot en met wanneer de werkzaamheid versie geldig
              is.
            type: string
          omschrijving:
            description: Omschrijving van de werkzaamheid versie
            example: Vellen van een houtopstand
            maxLength: 250
            minLength: 1
            type: string
          urn:
            description: Urn van de werkzaamheid
            example: BoomKappen
            pattern: ^\w{1,100}$
            type: string
        required:
        - urn
        - omschrijving
        - beginDatum
      - properties:
          _embedded:
            properties:
              logischeRelaties:
                description: De werkzaamheden waarnaar een logische relatie bestaat.
                items:
                  allOf:
                  - description: Werkzaamheid gegevens
                    properties:
                      urn:
                        description: Urn van de werkzaamheid
                        example: BoomKappen
                        pattern: ^\w{1,100}$
                        type: string
                    required:
                    - urn
                  - properties:
                      _links:
                        properties:
                          versies:
                            allOf:
                            - description: HAL link
                              properties:
                                href:
                                  description: URI
                                  type: string
                              required:
                              - href
                            description: HAL link om alle versies van de werkzaamheid
                              op te halen
                        required:
                        - versies
                    required:
                    - _links
                  description: Werkzaamheid met HAL links
                type: array
              trefwoorden:
                description: Trefwoorden van de werkzaamheid versie
                example:
                - Omhakken
                - Boom
                items:
                  description: Trefwoord van de werkzaamheid versie
                  example: Omhakken
                  maxLength: 250
                  minLength: 1
                  type: string
                maxItems: 500
                type: array
      description: Werkzaamheid versie met HAL links
    WerkzaamheidVersieHALResponseList:
      description: Lijst van werkzaamheid versies met HAL links
      properties:
        _embedded:
          properties:
            werkzaamheidversies:
              items:
                description: Werkzaamheid versie gegevens
                properties:
                  beginDatum:
                    allOf:
                    - description: Datum in het formaat yyyy-MM-dd
                      example: "2023-01-01"
                      format: date
                      pattern: ^\d{4}-\d{2}-\d{2}$
                      type: string
                    description: De datum vanaf wanneer de werkzaamheid versie geldig
                      is.
                    type: string
                  eindDatum:
                    allOf:
                    - description: Datum in het formaat yyyy-MM-dd
                      example: "2023-01-01"
                      format: date
                      pattern: ^\d{4}-\d{2}-\d{2}$
                      type: string
                    description: De datum tot en met wanneer de werkzaamheid versie
                      geldig is.
                    type: string
                  omschrijving:
                    description: Omschrijving van de werkzaamheid versie
                    example: Vellen van een houtopstand
                    maxLength: 250
                    minLength: 1
                    type: string
                  urn:
                    description: Urn van de werkzaamheid
                    example: BoomKappen
                    pattern: ^\w{1,100}$
                    type: string
                required:
                - urn
                - omschrijving
                - beginDatum
              minItems: 1
              type: array
          required:
          - werkzaamheidversies
        _links:
          description: Links om te navigeren door de paginering
          properties:
            first:
              allOf:
              - description: HAL link
                properties:
                  href:
                    description: URI
                    type: string
                required:
                - href
              description: uri voor het opvragen van de eerste pagina van deze collectie
            last:
              allOf:
              - description: HAL link
                properties:
                  href:
                    description: URI
                    type: string
                required:
                - href
              description: uri voor het opvragen van de laatste pagina van deze collectie
            next:
              allOf:
              - description: HAL link
                properties:
                  href:
                    description: URI
                    type: string
                required:
                - href
              description: uri voor het opvragen van de volgende pagina van deze collectie
            prev:
              allOf:
              - description: HAL link
                properties:
                  href:
                    description: URI
                    type: string
                required:
                - href
              description: uri voor het opvragen van de vorige pagina van deze collectie
            self:
              allOf:
              - description: HAL link
                properties:
                  href:
                    description: URI
                    type: string
                required:
                - href
              description: uri voor het opvragen van de huidige pagina van deze collectie
          required:
          - self
          - first
          - last
        page:
          description: Info voor paginering.
          properties:
            number:
              description: het huidige paginanummer
              minimum: 1
              type: integer
            size:
              description: het aantal items op de huidige pagina
              minimum: 0
              type: integer
            totalElements:
              description: het totaal aantal items in deze collectie
              minimum: 0
              type: integer
            totalPages:
              description: het totaal aantal pagina's in deze collectie
              minimum: 0
              type: integer
          required:
          - size
          - totalElements
          - totalPages
          - number
          type: object
      required:
      - _links
      - page
    WerkzaamheidVersieHALResponseListWithExpand:
      description: Lijst van werkzaamheid versies met HAL links en eventueel gerelateerde
        gegevens (in het geval _expand is gebruikt)
      properties:
        _embedded:
          properties:
            werkzaamheidversies:
              items:
                allOf:
                - description: Werkzaamheid versie gegevens
                  properties:
                    beginDatum:
                      allOf:
                      - description: Datum in het formaat yyyy-MM-dd
                        example: "2023-01-01"
                        format: date
                        pattern: ^\d{4}-\d{2}-\d{2}$
                        type: string
                      description: De datum vanaf wanneer de werkzaamheid versie geldig
                        is.
                      type: string
                    eindDatum:
                      allOf:
                      - description: Datum in het formaat yyyy-MM-dd
                        example: "2023-01-01"
                        format: date
                        pattern: ^\d{4}-\d{2}-\d{2}$
                        type: string
                      description: De datum tot en met wanneer de werkzaamheid versie
                        geldig is.
                      type: string
                    omschrijving:
                      description: Omschrijving van de werkzaamheid versie
                      example: Vellen van een houtopstand
                      maxLength: 250
                      minLength: 1
                      type: string
                    urn:
                      description: Urn van de werkzaamheid
                      example: BoomKappen
                      pattern: ^\w{1,100}$
                      type: string
                  required:
                  - urn
                  - omschrijving
                  - beginDatum
                - properties:
                    _embedded:
                      properties:
                        logischeRelaties:
                          description: De werkzaamheden waarnaar een logische relatie
                            bestaat.
                          items:
                            allOf:
                            - description: Werkzaamheid gegevens
                              properties:
                                urn:
                                  description: Urn van de werkzaamheid
                                  example: BoomKappen
                                  pattern: ^\w{1,100}$
                                  type: string
                              required:
                              - urn
                            - properties:
                                _links:
                                  properties:
                                    versies:
                                      allOf:
                                      - description: HAL link
                                        properties:
                                          href:
                                            description: URI
                                            type: string
                                        required:
                                        - href
                                      description: HAL link om alle versies van de
                                        werkzaamheid op te halen
                                  required:
                                  - versies
                              required:
                              - _links
                            description: Werkzaamheid met HAL links
                          type: array
                        trefwoorden:
                          description: Trefwoorden van de werkzaamheid versie
                          example:
                          - Omhakken
                          - Boom
                          items:
                            description: Trefwoord van de werkzaamheid versie
                            example: Omhakken
                            maxLength: 250
                            minLength: 1
                            type: string
                          maxItems: 500
                          type: array
                description: Werkzaamheid versie met HAL links
              minItems: 1
              type: array
          required:
          - werkzaamheidversies
        _links:
          description: Links om te navigeren door de paginering
          properties:
            first:
              allOf:
              - description: HAL link
                properties:
                  href:
                    description: URI
                    type: string
                required:
                - href
              description: uri voor het opvragen van de eerste pagina van deze collectie
            last:
              allOf:
              - description: HAL link
                properties:
                  href:
                    description: URI
                    type: string
                required:
                - href
              description: uri voor het opvragen van de laatste pagina van deze collectie
            next:
              allOf:
              - description: HAL link
                properties:
                  href:
                    description: URI
                    type: string
                required:
                - href
              description: uri voor het opvragen van de volgende pagina van deze collectie
            prev:
              allOf:
              - description: HAL link
                properties:
                  href:
                    description: URI
                    type: string
                required:
                - href
              description: uri voor het opvragen van de vorige pagina van deze collectie
            self:
              allOf:
              - description: HAL link
                properties:
                  href:
                    description: URI
                    type: string
                required:
                - href
              description: uri voor het opvragen van de huidige pagina van deze collectie
          required:
          - self
          - first
          - last
        page:
          description: Info voor paginering.
          properties:
            number:
              description: het huidige paginanummer
              minimum: 1
              type: integer
            size:
              description: het aantal items op de huidige pagina
              minimum: 0
              type: integer
            totalElements:
              description: het totaal aantal items in deze collectie
              minimum: 0
              type: integer
            totalPages:
              description: het totaal aantal pagina's in deze collectie
              minimum: 0
              type: integer
          required:
          - size
          - totalElements
          - totalPages
          - number
          type: object
      required:
      - _links
      - page
    WerkzaamheidVersieResponse:
      description: Werkzaamheid versie gegevens
      properties:
        beginDatum:
          allOf:
          - description: Datum in het formaat yyyy-MM-dd
            example: "2023-01-01"
            format: date
            pattern: ^\d{4}-\d{2}-\d{2}$
            type: string
          description: De datum vanaf wanneer de werkzaamheid versie geldig is.
          type: string
        eindDatum:
          allOf:
          - description: Datum in het formaat yyyy-MM-dd
            example: "2023-01-01"
            format: date
            pattern: ^\d{4}-\d{2}-\d{2}$
            type: string
          description: De datum tot en met wanneer de werkzaamheid versie geldig is.
          type: string
        omschrijving:
          description: Omschrijving van de werkzaamheid versie
          example: Vellen van een houtopstand
          maxLength: 250
          minLength: 1
          type: string
        urn:
          description: Urn van de werkzaamheid
          example: BoomKappen
          pattern: ^\w{1,100}$
          type: string
      required:
      - urn
      - omschrijving
      - beginDatum
info:
  contact:
    name: Ontwikkelaarsportaal Omgevingswet
    url: https://aandeslagmetdeomgevingswet.nl/ontwikkelaarsportaal/services/contact/
  description: Een REST-API voor het opvragen van werkzaamheden. Een werkzaamheid
    is een verzameling van werkzaamheid versies en wordt geïdentificeerd d.m.v. de
    urn. Een specifieke versie van een werkzaamheid wordt geïdentificeerd met de urn
    van de werkzaamheid, en een datum waarop de versie geldig is.
  title: Opvragen Werkzaamheden
  version: 1.0.0
openapi: 3.0.0
paths:
  /:
    get:
      responses:
        "200":
          content:
            application/json:
              schema:
                example: '{"openapi": "3.0.0", ... }'
          description: OpenApi Specification Json
      summary: OpenApi Specification
      tags:
      - Meta
  /app-health:
    get:
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  groups:
                    items:
                      type: string
                    type: array
                  status:
                    enum:
                    - UP
                    type: string
                required:
                - status
                type: object
          description: Health
        "503":
          content:
            application/json:
              schema:
                properties:
                  groups:
                    items:
                      type: string
                    type: array
                  status:
                    enum:
                    - DOWN
                    - OUT_OF_SERVICE
                    type: string
                required:
                - status
                type: object
          description: Health
      summary: health info
      tags:
      - Meta
  /app-info:
    get:
      responses:
        "200":
          content:
            application/json:
              schema:
                description: Info
                properties:
                  app:
                    properties:
                      buildtime:
                        type: string
                      name:
                        type: string
                      version:
                        type: string
                      version2:
                        type: string
                    type: object
                required:
                - app
          description: Info
      summary: applicatie info
      tags:
      - Meta
  /werkzaamheden:
    get:
      description: Retourneert de urns van alle werkzaamheden, ongeacht of en wanneer
        de werkzaamheid actieve versies heeft.
      parameters:
      - description: Het gewenste aantal items per pagina in een gepagineerde response.
        in: query
        name: pageSize
        required: false
        schema:
          enum:
          - 10
          - 20
          - 50
          - 100
          - 200
          type: integer
      - description: De pagina die geretourneerd moet worden in een gepagineerde response.
        in: query
        name: page
        required: false
        schema:
          default: 1
          minimum: 1
          type: integer
      - description: |
          Sortering van de resultaten:
            - URN: alfabetisch oplopend op URN
            - -URN: alfabetisch aflopend op URN
        in: query
        name: _sort
        required: false
        schema:
          default: URN
          enum:
          - -URN
          - URN
          type: string
      responses:
        "200":
          content:
            application/hal+json:
              schema:
                description: Lijst van werkzaamheden met HAL links.
                properties:
                  _embedded:
                    properties:
                      werkzaamheden:
                        items:
                          allOf:
                          - description: Werkzaamheid gegevens
                            properties:
                              urn:
                                description: Urn van de werkzaamheid
                                example: BoomKappen
                                pattern: ^\w{1,100}$
                                type: string
                            required:
                            - urn
                          - properties:
                              _links:
                                properties:
                                  versies:
                                    allOf:
                                    - description: HAL link
                                      properties:
                                        href:
                                          description: URI
                                          type: string
                                      required:
                                      - href
                                    description: HAL link om alle versies van de werkzaamheid
                                      op te halen
                                required:
                                - versies
                            required:
                            - _links
                          description: Werkzaamheid met HAL links
                        minItems: 1
                        type: array
                    required:
                    - werkzaamheden
                  _links:
                    description: Links om te navigeren door de paginering
                    properties:
                      first:
                        allOf:
                        - description: HAL link
                          properties:
                            href:
                              description: URI
                              type: string
                          required:
                          - href
                        description: uri voor het opvragen van de eerste pagina van
                          deze collectie
                      last:
                        allOf:
                        - description: HAL link
                          properties:
                            href:
                              description: URI
                              type: string
                          required:
                          - href
                        description: uri voor het opvragen van de laatste pagina van
                          deze collectie
                      next:
                        allOf:
                        - description: HAL link
                          properties:
                            href:
                              description: URI
                              type: string
                          required:
                          - href
                        description: uri voor het opvragen van de volgende pagina
                          van deze collectie
                      prev:
                        allOf:
                        - description: HAL link
                          properties:
                            href:
                              description: URI
                              type: string
                          required:
                          - href
                        description: uri voor het opvragen van de vorige pagina van
                          deze collectie
                      self:
                        allOf:
                        - description: HAL link
                          properties:
                            href:
                              description: URI
                              type: string
                          required:
                          - href
                        description: uri voor het opvragen van de huidige pagina van
                          deze collectie
                    required:
                    - self
                    - first
                    - last
                  page:
                    description: Info voor paginering.
                    properties:
                      number:
                        description: het huidige paginanummer
                        minimum: 1
                        type: integer
                      size:
                        description: het aantal items op de huidige pagina
                        minimum: 0
                        type: integer
                      totalElements:
                        description: het totaal aantal items in deze collectie
                        minimum: 0
                        type: integer
                      totalPages:
                        description: het totaal aantal pagina's in deze collectie
                        minimum: 0
                        type: integer
                    required:
                    - size
                    - totalElements
                    - totalPages
                    - number
                    type: object
                required:
                - _links
                - page
          description: De lijst van werkzaamheden.
        "400":
          content:
            application/problem+json:
              schema:
                allOf:
                - properties:
                    detail:
                      description: Meer detail informatie over de opgetreden fout
                      type: string
                    instance:
                      description: Het unieke instance id van het request dat resulteerde
                        in de foutmelding.
                      type: string
                    status:
                      description: De statuscode van de fout (= 400) overeenkomend
                        met de http-status code van de response.
                      format: int64
                      type: integer
                    title:
                      description: Informatie over de opgetreden fout.
                      type: string
                    type:
                      description: Het type fout dat opgetreden is. Bijvoorbeeld VALIDATIE_FOUT
                        of ONVERWACHTE_FOUT.
                      type: string
                  required:
                  - type
                  - title
                  - status
                - properties:
                    invalid-params:
                      items:
                        properties:
                          name:
                            description: '''Naam van de parameter die een fout bevat,
                              bijvoorbeeld: activiteitFunctioneleStructuurRef'''
                            type: string
                          reason:
                            description: Bijvoorbeeld 'de activiteitFunctioneleStructuurRef
                              mag geen speciale karakters bevatten.'
                            type: string
                          type:
                            description: Een type van de fout, bijvoorbeeld 'Validatie
                              melding'
                            type: string
                        required:
                        - type
                        - name
                        - reason
                      type: array
          description: Fouten (missing parameter; niet bestaande parameter; invalide
            waarde voor parameter)
        "429":
          description: Te veel requests (binnen een bepaalde tijd)
        "500":
          content:
            application/problem+json:
              schema:
                properties:
                  detail:
                    description: Meer detail informatie over de opgetreden fout
                    type: string
                  instance:
                    description: Het unieke instance id van het request dat resulteerde
                      in de foutmelding.
                    type: string
                  status:
                    description: De statuscode (= 500) van de fout overeenkomend met
                      de http-status code van de response.
                    format: int64
                    type: integer
                  title:
                    description: Informatie over de opgetreden fout.
                    type: string
                  type:
                    description: Het type fout dat opgetreden is. Bijvoorbeeld VALIDATIE_FOUT
                      of ONVERWACHTE_FOUT.
                    type: string
                required:
                - type
                - title
                - status
          description: Er is een onverwachte technische fout opgetreden
      summary: Opvragen alle werkzaamheden
      tags:
      - Opvragen Werkzaamheden
  /werkzaamheden/{urn}:
    get:
      description: Retourneert versies van een werkzaamheid, eventueel met trefwoorden
        en/of gerelateerde werkzaamheden.
      parameters:
      - description: De urn van de werkzaamheid
        in: path
        name: urn
        required: true
        schema:
          description: Urn van de werkzaamheid
          example: BoomKappen
          pattern: ^\w{1,100}$
          type: string
      - description: Datum waarop de versie van de werkzaamheid geldig is.
        in: query
        name: geldigOp
        schema:
          description: Datum in het formaat yyyy-MM-dd
          example: "2023-01-01"
          format: date
          pattern: ^\d{4}-\d{2}-\d{2}$
          type: string
      - description: Het gewenste aantal items per pagina in een gepagineerde response.
        in: query
        name: pageSize
        required: false
        schema:
          enum:
          - 10
          - 20
          - 50
          - 100
          - 200
          type: integer
      - description: De pagina die geretourneerd moet worden in een gepagineerde response.
        in: query
        name: page
        required: false
        schema:
          default: 1
          minimum: 1
          type: integer
      - description: Het veld waarop gesorteerd moet worden. Door een minteken (“-”)
          voor de veldnaam te zetten wordt het veld in aflopende volgorde gesorteerd.
        in: query
        name: _sort
        required: false
        schema:
          default: URN
          enum:
          - -URN
          - URN
          - -OMSCHRIJVING
          - OMSCHRIJVING
          type: string
      - description: Indien true, worden sub-resources genest teruggegeven als onderdeel
          van het antwoordbericht. De parameter _expandScope is in dit geval verplicht
          om aan te geven welke sub-resources het betreft.
        in: query
        name: _expand
        schema:
          type: boolean
      - description: Geeft aan welke geneste resources teruggegeven worden als onderdeel
          van het antwoordbericht. Heeft alleen effect als de parameter _expand de
          waarde true heeft. De waarde is een komma gescheiden lijst.
        explode: false
        in: query
        name: _expandScope
        schema:
          items:
            enum:
            - TREFWOORDEN
            - LOGISCHE_RELATIES
            maxItems: 2
            type: string
          type: array
      responses:
        "200":
          content:
            application/hal+json:
              schema:
                description: Lijst van werkzaamheid versies met HAL links en eventueel
                  gerelateerde gegevens (in het geval _expand is gebruikt)
                properties:
                  _embedded:
                    properties:
                      werkzaamheidversies:
                        items:
                          allOf:
                          - description: Werkzaamheid versie gegevens
                            properties:
                              beginDatum:
                                allOf:
                                - description: Datum in het formaat yyyy-MM-dd
                                  example: "2023-01-01"
                                  format: date
                                  pattern: ^\d{4}-\d{2}-\d{2}$
                                  type: string
                                description: De datum vanaf wanneer de werkzaamheid
                                  versie geldig is.
                                type: string
                              eindDatum:
                                allOf:
                                - description: Datum in het formaat yyyy-MM-dd
                                  example: "2023-01-01"
                                  format: date
                                  pattern: ^\d{4}-\d{2}-\d{2}$
                                  type: string
                                description: De datum tot en met wanneer de werkzaamheid
                                  versie geldig is.
                                type: string
                              omschrijving:
                                description: Omschrijving van de werkzaamheid versie
                                example: Vellen van een houtopstand
                                maxLength: 250
                                minLength: 1
                                type: string
                              urn:
                                description: Urn van de werkzaamheid
                                example: BoomKappen
                                pattern: ^\w{1,100}$
                                type: string
                            required:
                            - urn
                            - omschrijving
                            - beginDatum
                          - properties:
                              _embedded:
                                properties:
                                  logischeRelaties:
                                    description: De werkzaamheden waarnaar een logische
                                      relatie bestaat.
                                    items:
                                      allOf:
                                      - description: Werkzaamheid gegevens
                                        properties:
                                          urn:
                                            description: Urn van de werkzaamheid
                                            example: BoomKappen
                                            pattern: ^\w{1,100}$
                                            type: string
                                        required:
                                        - urn
                                      - properties:
                                          _links:
                                            properties:
                                              versies:
                                                allOf:
                                                - description: HAL link
                                                  properties:
                                                    href:
                                                      description: URI
                                                      type: string
                                                  required:
                                                  - href
                                                description: HAL link om alle versies
                                                  van de werkzaamheid op te halen
                                            required:
                                            - versies
                                        required:
                                        - _links
                                      description: Werkzaamheid met HAL links
                                    type: array
                                  trefwoorden:
                                    description: Trefwoorden van de werkzaamheid versie
                                    example:
                                    - Omhakken
                                    - Boom
                                    items:
                                      description: Trefwoord van de werkzaamheid versie
                                      example: Omhakken
                                      maxLength: 250
                                      minLength: 1
                                      type: string
                                    maxItems: 500
                                    type: array
                          description: Werkzaamheid versie met HAL links
                        minItems: 1
                        type: array
                    required:
                    - werkzaamheidversies
                  _links:
                    description: Links om te navigeren door de paginering
                    properties:
                      first:
                        allOf:
                        - description: HAL link
                          properties:
                            href:
                              description: URI
                              type: string
                          required:
                          - href
                        description: uri voor het opvragen van de eerste pagina van
                          deze collectie
                      last:
                        allOf:
                        - description: HAL link
                          properties:
                            href:
                              description: URI
                              type: string
                          required:
                          - href
                        description: uri voor het opvragen van de laatste pagina van
                          deze collectie
                      next:
                        allOf:
                        - description: HAL link
                          properties:
                            href:
                              description: URI
                              type: string
                          required:
                          - href
                        description: uri voor het opvragen van de volgende pagina
                          van deze collectie
                      prev:
                        allOf:
                        - description: HAL link
                          properties:
                            href:
                              description: URI
                              type: string
                          required:
                          - href
                        description: uri voor het opvragen van de vorige pagina van
                          deze collectie
                      self:
                        allOf:
                        - description: HAL link
                          properties:
                            href:
                              description: URI
                              type: string
                          required:
                          - href
                        description: uri voor het opvragen van de huidige pagina van
                          deze collectie
                    required:
                    - self
                    - first
                    - last
                  page:
                    description: Info voor paginering.
                    properties:
                      number:
                        description: het huidige paginanummer
                        minimum: 1
                        type: integer
                      size:
                        description: het aantal items op de huidige pagina
                        minimum: 0
                        type: integer
                      totalElements:
                        description: het totaal aantal items in deze collectie
                        minimum: 0
                        type: integer
                      totalPages:
                        description: het totaal aantal pagina's in deze collectie
                        minimum: 0
                        type: integer
                    required:
                    - size
                    - totalElements
                    - totalPages
                    - number
                    type: object
                required:
                - _links
                - page
          description: De werkzaamheid versies van de meegegeven urn.
        "400":
          content:
            application/problem+json:
              schema:
                allOf:
                - properties:
                    detail:
                      description: Meer detail informatie over de opgetreden fout
                      type: string
                    instance:
                      description: Het unieke instance id van het request dat resulteerde
                        in de foutmelding.
                      type: string
                    status:
                      description: De statuscode van de fout (= 400) overeenkomend
                        met de http-status code van de response.
                      format: int64
                      type: integer
                    title:
                      description: Informatie over de opgetreden fout.
                      type: string
                    type:
                      description: Het type fout dat opgetreden is. Bijvoorbeeld VALIDATIE_FOUT
                        of ONVERWACHTE_FOUT.
                      type: string
                  required:
                  - type
                  - title
                  - status
                - properties:
                    invalid-params:
                      items:
                        properties:
                          name:
                            description: '''Naam van de parameter die een fout bevat,
                              bijvoorbeeld: activiteitFunctioneleStructuurRef'''
                            type: string
                          reason:
                            description: Bijvoorbeeld 'de activiteitFunctioneleStructuurRef
                              mag geen speciale karakters bevatten.'
                            type: string
                          type:
                            description: Een type van de fout, bijvoorbeeld 'Validatie
                              melding'
                            type: string
                        required:
                        - type
                        - name
                        - reason
                      type: array
          description: Fouten (missing parameter; niet bestaande parameter; invalide
            waarde voor parameter)
        "404":
          content:
            application/problem+json:
              schema:
                allOf:
                - properties:
                    detail:
                      description: Meer detail informatie over de opgetreden fout
                      type: string
                    instance:
                      description: Het unieke instance id van het request dat resulteerde
                        in de foutmelding.
                      type: string
                    status:
                      description: De statuscode van de fout (= 404) overeenkomend
                        met de http-status code van de response.
                      format: int64
                      type: integer
                    title:
                      description: Informatie over de opgetreden fout.
                      type: string
                    type:
                      description: Het type resource dat niet gevonden is.
                      type: string
                  required:
                  - type
                  - title
                  - status
                - properties:
                    detail:
                      description: De identifier van het object dat niet gevonden
                        is. Bijvoorbeeld de URN van een activiteit.
                      type: string
                    type:
                      description: Bevat informatie over het type object dat niet
                        gevonden is. Bijvoorbeeld ACTIVITY_NOT_FOUND of SUBACTIVITY_NOT_FOUND
                      type: string
          description: De gevraagde resource is niet gevonden
        "429":
          description: Te veel requests (binnen een bepaalde tijd)
        "500":
          content:
            application/problem+json:
              schema:
                properties:
                  detail:
                    description: Meer detail informatie over de opgetreden fout
                    type: string
                  instance:
                    description: Het unieke instance id van het request dat resulteerde
                      in de foutmelding.
                    type: string
                  status:
                    description: De statuscode (= 500) van de fout overeenkomend met
                      de http-status code van de response.
                    format: int64
                    type: integer
                  title:
                    description: Informatie over de opgetreden fout.
                    type: string
                  type:
                    description: Het type fout dat opgetreden is. Bijvoorbeeld VALIDATIE_FOUT
                      of ONVERWACHTE_FOUT.
                    type: string
                required:
                - type
                - title
                - status
          description: Er is een onverwachte technische fout opgetreden
      summary: Opvragen details van een werkzaamheid
      tags:
      - Opvragen Werkzaamheden
  /werkzaamheidversies:
    get:
      description: Retourneert versies van werkzaamheden, gefilterd op urn of datum.
        N.B. minstens één van de filters urns of geldigOp moet worden meegegeven.
      parameters:
      - description: Komma-gescheiden lijst van werkzaamheid urn's waarvan de versies
          worden opgevraagd. Indien geen urn's worden meegegeven, is het verplicht
          om een geldigOp datum mee te geven.
        explode: false
        in: query
        name: urns
        required: false
        schema:
          items:
            description: Urn van de werkzaamheid
            example: BoomKappen
            pattern: ^\w{1,100}$
            type: string
          maxItems: 50
          type: array
      - description: Datum waarop de versie van de werkzaamheid geldig is.
        in: query
        name: geldigOp
        schema:
          description: Datum in het formaat yyyy-MM-dd
          example: "2023-01-01"
          format: date
          pattern: ^\d{4}-\d{2}-\d{2}$
          type: string
      - description: Het gewenste aantal items per pagina in een gepagineerde response.
        in: query
        name: pageSize
        required: false
        schema:
          enum:
          - 10
          - 20
          - 50
          - 100
          - 200
          type: integer
      - description: De pagina die geretourneerd moet worden in een gepagineerde response.
        in: query
        name: page
        required: false
        schema:
          default: 1
          minimum: 1
          type: integer
      - description: Het veld waarop gesorteerd moet worden. Door een minteken (“-”)
          voor de veldnaam te zetten wordt het veld in aflopende volgorde gesorteerd.
        in: query
        name: _sort
        required: false
        schema:
          default: URN
          enum:
          - -URN
          - URN
          - -OMSCHRIJVING
          - OMSCHRIJVING
          type: string
      responses:
        "200":
          content:
            application/hal+json:
              schema:
                description: Lijst van werkzaamheid versies met HAL links
                properties:
                  _embedded:
                    properties:
                      werkzaamheidversies:
                        items:
                          description: Werkzaamheid versie gegevens
                          properties:
                            beginDatum:
                              allOf:
                              - description: Datum in het formaat yyyy-MM-dd
                                example: "2023-01-01"
                                format: date
                                pattern: ^\d{4}-\d{2}-\d{2}$
                                type: string
                              description: De datum vanaf wanneer de werkzaamheid
                                versie geldig is.
                              type: string
                            eindDatum:
                              allOf:
                              - description: Datum in het formaat yyyy-MM-dd
                                example: "2023-01-01"
                                format: date
                                pattern: ^\d{4}-\d{2}-\d{2}$
                                type: string
                              description: De datum tot en met wanneer de werkzaamheid
                                versie geldig is.
                              type: string
                            omschrijving:
                              description: Omschrijving van de werkzaamheid versie
                              example: Vellen van een houtopstand
                              maxLength: 250
                              minLength: 1
                              type: string
                            urn:
                              description: Urn van de werkzaamheid
                              example: BoomKappen
                              pattern: ^\w{1,100}$
                              type: string
                          required:
                          - urn
                          - omschrijving
                          - beginDatum
                        minItems: 1
                        type: array
                    required:
                    - werkzaamheidversies
                  _links:
                    description: Links om te navigeren door de paginering
                    properties:
                      first:
                        allOf:
                        - description: HAL link
                          properties:
                            href:
                              description: URI
                              type: string
                          required:
                          - href
                        description: uri voor het opvragen van de eerste pagina van
                          deze collectie
                      last:
                        allOf:
                        - description: HAL link
                          properties:
                            href:
                              description: URI
                              type: string
                          required:
                          - href
                        description: uri voor het opvragen van de laatste pagina van
                          deze collectie
                      next:
                        allOf:
                        - description: HAL link
                          properties:
                            href:
                              description: URI
                              type: string
                          required:
                          - href
                        description: uri voor het opvragen van de volgende pagina
                          van deze collectie
                      prev:
                        allOf:
                        - description: HAL link
                          properties:
                            href:
                              description: URI
                              type: string
                          required:
                          - href
                        description: uri voor het opvragen van de vorige pagina van
                          deze collectie
                      self:
                        allOf:
                        - description: HAL link
                          properties:
                            href:
                              description: URI
                              type: string
                          required:
                          - href
                        description: uri voor het opvragen van de huidige pagina van
                          deze collectie
                    required:
                    - self
                    - first
                    - last
                  page:
                    description: Info voor paginering.
                    properties:
                      number:
                        description: het huidige paginanummer
                        minimum: 1
                        type: integer
                      size:
                        description: het aantal items op de huidige pagina
                        minimum: 0
                        type: integer
                      totalElements:
                        description: het totaal aantal items in deze collectie
                        minimum: 0
                        type: integer
                      totalPages:
                        description: het totaal aantal pagina's in deze collectie
                        minimum: 0
                        type: integer
                    required:
                    - size
                    - totalElements
                    - totalPages
                    - number
                    type: object
                required:
                - _links
                - page
          description: De gevraagde werkzaamheidversies
        "400":
          content:
            application/problem+json:
              schema:
                allOf:
                - properties:
                    detail:
                      description: Meer detail informatie over de opgetreden fout
                      type: string
                    instance:
                      description: Het unieke instance id van het request dat resulteerde
                        in de foutmelding.
                      type: string
                    status:
                      description: De statuscode van de fout (= 400) overeenkomend
                        met de http-status code van de response.
                      format: int64
                      type: integer
                    title:
                      description: Informatie over de opgetreden fout.
                      type: string
                    type:
                      description: Het type fout dat opgetreden is. Bijvoorbeeld VALIDATIE_FOUT
                        of ONVERWACHTE_FOUT.
                      type: string
                  required:
                  - type
                  - title
                  - status
                - properties:
                    invalid-params:
                      items:
                        properties:
                          name:
                            description: '''Naam van de parameter die een fout bevat,
                              bijvoorbeeld: activiteitFunctioneleStructuurRef'''
                            type: string
                          reason:
                            description: Bijvoorbeeld 'de activiteitFunctioneleStructuurRef
                              mag geen speciale karakters bevatten.'
                            type: string
                          type:
                            description: Een type van de fout, bijvoorbeeld 'Validatie
                              melding'
                            type: string
                        required:
                        - type
                        - name
                        - reason
                      type: array
          description: Fouten (missing parameter; niet bestaande parameter; invalide
            waarde voor parameter)
        "429":
          description: Te veel requests (binnen een bepaalde tijd)
        "500":
          content:
            application/problem+json:
              schema:
                properties:
                  detail:
                    description: Meer detail informatie over de opgetreden fout
                    type: string
                  instance:
                    description: Het unieke instance id van het request dat resulteerde
                      in de foutmelding.
                    type: string
                  status:
                    description: De statuscode (= 500) van de fout overeenkomend met
                      de http-status code van de response.
                    format: int64
                    type: integer
                  title:
                    description: Informatie over de opgetreden fout.
                    type: string
                  type:
                    description: Het type fout dat opgetreden is. Bijvoorbeeld VALIDATIE_FOUT
                      of ONVERWACHTE_FOUT.
                    type: string
                required:
                - type
                - title
                - status
          description: Er is een onverwachte technische fout opgetreden
      summary: Opvragen versies van werkzaamheden
      tags:
      - Opvragen Werkzaamheden
servers:
- url: /publiek/toepasbare-regels/api/werkzaamheden/v1
tags:
- description: Meta informatie over deze API zelf zoals deze API specificatie, en
    informatie over de actuele status van deze API.
  name: Meta
- description: Leesoperaties om werkzaamheid en werkzaamheid versie informatie op
    te vragen.
  name: Opvragen Werkzaamheden
x-wso2-cors:
  accessControlAllowCredentials: false
  accessControlAllowHeaders:
  - authorization
  - Access-Control-Allow-Origin
  - Content-Type
  - SOAPAction
  accessControlAllowMethods:
  - GET
  - PUT
  - POST
  - DELETE
  - PATCH
  - OPTIONS
  accessControlAllowOrigins:
  - '*'
  corsConfigurationEnabled: true
