components:
  parameters:
    aansluitpuntBestuurslaag:
      description: |
        bij een aansluitpunt de aangegeven bestuurslaag van de bestuursorganen die aansluitingen kunnen aanleveren
      in: query
      name: aansluitpuntBestuurslaag
      schema:
        enum:
        - rijk
        - provincie
        - waterschap
        - gemeente
        type: string
    datum:
      description: Het request wordt uitgevoerd voor de versie van de resource die
        geldig is op deze datum. Indien geen datum meegegeven wordt het request uitgevoerd
        tegen de op dit moment geldende versie. Het formaat van de datum is dd-MM-yyyy.
        Indien de resource geneste objecten bevat die geversioneerd zijn, zal op deze
        objecten dezelfde datum-filtering toegepast worden.
      in: query
      name: datum
      schema:
        example: 01-01-2023
        pattern: ^\d{2}-\d{2}-\d{4}$
        type: string
    datumVanaf:
      description: Het request wordt uitgevoerd voor de versies van de resource die
        geldig zijn op of na deze datum. Het formaat van de datum is dd-MM-yyyy. Indien
        deze parameter gebruikt wordt in combinatie met de datum parameter, dan zal
        de datum parameter genegeerd worden
      in: query
      name: datumVanaf
      schema:
        example: 01-01-2023
        pattern: ^\d{2}-\d{2}-\d{4}$
        type: string
    expand:
      description: |
        Bepaalt of de aansluitpunten en aansluitingen meegeladen moeten worden in de response.
      in: query
      name: expand
      schema:
        type: boolean
    functioneleStructuurRef:
      description: |
        de functioneleStructuurRef van de toepasbare regels
      in: query
      name: functioneleStructuurRef
      schema:
        type: string
    oin:
      description: |
        de oin van het bestuursorgaan dat eigenaar is van deze toepasbare regels
      in: query
      name: oin
      schema:
        type: string
    page:
      description: De pagina die geretourneerd moet worden in een gepagineerde response.
        Wanneer er geen pagina nummer is opgegeven wordt de eerste pagina geretourneerd
      in: query
      name: page
      required: false
      schema:
        default: 1
        minimum: 1
        type: integer
    pageSize:
      description: Het aantal items per pagina in een gepagineerde response. Maximaal
        500. Als een pageSize groter dan 500 wordt meegegeven, wordt een grootte van
        500 gehanteerd.
      in: query
      name: pageSize
      required: false
      schema:
        minimum: 1
        type: integer
    sttrBestandInhoudFilter:
      description: |
        Filter op sttr-bestanden met een specifieke inhoud. Momenteel alleen mogelijk om te filteren op 'herbruikbareBeslissing', dit zijn sttr-bestanden die een dmn-decision bevatten waarvan de typeRef de waarde "herbruikbaar" heeft.
      in: query
      name: sttrBestandInhoudFilter
      schema:
        enum:
        - herbruikbareBeslissing
        type: string
    toepasbareRegelsIdentifier:
      description: |
        De identifier van de toepasbare regels
      in: path
      name: toepasbareRegelsIdentifier
      required: true
      schema:
        type: string
    x_api_key:
      description: De api-key ter authenticatie, verkrijgbaar via het ontwikkelaarsportaal
      in: header
      name: x-api-key
      required: false
      schema:
        type: string
  responses:
    "400":
      content:
        application/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/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
    "500":
      content:
        application/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:
    Bestuurslaag:
      description: Bestuurslaag van een Organisatie
      enum:
      - rijk
      - provincie
      - waterschap
      - gemeente
      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:
          - $ref: '#/components/schemas/HalLink'
          description: uri voor het opvragen van de eerste pagina van deze collectie
        last:
          allOf:
          - $ref: '#/components/schemas/HalLink'
          description: uri voor het opvragen van de laatste pagina van deze collectie
        next:
          allOf:
          - $ref: '#/components/schemas/HalLink'
          description: uri voor het opvragen van de volgende pagina van deze collectie
        prev:
          allOf:
          - $ref: '#/components/schemas/HalLink'
          description: uri voor het opvragen van de vorige pagina van deze collectie
        self:
          allOf:
          - $ref: '#/components/schemas/HalLink'
          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:
          deprecated: true
          description: 'het aantal items op de huidige pagina. Let op: in een volgende
            versie wordt dit de gevraagde paginagrootte.'
          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
    ToepasbareRegels:
      properties:
        aansluiting:
          description: aansluiting informatie van deze toepasbare regels
          properties:
            aansluitpuntSoort:
              description: De functionele versie van de aansluiting.
              enum:
              - V1
              - V2
              type: string
            locaties:
              description: De identifiers van de locaties waar deze aansluiting actief
                is
              items:
                type: string
              type: array
            standaardAansluiting:
              description: Is standaard aansluiting?
              type: boolean
          required:
          - standaardAansluiting
          - aansluitpuntSoort
        aansluitpunt:
          description: aansluitpunt informatie van deze toepasbare regels
          properties:
            aansluitpuntSoort:
              description: De functionele versie van het aansluitpunt.
              enum:
              - V1
              - V2
              type: string
            bestuurslaag:
              allOf:
              - $ref: '#/components/schemas/Bestuurslaag'
              - description: De aangegeven bestuurslaag van de bestuursorganen die
                  aansluitingen kunnen aanleveren
              type: string
            decisionName:
              description: De decision name van de topdecision die moet wordt gebruikt
                in het STTR bestand van de aansluiting.
              type: string
            modelName:
              description: De model (definition) name die moet worden gebruikt in
                het STTR bestand van de aansluiting.
              type: string
            naam:
              description: De naam van het aansluitpunt van deze toepasbare regels
              type: string
          required:
          - naam
          - bestuurslaag
          - modelName
          - decisionName
          - aansluitpuntSoort
        begindatum:
          description: De datum vanaf wanneer deze toepasbare regels actief zijn.
            Het formaat van de datum is dd-MM-yyyy
          type: string
        einddatum:
          description: De datum tot wanneer deze toepasbare regels actief zijn. Het
            formaat van de datum is dd-MM-yyyy
          type: string
        functioneleStructuurRef:
          description: de functionele structuur referentie waaronder deze toepasbare
            regels bekend zijn in de registratie toepasbare regels
          type: string
        identifier:
          type: integer
        laatsteWijzigingDatum:
          description: De datum waarop deze toepasbare regels voor het laatst gewijzigd
            zijn. Het formaat van de datum is dd-MM-yyyy
          type: string
        oin:
          description: oin van bet bestuursorgaan dat eigenaar is van deze toepasbare
            regels
          type: string
        sttrVersie:
          description: De versie van de STTR-standaard van het bestand
          type: integer
      required:
      - identifier
      - sttrVersie
      - functioneleStructuurRef
      - begindatum
      - laatsteWijzigingDatum
      - oin
    ToepasbareRegelsHALResponseList:
      properties:
        _embedded:
          properties:
            toepasbareRegels:
              items:
                $ref: '#/components/schemas/ToepasbareRegelsHalResponse'
              type: array
        _links:
          $ref: '#/components/schemas/HalPaginationLinks'
        page:
          $ref: '#/components/schemas/Page'
    ToepasbareRegelsHalResponse:
      allOf:
      - $ref: '#/components/schemas/ToepasbareRegels'
      - required:
        - _links
      - properties:
          _embedded:
            properties:
              aansluitingen:
                description: 'Alleen gevuld als het een aansluitpunt betreft. Als
                  de datumVanaf filter wordt gebruikt: Aansluitingen die vanaf datumVanaf,
                  en vanaf de begindatum tot en met de einddatum van het aansluitpunt,
                  minstens 1 dag actief zijn. Anders: Aansluitingen die op de datum
                  actief zijn.'
                items:
                  $ref: '#/components/schemas/ToepasbareRegels'
                type: array
              aansluitpunt:
                allOf:
                - $ref: '#/components/schemas/ToepasbareRegels'
                description: Alleen gevuld als het een aansluiting betreft. Het aansluitpunt
                  waarop de aansluiting aansluit.
          _links:
            description: Links naar gerelateerde toepasbare regels en het bijbehorende
              STTR bestand van deze toepasbare regels.
            properties:
              aansluitingen:
                description: 'Alleen gevuld als het een aansluitpunt betreft. Als
                  de datumVanaf filter wordt gebruikt: Links naar de aansluitingen
                  die vanaf datumVanaf, en vanaf de begindatum tot en met de einddatum
                  van het aansluitpunt, minstens 1 dag actief zijn. Anders: Links
                  naar de aansluitingen die op de datum actief zijn.'
                items:
                  $ref: '#/components/schemas/HalLink'
                type: array
              aansluitpunt:
                allOf:
                - $ref: '#/components/schemas/HalLink'
                description: Alleen gevuld als het een aansluiting betreft. Link naar
                  het aansluitpunt waarop de aansluiting aansluit.
              self:
                $ref: '#/components/schemas/HalLink'
              sttrBestand:
                $ref: '#/components/schemas/HalLink'
            required:
            - self
            - sttrBestand
