Die REST Schnittstelle bietet die Möglichkeit über den internen Authentifizierungsserver (IdentityServer) ein Access-Token zu generieren und damit den Zugriff auf die API des Data Quality Servers zu ermöglichen.

Schittstellenbeschreibung in OpenAPI 3.0.0
openapi: 3.0.0
info:
  description: DQServer REST / JSON Service Doukemtaion
  version: V1
  title: DQServer REST / JSON Service Doukemtaion
  contact:
    name: Omikron Data Quality Service Desk
    url: 'http://omikron.net'
    email: servicedesk@omikron.net
servers:
  - url: 'http://localhost/DQServer'
    description: Lokale DQ-Server Installation
paths:
  /api/v1/workflows/RBWF_HelloWorld:
    post:
      summary: path summary
      security:
        - oDQServerAuth: []
      requestBody:
        description: Ein Aufruf eines Hallo Welt Beispielworkflows
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InputRecordStructure'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OutputRecordStructureAdv'
components:
  schemas:
    InputRecordStructure:
      title: Die Eingangssatzstruktur
      type: array
      items:
        type: array
        items:
          type: string
      example:
        - Fields:
            - Field 1
            - Field 2
          Values:
            - Value 1
            - Value 2
    OutputRecordStructureAdv:
      title: Die Ausgabesatzstruktur
      type: array
      items:
        type: array
        items:
          type: string
      example:
        - Fields:
            - Field 1
            - Field 2
          Values:
            - Value 1
            - Value 2
          ResultTableFields:
            - TableField 1
            - TableField 2
          ResultTableValues:
            - TableValue 1
            - TableValue 2
  securitySchemes:
    oDQServerAuth:
      type: oauth2
      description: Authentifizierung mit oauth2
      flows:
        password:
          tokenUrl: /DQServer/authentication/connect/token
          scopes:
            dqserver: DQServer-Scope
  • No labels