Qlik Sense Data Product Activation API

openapi: 3.2.0
info:
  title: data-governance/data-products Data Product Activation 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-activation
paths:
  /api/data-governance/data-products/{dataProductId}/actions/activate:
    post:
      tags:
      - data-product-activation
      summary: Activate a data product
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataProductResponse'
          description: Created
        '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.
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: The input request conflicts with the current state of the resource.
        '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: 'Activates a data product for publishing and consumption.

        Once activated, the data product becomes discoverable and accessible to authorized users.

        Requires publish permissions and valid data product configuration.'
      operationId: activateDataProduct
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ActivateDataProductRequest'
        required: true
      x-qlik-visibility: public
      x-qlik-stability: stable
      x-qlik-deprecated: false
      x-qlik-tier:
        tier: '2'
        limit: 100
  /api/data-governance/data-products/{dataProductId}/actions/deactivate:
    post:
      tags:
      - data-product-activation
      summary: Deactivate a data product
      responses:
        '204':
          description: No content
        '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.
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: The input request conflicts with the current state of the resource.
        '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: Deactivates a data product, preventing it from being consumed by other services or users.
      operationId: deactivateDataProduct
      x-qlik-visibility: public
      x-qlik-stability: stable
      x-qlik-deprecated: false
      x-qlik-tier:
        tier: '2'
        limit: 100
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
    ActivateDataProductRequest:
      type: object
      required:
      - name
      properties:
        name:
          type: string
          example: ExampleDataProductName
          maxLength: 200
          description: Name of the data product to activate.
        tags:
          type: array
          items:
            type: string
            example: example
            description: List of tags for the data product.
          maxItems: 50
        spaceId:
          type: string
          example: ExampleSpaceId
          description: Unique identifier of the space.
        description:
          type: string
          example: This is an example data product.
          maxLength: 1024
          description: A description of the data product.
          x-size-message: The description should be set with a maximal length of 1024 characters
    DataProductResponse:
      type: object
      required:
      - id
      - tenantId
      - name
      - createdAt
      - createdBy
      - updatedAt
      - updatedBy
      - ownerId
      - datasetIds
      - apiConsumableDatasetIds
      - glossaryIds
      - keyContacts
      - tags
      - activatedOn
      - qri
      properties:
        id:
          type: string
        qri:
          type: string
          description: Qlik Resource Identifier (QRI) uniquely identifying the data product across the platform.
        name:
          type: string
        tags:
          type: array
          items:
            type: string
        mainId:
          type: string
          description: Primary identifier used for main data product reference.
        readMe:
          type: string
          description: Documentation in Markdown format providing detailed information about the data product.
        ownerId:
          type: string
          description: Identifier of the user who owns the data product and is responsible for governance.
        quality:
          $ref: '#/components/schemas/Quality'
        spaceId:
          type: string
        tenantId:
          type: string
        activated:
          type: boolean
          description: Indicates whether the data product is currently activated for consumption.
        createdAt:
          type: string
          format: date-time
          example: '2018-03-20T09:12:28Z'
          description: Timestamp when the data product was created in ISO 8601 format.
        createdBy:
          type: string
          description: Identifier of the user who created the data product.
        updatedAt:
          type: string
          format: date-time
          example: '2018-03-20T09:12:28Z'
          description: Timestamp of the most recent update in ISO 8601 format.
        updatedBy:
          type: string
          description: Identifier of the user who last updated the data product.
        datasetIds:
          type: array
          items:
            type: string
        trustScore:
          $ref: '#/components/schemas/TrustScore'
        activatedAt:
          type: string
          format: date-time
          example: '2018-03-20T09:12:28Z'
          description: Timestamp when the data product was most recently activated in ISO 8601 format.
        activatedOn:
          type: array
          items:
            type: string
          description: List of target environments or platforms where the data product is activated.
        description:
          type: string
        glossaryIds:
          type: array
          items:
            type: string
        keyContacts:
          type: array
          items:
            $ref: '#/components/schemas/KeyContact'
        pendingChangesCount:
          type: integer
          format: int32
          description: Number of pending changes that are not yet activated.
        apiConsumableDatasetIds:
          type: array
          items:
            type: string
            description: List of dataset IDs for which API consumption is enabled
          uniqueItems: true
    Quality:
      type: object
      required:
      - validity
      - completeness
      properties:
        validity:
          type: number
          format: float
        completeness:
          type: number
          format: float
    TrustScore:
      type: object
      required:
      - score
      - applicableDatasets
      properties:
        score:
          type: number
          format: float
        dimensions:
          type: array
          items:
            $ref: '#/components/schemas/TrustScoreDimension'
        previousScore:
          type: number
          format: float
        applicableDatasets:
          type: number
          format: int32
    KeyContact:
      type: object
      required:
      - userId
      properties:
        role:
          type: string
          example: Data Steward
          maxLength: 200
          description: Role of the key contact in the Data Product.
        userId:
          type: string
          example: exampleUserId
          description: Unique identifier of the user.
      description: 'Represents a designated contact person for a data product, optionally with their role.

        '
    TrustScoreDimension:
      type: object
      required:
      - id
      - applicableDatasets
      properties:
        id:
          type: string
        score:
          type: number
          format: float
        previousScore:
          type: number
          format: float
        applicableDatasets:
          type: number
          format: int32
  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.