info:
  contact:
    name: Ontwikkelaarsportaal Omgevingswet
    url: https://developer.omgevingswet.overheid.nl/services/contact/
  description: Een REST-API voor het raadplegen van gegevens uit het Uitvoeren component
  title: Uitvoeren gegevens
  version: 1.1.6
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:
    $ref: '#/paths/~1health'
  /app-info:
    $ref: '#/paths/~1info'
  /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
  /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
  /toepasbareRegels:
    get:
      description: Retourneert de gegevens van alle toepasbare regels die voldoen
        aan de meegegeven filter criteria
      parameters:
      - $ref: '#/components/parameters/x_api_key'
      - $ref: '#/components/parameters/datum'
      - $ref: '#/components/parameters/datumVanaf'
      - $ref: '#/components/parameters/oin'
      - $ref: '#/components/parameters/aansluitpuntBestuurslaag'
      - $ref: '#/components/parameters/functioneleStructuurRef'
      - $ref: '#/components/parameters/expand'
      - $ref: '#/components/parameters/pageSize'
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/sttrBestandInhoudFilter'
      responses:
        "200":
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ToepasbareRegelsHALResponseList'
          description: Lijst van Toepasbare Regels
        "400":
          $ref: '#/components/responses/400'
        "404":
          $ref: '#/components/responses/404'
        "500":
          $ref: '#/components/responses/500'
      summary: Alle toepasbare regels
      tags:
      - Raadplegen Toepasbare regels
  /toepasbareRegels/{toepasbareRegelsIdentifier}:
    get:
      description: Retourneert de gegevens van de toepasbare regels behorende bij
        de meegegeven id
      parameters:
      - $ref: '#/components/parameters/x_api_key'
      - $ref: '#/components/parameters/toepasbareRegelsIdentifier'
      - $ref: '#/components/parameters/expand'
      - $ref: '#/components/parameters/datum'
      responses:
        "200":
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ToepasbareRegelsHalResponse'
          description: De Toepasbare Regels
        "400":
          $ref: '#/components/responses/400'
        "404":
          $ref: '#/components/responses/404'
        "500":
          $ref: '#/components/responses/500'
      summary: Ophalen van specifieke toepasbare regels
      tags:
      - Raadplegen Toepasbare regels
  /toepasbareRegels/{toepasbareRegelsIdentifier}/sttrBestand:
    get:
      description: Retourneert het STTR bestand horende bij deze specifieke toepasbare
        regels
      parameters:
      - $ref: '#/components/parameters/x_api_key'
      - $ref: '#/components/parameters/toepasbareRegelsIdentifier'
      responses:
        "200":
          content:
            application/xml:
              schema:
                format: binary
                type: string
          description: Het STTR Bestand
        "400":
          $ref: '#/components/responses/400'
        "404":
          $ref: '#/components/responses/404'
        "500":
          $ref: '#/components/responses/500'
      summary: Ophalen van het STTR bestand
      tags:
      - Raadplegen Toepasbare regels
x-wso2-cors:
  accessControlAllowCredentials: false
  accessControlAllowHeaders:
  - authorization
  - Access-Control-Allow-Origin
  - Content-Type
  - SOAPAction
  accessControlAllowMethods:
  - GET
  - PUT
  - POST
  - DELETE
  - PATCH
  - OPTIONS
  accessControlAllowOrigins:
  - '*'
  corsConfigurationEnabled: true
