openapi: 3.2.0
info:
  title: di-projects data task 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
paths:
  /api/v1/di-projects/{projectId}/di-tasks:
    get:
      tags:
      - data task
      summary: List project tasks
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListDataTasksRsp'
          description: OK
        '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: projectId
        schema:
          type: string
        examples:
          example:
            value: 65424a71c11367914c1e659b
        required: true
        description: Identifier of the data project.
      description: Lists data tasks within a given data integration project.
      operationId: list_project_tasks
      x-qlik-visibility: public
      x-qlik-stability: stable
      x-qlik-deprecated: false
      x-qlik-tier:
        tier: '1'
        limit: 1000
  /api/v1/di-projects/{projectId}/di-tasks/{dataTaskId}:
    get:
      tags:
      - data task
      summary: Get a project task
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataTaskItemRsp'
          description: OK
        '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: Get a specific data task within a project.
      operationId: get_data_task
      x-qlik-visibility: public
      x-qlik-stability: stable
      x-qlik-deprecated: false
      x-qlik-tier:
        tier: '1'
        limit: 1000
components:
  schemas:
    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.
    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.
    DataTaskItemRsp:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        type:
          $ref: '#/components/schemas/DataTaskType'
        ownerId:
          type: string
        spaceId:
          type: string
        description:
          type: string
    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.
    ListDataTasksRsp:
      type: object
      properties:
        dataTasks:
          type: array
          items:
            $ref: '#/components/schemas/DataTaskItemRsp'
    DataTaskType:
      enum:
      - LANDING
      - STORAGE
      - QVD_STORAGE
      - TRANSFORM
      - DATAMART
      - REGISTERED_DATA
      - REPLICATION
      - DISTRIBUTION
      - LAKE_LANDING
      - KNOWLEDGE_MART
      - FILE_BASED_KNOWLEDGE_MART
      - LAKEHOUSE_STORAGE
      - LAKEHOUSE_MIRROR
      - STREAMING_LAKE_LANDING
      - STREAMING_TRANSFORM
      - REPLICATE_LANDING
      type: string
      x-enum-varnames:
      - LANDING
      - STORAGE
      - QVD_STORAGE
      - TRANSFORM
      - DATAMART
      - REGISTERED_DATA
      - REPLICATION
      - LAKE_LANDING
      - KNOWLEDGE_MART
      - FILE_BASED_KNOWLEDGE_MART
      - LAKEHOUSE_STORAGE
      - LAKEHOUSE_MIRROR
      - STREAMING_LAKE_LANDING
      - STREAMING_TRANSFORM
      - REPLICATE_LANDING