Qlik Sense Data Product Data Quality API

openapi: 3.2.0
info:
  title: data-governance/data-products Data Product Data Quality API
  version: ''
servers:
- url: https://{tenant}.{region}.qlikcloud.com
  variables:
    region:
      default: us
      description: The region the tenant is hosted in
    tenant:
      default: your-tenant
      description: Name of the tenant that will be called
tags:
- name: data-product-data-quality
paths:
  /api/data-governance/data-products/{dataProductId}/actions/compute-datasets-data-quality:
    post:
      tags:
      - data-product-data-quality
      summary: Trigger data quality computation for the data-product's datasets
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatasetsComputationResponse'
          headers:
            location:
              schema:
                type: string
              example: /api/data-governance/data-qualities/batch-computations/12345
              description: Location where the result can be retrieved
          description: Data quality computation triggered successfully.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: The request is in incorrect format.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: User does not have valid authentication credentials.
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: User does not have access to the resource.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Resource does not exist.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal server error.
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Service temporarily unavailable. Retry the request.
      parameters:
      - $ref: '#/components/parameters/DataProductIdPath'
      description: 'Triggers a full data quality computation for all datasets in the data product, running profile calculation followed by data quality

        assessment. Returns a `batchComputationId` that can be used to track overall progress via the batch computation status endpoint

        (`GET /api/data-governance/data-qualities/batch-computations/{batchComputationId}`). The computation runs asynchronously.

        Poll the status endpoint until `status` is `FINISHED`.'
      operationId: requestDataQualityComputation
      x-qlik-stability: stable
      x-qlik-visibility: public
      x-qlik-deprecated: false
      x-qlik-tier:
        tier: special
        limit: 10
components:
  schemas:
    Error:
      type: object
      properties:
        code:
          type: string
        title:
          type: string
        detail:
          type: string
        status:
          type: string
    ErrorResponse:
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        traceId:
          type: string
    DatasetIdType:
      type: string
      example: 669144f5aa2d642638ef1dd0
      pattern: ^[0-9a-zA-Z-]{1,36}$
      description: The ID of the dataset
    ComputationResponse:
      type: object
      required:
      - datasetId
      - status
      - computationId
      properties:
        error:
          type: string
          description: Error message if the computation failed; absent on success.
        status:
          $ref: '#/components/schemas/ExecutionStatus'
        datasetId:
          $ref: '#/components/schemas/DatasetIdType'
        computationId:
          type: string
          description: Unique identifier for this individual data quality computation job.
      description: Result of a data quality computation for a single dataset.
    DatasetsComputationResponse:
      type: object
      required:
      - batchComputationId
      - datasetResponses
      properties:
        datasetResponses:
          type: array
          items:
            $ref: '#/components/schemas/ComputationResponse'
          description: List of computation results, one entry per dataset in the data product.
        batchComputationId:
          type: string
          description: Unique identifier for the data quality batch computation job.
      description: Response containing the batch computation identifier and per-dataset quality computation results.
    ExecutionStatus:
      enum:
      - REQUESTED
      - FAILED
      type: string
      example: REQUESTED
      description: Current execution status of the computation (REQUESTED or FAILED).
  parameters:
    DataProductIdPath:
      in: path
      name: dataProductId
      schema:
        type: string
      required: true
      description: Unique identifier of the data product. Must be a valid GUID assigned when the data product was created.