Qlik Sense data task actions API

openapi: 3.2.0
info:
  title: di-projects data task actions 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 task actions
paths:
  /api/v1/di-projects/{projectId}/di-tasks/{dataTaskId}/actions/prepare:
    post:
      tags:
      - data task actions
      summary: Prepare a project task
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncActionRsp'
          headers:
            Location:
              $ref: '#/components/headers/AsyncActionLocation'
          description: Preparation started
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
          description: Invalid request
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
          description: Task not found
      parameters:
      - in: path
        name: dataTaskId
        schema:
          type: string
        examples:
          example:
            value: task-cYSY
        required: true
        description: Identifier of the data task.
      - in: path
        name: projectId
        schema:
          type: string
        examples:
          example:
            value: 65424a71c11367914c1e659b
        required: true
        description: Identifier of the data project.
      description: Prepares the specified data task for execution.
      operationId: prepare_task
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PrepareTaskReq'
        required: false
      x-qlik-visibility: public
      x-qlik-stability: stable
      x-qlik-deprecated: false
      x-qlik-tier:
        tier: '2'
        limit: 100
  /api/v1/di-projects/{projectId}/di-tasks/{dataTaskId}/actions/recreate-datasets:
    post:
      tags:
      - data task actions
      summary: Recreate task datasets
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncActionRsp'
          headers:
            Location:
              $ref: '#/components/headers/AsyncActionLocation'
          description: Started recreating datasets
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
          description: Invalid request
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
          description: Task or project not found
      parameters:
      - in: path
        name: dataTaskId
        schema:
          type: string
        examples:
          example:
            value: task-cYSY
        required: true
        description: Identifier of the data task.
      - in: path
        name: projectId
        schema:
          type: string
        examples:
          example:
            value: 65424a71c11367914c1e659b
        required: true
        description: Identifier of the data project.
      description: Recreates datasets in the specified data task.
      operationId: recreate_task_datasets
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RecreateTaskDatasetsReq'
        required: false
      x-qlik-visibility: public
      x-qlik-stability: stable
      x-qlik-deprecated: false
      x-qlik-tier:
        tier: '2'
        limit: 100
  /api/v1/di-projects/{projectId}/di-tasks/{dataTaskId}/actions/request-reload:
    post:
      tags:
      - data task actions
      summary: Request dataset reload
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReloadRequestResponse'
          description: Reload request registered.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
          description: Bad Request
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
          description: Not Found
      parameters:
      - in: path
        name: dataTaskId
        schema:
          type: string
        examples:
          example:
            value: task-cYSY
        required: true
        description: Identifier of the data task.
      - in: path
        name: projectId
        schema:
          type: string
        examples:
          example:
            value: 65424a71c11367914c1e659b
        required: true
        description: Identifier of the data project.
      description: Registers a request to reload the datasets associated with the specified data task. The reload does not occur immediately; it will take effect on the next scheduled or manual run of the task.
      operationId: reload_task
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReloadDiTaskReq'
            examples:
              example:
                value:
                  reloadStrategy: COMPARE_AND_APPLY
                  selectedDatasets:
                  - datasetId: dataset-123
                summary: Reload selected datasets on next run
        required: true
      x-qlik-visibility: public
      x-qlik-stability: stable
      x-qlik-deprecated: false
      x-qlik-tier:
        tier: '2'
        limit: 100
  /api/v1/di-projects/{projectId}/di-tasks/{dataTaskId}/actions/validate:
    post:
      tags:
      - data task actions
      summary: Validate a project task
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncActionRsp'
          headers:
            Location:
              $ref: '#/components/headers/AsyncActionLocation'
          description: Validation started
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
          description: Invalid request
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
          description: Task not found
      parameters:
      - in: path
        name: dataTaskId
        schema:
          type: string
        examples:
          example:
            value: task-cYSY
        required: true
        description: Identifier of the data task.
      - in: path
        name: projectId
        schema:
          type: string
        examples:
          example:
            value: 65424a71c11367914c1e659b
        required: true
        description: Identifier of the data project.
      description: Validates the specified data task.
      operationId: validate_task
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ValidateTaskReq'
        required: false
      x-qlik-visibility: public
      x-qlik-stability: stable
      x-qlik-deprecated: false
      x-qlik-tier:
        tier: '2'
        limit: 100
components:
  schemas:
    RecreateTaskDatasetsReq:
      type: object
      description: Request body to recreate task datasets.
    Error:
      type: object
      properties:
        code:
          type: string
          description: Machine-readable error code for programmatic handling.
        title:
          type: string
          description: Brief human-readable summary of the error.
        detail:
          type: string
          description: Detailed explanation of the error and suggested remediation steps.
        source:
          $ref: '#/components/schemas/ErrorSource'
        status:
          type: integer
          format: int32
          description: HTTP status code associated with the error.
      description: Represents a single error condition with details about what went wrong.
    Errors:
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
          description: Array of error objects describing what went wrong.
        traceId:
          type: string
          description: Unique identifier for this error response, useful for tracking and support inquiries.
      description: Standard error response wrapper containing one or more error details and a trace ID for diagnostics.
    ErrorSource:
      type: object
      properties:
        pointer:
          type: string
          description: JSON Pointer (RFC 6901) to the field in the request body that caused the error.
        parameter:
          type: string
          description: Name of the query parameter or path parameter that caused the error.
      description: Identifies the location of the error in the request.
    AsyncActionRsp:
      type: object
      required:
      - actionId
      properties:
        actionId:
          type: string
          example: action-123456
          description: Identifier for tracking the action
    PrepareTaskReq:
      type: object
      required:
      - allowRecreate
      properties:
        allowRecreate:
          type: boolean
          default: false
          description: Allow recreation of existing artifacts
    ValidateTaskReq:
      type: object
      description: Request body for task validation
    ReloadRequestResponse:
      type: object
      required:
      - success
      properties:
        success:
          type: boolean
          description: Always true when the server successfully registers the request.
      description: Indicates whether the reload request was registered successfully.
    ReloadDiTaskReq:
      type: object
      properties:
        reloadStrategy:
          enum:
          - NONE
          - TRUNCATE
          - COMPARE_AND_APPLY
          type: string
          description: Reload strategy (optional, applies to materialized SQL transformations and transformation flows tasks)
        selectedDatasets:
          type: array
          items:
            type: object
            properties:
              datasetId:
                type: string
          description: Datasets to reload (optional, if omitted or empty, all datasets will be reloaded).
  headers:
    AsyncActionLocation:
      schema:
        type: string
      examples:
        example:
          value: /api/v1/di-projects/actions/action-123456
      description: URL to check the status of the async action