Data integration projects

Download OpenAPI spec

Data integration projects are used to group and organize data tasks that move, transform, or prepare data for consumption. These projects can represent data pipelines or replication flows, and are created within spaces.

Overview

The Data integration projects API allows you to automate the three key phases of the project:

  • Operation: Prepare and validate individual data tasks or entire projects, and run data tasks.
  • Deployment: Import and export project artifacts, and configure export variables (also known as bindings).
    For a step-by-step example, see Deploy a data integration project. To see the supported connectors and their identifiers, refer to Data integration connectors reference.
  • Monitoring: Track asynchronous action status and task runtime state.
Important

Projects and tasks must currently be created or edited in the Qlik Cloud UI.
The API supports operational, deployment, and monitoring actions once a project has been created.

Workflows and key use cases

The API supports three major workflows, matching the project phases:

Operational endpoints

Manage project and task execution:

Note

Prepare and validate actions are asynchronous.
Each call returns an actionId, which you can use to poll the Get action status endpoint.

Deployment endpoints

Deploy a project to another space or tenant:

  • Export a project:
    POST /api/v1/di-projects/{projectId}/actions/export

    Use the mode request body parameter to select the export format:

    • MINIMAL (default): YAML format with required and changed settings only. Designed for version-controlled development and code review.
    • FULL: YAML format with all settings including defaults. Use for inspection and debugging.
    • LEGACY: JSON format using the previous project structure. Use for backward compatibility with older import workflows.

    YAML exports (MINIMAL and FULL) are designed for developer editing. You can modify the YAML files and import the updated package back into Qlik Cloud. For the full YAML editing workflow, see Declarative pipelines.

    Note

    Legacy (JSON) exports are opaque deployment artifacts and are not intended for direct editing. To create or edit a project using the UI, see Designing your pipeline project.

  • Get project export variables:
    GET /api/v1/di-projects/{projectId}/bindings

  • Update project export variables:
    PUT /api/v1/di-projects/{projectId}/bindings

  • Create a project:
    POST /api/v1/di-projects

    Warning

    This endpoint creates an empty project in the specified space. Use this only as a container for importing a project, not for manually creating project content.

  • Import a project:
    POST /api/v1/di-projects/{projectId}/actions/import

    Note

    Project export variables must be set before importing a project.
    They apply at import time and don’t dynamically update the UI.

Monitoring endpoints

Retrieve project details, track task state, and monitor asynchronous actions like prepare or validate:

Endpoints

List projects

List data integration projects.

Facts

Rate limit Tier 1 (1000 requests per minute)

Query Parameters

  • spaceId string

    Filter by space id

Responses

200

OK

  • application/json object
    Show application/json properties
    • projects array of objects
      Show projects properties
      • id string
      • name string
      • type string

        The type of the project

        Can be one of: "DATA_PIPELINE""DATA_MOVEMENT"

      • ownerId string
      • spaceId string
      • description string
      • platformType string

        The platform type of the project. Supported values: - SNOWFLAKE: Snowflake - BIGQUERY: Google BigQuery - SYNAPSE: Azure Synapse - DATABRICKS: Databricks - REDSHIFT: Amazon Redshift - MSSQL: Microsoft SQL Server - FABRIC: Microsoft Fabric (OneLake) - QLIK_QVD: Qlik-managed QVD - QLIK_QVD_CUSTOMER_MANAGED: Customer-managed QVD - QLIK_OPEN_LAKEHOUSE: Qlik Open Lakehouse - NONE: No platform (e.g. replication-only projects)

        Can be one of: "SNOWFLAKE""BIGQUERY""SYNAPSE""DATABRICKS""REDSHIFT""MSSQL""FABRIC""QLIK_QVD""QLIK_QVD_CUSTOMER_MANAGED""QLIK_OPEN_LAKEHOUSE""NONE"

400

Bad Request

  • application/json object

    Standard error response wrapper containing one or more error details and a trace ID for diagnostics.

    Show application/json properties
    • errors array of objects

      Array of error objects describing what went wrong.

      Show errors properties
      • code string

        Machine-readable error code for programmatic handling.

      • title string

        Brief human-readable summary of the error.

      • detail string

        Detailed explanation of the error and suggested remediation steps.

      • source object

        Identifies the location of the error in the request.

        Show source properties
        • pointer string

          JSON Pointer (RFC 6901) to the field in the request body that caused the error.

        • parameter string

          Name of the query parameter or path parameter that caused the error.
      • status integer

        HTTP status code associated with the error.

        format = int32

    • traceId string

      Unique identifier for this error response, useful for tracking and support inquiries.

404

Not Found

  • application/json object

    Standard error response wrapper containing one or more error details and a trace ID for diagnostics.

    Show application/json properties
    • errors array of objects

      Array of error objects describing what went wrong.

      Show errors properties
      • code string

        Machine-readable error code for programmatic handling.

      • title string

        Brief human-readable summary of the error.

      • detail string

        Detailed explanation of the error and suggested remediation steps.

      • source object

        Identifies the location of the error in the request.

        Show source properties
        • pointer string

          JSON Pointer (RFC 6901) to the field in the request body that caused the error.

        • parameter string

          Name of the query parameter or path parameter that caused the error.
      • status integer

        HTTP status code associated with the error.

        format = int32

    • traceId string

      Unique identifier for this error response, useful for tracking and support inquiries.
GET /api/v1/di-projects 
import { createQlikApi } from '@qlik/api'


const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})


await qlik.diProjects.getDiProjects({})
qlik di-project ls
curl "https://{tenant}.{region}.qlikcloud.com/api/v1/di-projects" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "projects": [
    {
      "id": "string",
      "name": "string",
      "type": "DATA_PIPELINE",
      "ownerId": "string",
      "spaceId": "string",
      "description": "string",
      "platformType": "SNOWFLAKE"
    }
  ]
}

Create a new project

Creates a new data integration project in the specified space.

Facts

Rate limit Tier 2 (100 requests per minute)

Request Body

Required

The details of the project to create

  • application/json object
    Show application/json properties
    • name string

      The name of the project

    • type string

      The type of the project

      Can be one of: "DATA_PIPELINE""DATA_MOVEMENT"

    • space string

      The ID of the space where the project will be created

    • description string

      A description of the project

    • platformType string

      The platform type of the project. Supported values: - SNOWFLAKE: Snowflake - BIGQUERY: Google BigQuery - SYNAPSE: Azure Synapse - DATABRICKS: Databricks - REDSHIFT: Amazon Redshift - MSSQL: Microsoft SQL Server - FABRIC: Microsoft Fabric (OneLake) - QLIK_QVD: Qlik-managed QVD - QLIK_QVD_CUSTOMER_MANAGED: Customer-managed QVD - QLIK_OPEN_LAKEHOUSE: Qlik Open Lakehouse - NONE: No platform (e.g. replication-only projects)

      Can be one of: "SNOWFLAKE""BIGQUERY""SYNAPSE""DATABRICKS""REDSHIFT""MSSQL""FABRIC""QLIK_QVD""QLIK_QVD_CUSTOMER_MANAGED""QLIK_OPEN_LAKEHOUSE""NONE"

    • platformConnection string

      The platform connection string

    • cloudStagingConnection string

      The cloud staging connection string

Responses

201

Created

  • application/json object
    Show application/json properties
    • id string
    • name string
    • type string

      The type of the project

      Can be one of: "DATA_PIPELINE""DATA_MOVEMENT"

    • ownerId string
    • spaceId string
    • description string
    • platformType string

      The platform type of the project. Supported values: - SNOWFLAKE: Snowflake - BIGQUERY: Google BigQuery - SYNAPSE: Azure Synapse - DATABRICKS: Databricks - REDSHIFT: Amazon Redshift - MSSQL: Microsoft SQL Server - FABRIC: Microsoft Fabric (OneLake) - QLIK_QVD: Qlik-managed QVD - QLIK_QVD_CUSTOMER_MANAGED: Customer-managed QVD - QLIK_OPEN_LAKEHOUSE: Qlik Open Lakehouse - NONE: No platform (e.g. replication-only projects)

      Can be one of: "SNOWFLAKE""BIGQUERY""SYNAPSE""DATABRICKS""REDSHIFT""MSSQL""FABRIC""QLIK_QVD""QLIK_QVD_CUSTOMER_MANAGED""QLIK_OPEN_LAKEHOUSE""NONE"

400

Bad Request

  • application/json object

    Standard error response wrapper containing one or more error details and a trace ID for diagnostics.

    Show application/json properties
    • errors array of objects

      Array of error objects describing what went wrong.

      Show errors properties
      • code string

        Machine-readable error code for programmatic handling.

      • title string

        Brief human-readable summary of the error.

      • detail string

        Detailed explanation of the error and suggested remediation steps.

      • source object

        Identifies the location of the error in the request.

        Show source properties
        • pointer string

          JSON Pointer (RFC 6901) to the field in the request body that caused the error.

        • parameter string

          Name of the query parameter or path parameter that caused the error.
      • status integer

        HTTP status code associated with the error.

        format = int32

    • traceId string

      Unique identifier for this error response, useful for tracking and support inquiries.

500

Internal Server Error

  • application/json object

    Standard error response wrapper containing one or more error details and a trace ID for diagnostics.

    Show application/json properties
    • errors array of objects

      Array of error objects describing what went wrong.

      Show errors properties
      • code string

        Machine-readable error code for programmatic handling.

      • title string

        Brief human-readable summary of the error.

      • detail string

        Detailed explanation of the error and suggested remediation steps.

      • source object

        Identifies the location of the error in the request.

        Show source properties
        • pointer string

          JSON Pointer (RFC 6901) to the field in the request body that caused the error.

        • parameter string

          Name of the query parameter or path parameter that caused the error.
      • status integer

        HTTP status code associated with the error.

        format = int32

    • traceId string

      Unique identifier for this error response, useful for tracking and support inquiries.
POST /api/v1/di-projects 
import { createQlikApi } from '@qlik/api'


const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})


await qlik.diProjects.createDiProject({
  cloudStagingConnection:
    'storage-connection-string',
  description:
    'This is a new data integration project.',
  name: 'New Project',
  platformConnection: 'connection-string',
  platformType: 'SNOWFLAKE',
  space: 'space-456',
  type: 'DATA_PIPELINE',
})
qlik di-project create
curl "https://{tenant}.{region}.qlikcloud.com/api/v1/di-projects" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{"name":"New Project","type":"DATA_PIPELINE","space":"space-456","description":"This is a new data integration project.","platformType":"SNOWFLAKE","platformConnection":"connection-string","cloudStagingConnection":"storage-connection-string"}'

Example Response

{
  "id": "string",
  "name": "string",
  "type": "DATA_PIPELINE",
  "ownerId": "string",
  "spaceId": "string",
  "description": "string",
  "platformType": "SNOWFLAKE"
}

Get a project

Get a specific data integration project.

Facts

Rate limit Tier 1 (1000 requests per minute)

Path Parameters

  • projectId string
    Required

    Identifier of the data project.

Responses

200

OK

  • application/json object
    Show application/json properties
    • id string
    • name string
    • type string

      The type of the project

      Can be one of: "DATA_PIPELINE""DATA_MOVEMENT"

    • ownerId string
    • spaceId string
    • description string
    • platformType string

      The platform type of the project. Supported values: - SNOWFLAKE: Snowflake - BIGQUERY: Google BigQuery - SYNAPSE: Azure Synapse - DATABRICKS: Databricks - REDSHIFT: Amazon Redshift - MSSQL: Microsoft SQL Server - FABRIC: Microsoft Fabric (OneLake) - QLIK_QVD: Qlik-managed QVD - QLIK_QVD_CUSTOMER_MANAGED: Customer-managed QVD - QLIK_OPEN_LAKEHOUSE: Qlik Open Lakehouse - NONE: No platform (e.g. replication-only projects)

      Can be one of: "SNOWFLAKE""BIGQUERY""SYNAPSE""DATABRICKS""REDSHIFT""MSSQL""FABRIC""QLIK_QVD""QLIK_QVD_CUSTOMER_MANAGED""QLIK_OPEN_LAKEHOUSE""NONE"

400

Bad Request

  • application/json object

    Standard error response wrapper containing one or more error details and a trace ID for diagnostics.

    Show application/json properties
    • errors array of objects

      Array of error objects describing what went wrong.

      Show errors properties
      • code string

        Machine-readable error code for programmatic handling.

      • title string

        Brief human-readable summary of the error.

      • detail string

        Detailed explanation of the error and suggested remediation steps.

      • source object

        Identifies the location of the error in the request.

        Show source properties
        • pointer string

          JSON Pointer (RFC 6901) to the field in the request body that caused the error.

        • parameter string

          Name of the query parameter or path parameter that caused the error.
      • status integer

        HTTP status code associated with the error.

        format = int32

    • traceId string

      Unique identifier for this error response, useful for tracking and support inquiries.

404

Not Found

  • application/json object

    Standard error response wrapper containing one or more error details and a trace ID for diagnostics.

    Show application/json properties
    • errors array of objects

      Array of error objects describing what went wrong.

      Show errors properties
      • code string

        Machine-readable error code for programmatic handling.

      • title string

        Brief human-readable summary of the error.

      • detail string

        Detailed explanation of the error and suggested remediation steps.

      • source object

        Identifies the location of the error in the request.

        Show source properties
        • pointer string

          JSON Pointer (RFC 6901) to the field in the request body that caused the error.

        • parameter string

          Name of the query parameter or path parameter that caused the error.
      • status integer

        HTTP status code associated with the error.

        format = int32

    • traceId string

      Unique identifier for this error response, useful for tracking and support inquiries.
GET /api/v1/di-projects/{projectId} 
// qlik-api has not implemented support for `GET /api/v1/di-projects/{projectId}` yet.
// In the meantime, you can use fetch like this:


const response = await fetch(
  '/api/v1/di-projects/{projectId}',
  {
    method: 'GET',
    headers: {
      'Content-Type': 'application/json',
    },
  },
)
qlik di-project get '65424a71c11367914c1e659b'
curl "https://{tenant}.{region}.qlikcloud.com/api/v1/di-projects/{projectId}" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "id": "string",
  "name": "string",
  "type": "DATA_PIPELINE",
  "ownerId": "string",
  "spaceId": "string",
  "description": "string",
  "platformType": "SNOWFLAKE"
}

Export a project

Exports the specified data integration project.

Facts

Rate limit Tier 2 (100 requests per minute)

Header Parameters

  • Accept string

    Optional; only 'application/octet-stream' is supported.

    Can be one of: "application/octet-stream"

Path Parameters

  • projectId string
    Required

    Identifier of the data project.

Request Body

Options for the export process

  • application/json object
    Show application/json properties
    • mode string

      Defines the export format for the project files.

      • 'LEGACY': Exports a ZIP of the previous JSON files. Deprecated and will be removed in a future release.
      • 'MINIMAL': Exports a ZIP of the new YAML files, including only non-default attribute values.
      • 'ALL': Exports a ZIP of the new YAML files, including all attributes.

      Can be one of: "MINIMAL""ALL""LEGACY"

    • includeBindings boolean

      Include bindings in the exported zip file. If not specified, defaults to false.

      default = false

Responses

200

OK

  • application/octet-stream string

    format = "binary"

400

Bad Request

  • application/json object

    Standard error response wrapper containing one or more error details and a trace ID for diagnostics.

    Show application/json properties
    • errors array of objects

      Array of error objects describing what went wrong.

      Show errors properties
      • code string

        Machine-readable error code for programmatic handling.

      • title string

        Brief human-readable summary of the error.

      • detail string

        Detailed explanation of the error and suggested remediation steps.

      • source object

        Identifies the location of the error in the request.

        Show source properties
        • pointer string

          JSON Pointer (RFC 6901) to the field in the request body that caused the error.

        • parameter string

          Name of the query parameter or path parameter that caused the error.
      • status integer

        HTTP status code associated with the error.

        format = int32

    • traceId string

      Unique identifier for this error response, useful for tracking and support inquiries.

404

Not Found

  • application/json object

    Standard error response wrapper containing one or more error details and a trace ID for diagnostics.

    Show application/json properties
    • errors array of objects

      Array of error objects describing what went wrong.

      Show errors properties
      • code string

        Machine-readable error code for programmatic handling.

      • title string

        Brief human-readable summary of the error.

      • detail string

        Detailed explanation of the error and suggested remediation steps.

      • source object

        Identifies the location of the error in the request.

        Show source properties
        • pointer string

          JSON Pointer (RFC 6901) to the field in the request body that caused the error.

        • parameter string

          Name of the query parameter or path parameter that caused the error.
      • status integer

        HTTP status code associated with the error.

        format = int32

    • traceId string

      Unique identifier for this error response, useful for tracking and support inquiries.

500

Internal Server Error

  • application/json object

    Standard error response wrapper containing one or more error details and a trace ID for diagnostics.

    Show application/json properties
    • errors array of objects

      Array of error objects describing what went wrong.

      Show errors properties
      • code string

        Machine-readable error code for programmatic handling.

      • title string

        Brief human-readable summary of the error.

      • detail string

        Detailed explanation of the error and suggested remediation steps.

      • source object

        Identifies the location of the error in the request.

        Show source properties
        • pointer string

          JSON Pointer (RFC 6901) to the field in the request body that caused the error.

        • parameter string

          Name of the query parameter or path parameter that caused the error.
      • status integer

        HTTP status code associated with the error.

        format = int32

    • traceId string

      Unique identifier for this error response, useful for tracking and support inquiries.
POST /api/v1/di-projects/{projectId}/actions/export 
import { createQlikApi } from '@qlik/api'


const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})


await qlik.diProjects.exportDiProject(
  '65424a71c11367914c1e659b',
  { mode: 'MINIMAL' },
)
qlik di-project export '65424a71c11367914c1e659b'
curl "https://{tenant}.{region}.qlikcloud.com/api/v1/di-projects/{projectId}/actions/export" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{"mode":"MINIMAL","includeBindings":false}' \
-o "output-file"

Import a project (JSON zip)

Imports a data integration project synchronously from a legacy JSON-based .zip file. This endpoint only accepts zips that contain JSON project files (the legacy format). The import is processed synchronously and completes before the response is returned. Submitting a YAML-based zip to this endpoint returns 400. To import a YAML-based zip, use POST /di-projects/{projectId}/actions/import-async instead.

Facts

Rate limit Tier 2 (100 requests per minute)

Path Parameters

  • projectId string
    Required

    Identifier of the data project.

Request Body

Required

The ZIP file containing the JSON-based project to import.

  • multipart/form-data object
    Show multipart/form-data properties
    • zip string

      format = "binary"

Responses

200

OK — the JSON-based project was imported successfully.

  • application/json object

400

Bad Request — for example, if a YAML-based zip is submitted to this endpoint.

  • application/json object

    Standard error response wrapper containing one or more error details and a trace ID for diagnostics.

    Show application/json properties
    • errors array of objects

      Array of error objects describing what went wrong.

      Show errors properties
      • code string

        Machine-readable error code for programmatic handling.

      • title string

        Brief human-readable summary of the error.

      • detail string

        Detailed explanation of the error and suggested remediation steps.

      • source object

        Identifies the location of the error in the request.

        Show source properties
        • pointer string

          JSON Pointer (RFC 6901) to the field in the request body that caused the error.

        • parameter string

          Name of the query parameter or path parameter that caused the error.
      • status integer

        HTTP status code associated with the error.

        format = int32

    • traceId string

      Unique identifier for this error response, useful for tracking and support inquiries.

404

Not Found

  • application/json object

    Standard error response wrapper containing one or more error details and a trace ID for diagnostics.

    Show application/json properties
    • errors array of objects

      Array of error objects describing what went wrong.

      Show errors properties
      • code string

        Machine-readable error code for programmatic handling.

      • title string

        Brief human-readable summary of the error.

      • detail string

        Detailed explanation of the error and suggested remediation steps.

      • source object

        Identifies the location of the error in the request.

        Show source properties
        • pointer string

          JSON Pointer (RFC 6901) to the field in the request body that caused the error.

        • parameter string

          Name of the query parameter or path parameter that caused the error.
      • status integer

        HTTP status code associated with the error.

        format = int32

    • traceId string

      Unique identifier for this error response, useful for tracking and support inquiries.

409

Conflict

  • application/json object

    Standard error response wrapper containing one or more error details and a trace ID for diagnostics.

    Show application/json properties
    • errors array of objects

      Array of error objects describing what went wrong.

      Show errors properties
      • code string

        Machine-readable error code for programmatic handling.

      • title string

        Brief human-readable summary of the error.

      • detail string

        Detailed explanation of the error and suggested remediation steps.

      • source object

        Identifies the location of the error in the request.

        Show source properties
        • pointer string

          JSON Pointer (RFC 6901) to the field in the request body that caused the error.

        • parameter string

          Name of the query parameter or path parameter that caused the error.
      • status integer

        HTTP status code associated with the error.

        format = int32

    • traceId string

      Unique identifier for this error response, useful for tracking and support inquiries.

500

Internal Server Error

  • application/json object

    Standard error response wrapper containing one or more error details and a trace ID for diagnostics.

    Show application/json properties
    • errors array of objects

      Array of error objects describing what went wrong.

      Show errors properties
      • code string

        Machine-readable error code for programmatic handling.

      • title string

        Brief human-readable summary of the error.

      • detail string

        Detailed explanation of the error and suggested remediation steps.

      • source object

        Identifies the location of the error in the request.

        Show source properties
        • pointer string

          JSON Pointer (RFC 6901) to the field in the request body that caused the error.

        • parameter string

          Name of the query parameter or path parameter that caused the error.
      • status integer

        HTTP status code associated with the error.

        format = int32

    • traceId string

      Unique identifier for this error response, useful for tracking and support inquiries.
POST /api/v1/di-projects/{projectId}/actions/import 
import { createQlikApi } from '@qlik/api'
import { readFileSync } from 'node:fs'


const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})


await qlik.diProjects.importDiProject(
  '65424a71c11367914c1e659b',
  {
    zip: new Uint8Array(
      readFileSync('<file-path>'),
    ),
  },
)
qlik di-project import '65424a71c11367914c1e659b'
curl "https://{tenant}.{region}.qlikcloud.com/api/v1/di-projects/{projectId}/actions/import" \
-X POST \
-H "Content-type: multipart/form-data" \
-H "Authorization: Bearer <access_token>" \
-F "zip=@/path/to/file"

Example Response

{}

Import a project asynchronously

Imports a data integration project from a .zip file and returns an action identifier for tracking the background import operation. Accepts both JSON-based (legacy) and YAML-based project formats, making it the recommended endpoint for deploying YAML-defined pipeline definitions programmatically. Poll the import status using GET /di-projects/actions/{actionId}.

Facts

Rate limit Tier 2 (100 requests per minute)

Path Parameters

  • projectId string
    Required

    Identifier of the data project.

Request Body

Required

A .zip file containing the project to import. Accepts both JSON-based (legacy) and YAML-based formats.

  • multipart/form-data object
    Show multipart/form-data properties
    • zip string

      format = "binary"

Responses

202

The project import has started. Poll the returned actionId using GET /di-projects/actions/{actionId} to track progress.

  • application/json object
    Show application/json properties
    • actionId string
      Required

      Identifier for tracking the action

400

Bad Request

  • application/json object

    Standard error response wrapper containing one or more error details and a trace ID for diagnostics.

    Show application/json properties
    • errors array of objects

      Array of error objects describing what went wrong.

      Show errors properties
      • code string

        Machine-readable error code for programmatic handling.

      • title string

        Brief human-readable summary of the error.

      • detail string

        Detailed explanation of the error and suggested remediation steps.

      • source object

        Identifies the location of the error in the request.

        Show source properties
        • pointer string

          JSON Pointer (RFC 6901) to the field in the request body that caused the error.

        • parameter string

          Name of the query parameter or path parameter that caused the error.
      • status integer

        HTTP status code associated with the error.

        format = int32

    • traceId string

      Unique identifier for this error response, useful for tracking and support inquiries.

404

Not Found

  • application/json object

    Standard error response wrapper containing one or more error details and a trace ID for diagnostics.

    Show application/json properties
    • errors array of objects

      Array of error objects describing what went wrong.

      Show errors properties
      • code string

        Machine-readable error code for programmatic handling.

      • title string

        Brief human-readable summary of the error.

      • detail string

        Detailed explanation of the error and suggested remediation steps.

      • source object

        Identifies the location of the error in the request.

        Show source properties
        • pointer string

          JSON Pointer (RFC 6901) to the field in the request body that caused the error.

        • parameter string

          Name of the query parameter or path parameter that caused the error.
      • status integer

        HTTP status code associated with the error.

        format = int32

    • traceId string

      Unique identifier for this error response, useful for tracking and support inquiries.

409

Conflict

  • application/json object

    Standard error response wrapper containing one or more error details and a trace ID for diagnostics.

    Show application/json properties
    • errors array of objects

      Array of error objects describing what went wrong.

      Show errors properties
      • code string

        Machine-readable error code for programmatic handling.

      • title string

        Brief human-readable summary of the error.

      • detail string

        Detailed explanation of the error and suggested remediation steps.

      • source object

        Identifies the location of the error in the request.

        Show source properties
        • pointer string

          JSON Pointer (RFC 6901) to the field in the request body that caused the error.

        • parameter string

          Name of the query parameter or path parameter that caused the error.
      • status integer

        HTTP status code associated with the error.

        format = int32

    • traceId string

      Unique identifier for this error response, useful for tracking and support inquiries.

500

Internal Server Error

  • application/json object

    Standard error response wrapper containing one or more error details and a trace ID for diagnostics.

    Show application/json properties
    • errors array of objects

      Array of error objects describing what went wrong.

      Show errors properties
      • code string

        Machine-readable error code for programmatic handling.

      • title string

        Brief human-readable summary of the error.

      • detail string

        Detailed explanation of the error and suggested remediation steps.

      • source object

        Identifies the location of the error in the request.

        Show source properties
        • pointer string

          JSON Pointer (RFC 6901) to the field in the request body that caused the error.

        • parameter string

          Name of the query parameter or path parameter that caused the error.
      • status integer

        HTTP status code associated with the error.

        format = int32

    • traceId string

      Unique identifier for this error response, useful for tracking and support inquiries.
POST /api/v1/di-projects/{projectId}/actions/import-async 
import { createQlikApi } from '@qlik/api'
import { readFileSync } from 'node:fs'


const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})


await qlik.diProjects.importAsyncDiProject(
  '65424a71c11367914c1e659b',
  {
    zip: new Uint8Array(
      readFileSync('<file-path>'),
    ),
  },
)
qlik di-project import-async '65424a71c11367914c1e659b'
curl "https://{tenant}.{region}.qlikcloud.com/api/v1/di-projects/{projectId}/actions/import-async" \
-X POST \
-H "Content-type: multipart/form-data" \
-H "Authorization: Bearer <access_token>" \
-F "zip=@/path/to/file"

Example Response

{
  "actionId": "action-123456"
}

Prepare a project

Prepares the data integration project and its tasks for execution.

Facts

Rate limit Tier 2 (100 requests per minute)

Path Parameters

  • projectId string
    Required

    Identifier of the data project.

Request Body

Required
  • application/json object
    Show application/json properties
    • allowRecreate boolean

      default = false

    • selectedTasks array of objects

      Array of tasks to prepare. Leave empty to trigger project-level orchestration using built-in logic (same as in the user interface).

      Show selectedTasks properties
      • taskId string
        Required

        Task identifier

Responses

202

Preparation started

  • application/json object
    Show application/json properties
    • actionId string
      Required

      Identifier for tracking the action

400

Invalid request

  • application/json object

    Standard error response wrapper containing one or more error details and a trace ID for diagnostics.

    Show application/json properties
    • errors array of objects

      Array of error objects describing what went wrong.

      Show errors properties
      • code string

        Machine-readable error code for programmatic handling.

      • title string

        Brief human-readable summary of the error.

      • detail string

        Detailed explanation of the error and suggested remediation steps.

      • source object

        Identifies the location of the error in the request.

        Show source properties
        • pointer string

          JSON Pointer (RFC 6901) to the field in the request body that caused the error.

        • parameter string

          Name of the query parameter or path parameter that caused the error.
      • status integer

        HTTP status code associated with the error.

        format = int32

    • traceId string

      Unique identifier for this error response, useful for tracking and support inquiries.

404

Project not found

  • application/json object

    Standard error response wrapper containing one or more error details and a trace ID for diagnostics.

    Show application/json properties
    • errors array of objects

      Array of error objects describing what went wrong.

      Show errors properties
      • code string

        Machine-readable error code for programmatic handling.

      • title string

        Brief human-readable summary of the error.

      • detail string

        Detailed explanation of the error and suggested remediation steps.

      • source object

        Identifies the location of the error in the request.

        Show source properties
        • pointer string

          JSON Pointer (RFC 6901) to the field in the request body that caused the error.

        • parameter string

          Name of the query parameter or path parameter that caused the error.
      • status integer

        HTTP status code associated with the error.

        format = int32

    • traceId string

      Unique identifier for this error response, useful for tracking and support inquiries.
POST /api/v1/di-projects/{projectId}/actions/prepare 
import { createQlikApi } from '@qlik/api'


const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})


await qlik.diProjects.prepareDiProject(
  '65424a71c11367914c1e659b',
  { selectedTasks: [{ taskId: 'string' }] },
)
qlik di-project prepare '65424a71c11367914c1e659b' \
  --selectedTasks-taskId ''
curl "https://{tenant}.{region}.qlikcloud.com/api/v1/di-projects/{projectId}/actions/prepare" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{"allowRecreate":false,"selectedTasks":[{"taskId":"string"}]}'

Example Response

{
  "actionId": "action-123456"
}

Validate project

Validates the data integration project and its tasks.

Facts

Rate limit Tier 2 (100 requests per minute)

Path Parameters

  • projectId string
    Required

    Identifier of the data project.

Request Body

Required
  • application/json object
    Show application/json properties
    • selectedTasks array of objects

      Array of tasks to prepare. Leave empty to trigger project-level orchestration using built-in logic (same as in the user interface).

      Show selectedTasks properties
      • taskId string
        Required

        Task identifier

Responses

202

Validation started

  • application/json object
    Show application/json properties
    • actionId string
      Required

      Identifier for tracking the action

400

Invalid request

  • application/json object

    Standard error response wrapper containing one or more error details and a trace ID for diagnostics.

    Show application/json properties
    • errors array of objects

      Array of error objects describing what went wrong.

      Show errors properties
      • code string

        Machine-readable error code for programmatic handling.

      • title string

        Brief human-readable summary of the error.

      • detail string

        Detailed explanation of the error and suggested remediation steps.

      • source object

        Identifies the location of the error in the request.

        Show source properties
        • pointer string

          JSON Pointer (RFC 6901) to the field in the request body that caused the error.

        • parameter string

          Name of the query parameter or path parameter that caused the error.
      • status integer

        HTTP status code associated with the error.

        format = int32

    • traceId string

      Unique identifier for this error response, useful for tracking and support inquiries.

404

Project not found

  • application/json object

    Standard error response wrapper containing one or more error details and a trace ID for diagnostics.

    Show application/json properties
    • errors array of objects

      Array of error objects describing what went wrong.

      Show errors properties
      • code string

        Machine-readable error code for programmatic handling.

      • title string

        Brief human-readable summary of the error.

      • detail string

        Detailed explanation of the error and suggested remediation steps.

      • source object

        Identifies the location of the error in the request.

        Show source properties
        • pointer string

          JSON Pointer (RFC 6901) to the field in the request body that caused the error.

        • parameter string

          Name of the query parameter or path parameter that caused the error.
      • status integer

        HTTP status code associated with the error.

        format = int32

    • traceId string

      Unique identifier for this error response, useful for tracking and support inquiries.
POST /api/v1/di-projects/{projectId}/actions/validate 
import { createQlikApi } from '@qlik/api'


const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})


await qlik.diProjects.validateDiProject(
  '65424a71c11367914c1e659b',
  { selectedTasks: [{ taskId: 'string' }] },
)
qlik di-project validate '65424a71c11367914c1e659b' \
  --selectedTasks-taskId ''
curl "https://{tenant}.{region}.qlikcloud.com/api/v1/di-projects/{projectId}/actions/validate" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{"selectedTasks":[{"taskId":"string"}]}'

Example Response

{
  "actionId": "action-123456"
}

Get project export variables

Retrieves the export variables for a specific data integration project.

Facts

Rate limit Tier 1 (1000 requests per minute)

Query Parameters

  • recalculate boolean

    Recalculate the bindings if true, otherwise saved bindings are returned.

    default = true

Path Parameters

  • projectId string
    Required

    Identifier of the data project.

Responses

200

OK

  • application/json object
    Show application/json properties
    • variables object
      Show additional optional properties
      • string string

        The value of the variable
    • nameToIdMap object
      Show additional optional properties
      • string string

        The calculated ID of the variable value, when relevant.

400

Bad Request

  • application/json object

    Standard error response wrapper containing one or more error details and a trace ID for diagnostics.

    Show application/json properties
    • errors array of objects

      Array of error objects describing what went wrong.

      Show errors properties
      • code string

        Machine-readable error code for programmatic handling.

      • title string

        Brief human-readable summary of the error.

      • detail string

        Detailed explanation of the error and suggested remediation steps.

      • source object

        Identifies the location of the error in the request.

        Show source properties
        • pointer string

          JSON Pointer (RFC 6901) to the field in the request body that caused the error.

        • parameter string

          Name of the query parameter or path parameter that caused the error.
      • status integer

        HTTP status code associated with the error.

        format = int32

    • traceId string

      Unique identifier for this error response, useful for tracking and support inquiries.

404

Not Found

  • application/json object

    Standard error response wrapper containing one or more error details and a trace ID for diagnostics.

    Show application/json properties
    • errors array of objects

      Array of error objects describing what went wrong.

      Show errors properties
      • code string

        Machine-readable error code for programmatic handling.

      • title string

        Brief human-readable summary of the error.

      • detail string

        Detailed explanation of the error and suggested remediation steps.

      • source object

        Identifies the location of the error in the request.

        Show source properties
        • pointer string

          JSON Pointer (RFC 6901) to the field in the request body that caused the error.

        • parameter string

          Name of the query parameter or path parameter that caused the error.
      • status integer

        HTTP status code associated with the error.

        format = int32

    • traceId string

      Unique identifier for this error response, useful for tracking and support inquiries.
GET /api/v1/di-projects/{projectId}/bindings 
import { createQlikApi } from '@qlik/api'


const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})


await qlik.diProjects.getDiProjectExportVariables(
  '65424a71c11367914c1e659b',
  {},
)
qlik di-project export-variables get '65424a71c11367914c1e659b'
curl "https://{tenant}.{region}.qlikcloud.com/api/v1/di-projects/{projectId}/bindings" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "variables": {},
  "nameToIdMap": {}
}

Update project export variables

Updates the export variables for a specific data integration project.

Facts

Rate limit Tier 2 (100 requests per minute)

Path Parameters

  • projectId string
    Required

    Identifier of the data project.

Request Body

Required

The details of the export variables to update

  • application/json object
    Show application/json properties
    • variables object
      Show additional optional properties
      • string string

        The value of the variable

Responses

200

OK

  • application/json object

400

Bad Request

  • application/json object

    Standard error response wrapper containing one or more error details and a trace ID for diagnostics.

    Show application/json properties
    • errors array of objects

      Array of error objects describing what went wrong.

      Show errors properties
      • code string

        Machine-readable error code for programmatic handling.

      • title string

        Brief human-readable summary of the error.

      • detail string

        Detailed explanation of the error and suggested remediation steps.

      • source object

        Identifies the location of the error in the request.

        Show source properties
        • pointer string

          JSON Pointer (RFC 6901) to the field in the request body that caused the error.

        • parameter string

          Name of the query parameter or path parameter that caused the error.
      • status integer

        HTTP status code associated with the error.

        format = int32

    • traceId string

      Unique identifier for this error response, useful for tracking and support inquiries.

404

Not Found

  • application/json object

    Standard error response wrapper containing one or more error details and a trace ID for diagnostics.

    Show application/json properties
    • errors array of objects

      Array of error objects describing what went wrong.

      Show errors properties
      • code string

        Machine-readable error code for programmatic handling.

      • title string

        Brief human-readable summary of the error.

      • detail string

        Detailed explanation of the error and suggested remediation steps.

      • source object

        Identifies the location of the error in the request.

        Show source properties
        • pointer string

          JSON Pointer (RFC 6901) to the field in the request body that caused the error.

        • parameter string

          Name of the query parameter or path parameter that caused the error.
      • status integer

        HTTP status code associated with the error.

        format = int32

    • traceId string

      Unique identifier for this error response, useful for tracking and support inquiries.

500

Internal Server Error

  • application/json object

    Standard error response wrapper containing one or more error details and a trace ID for diagnostics.

    Show application/json properties
    • errors array of objects

      Array of error objects describing what went wrong.

      Show errors properties
      • code string

        Machine-readable error code for programmatic handling.

      • title string

        Brief human-readable summary of the error.

      • detail string

        Detailed explanation of the error and suggested remediation steps.

      • source object

        Identifies the location of the error in the request.

        Show source properties
        • pointer string

          JSON Pointer (RFC 6901) to the field in the request body that caused the error.

        • parameter string

          Name of the query parameter or path parameter that caused the error.
      • status integer

        HTTP status code associated with the error.

        format = int32

    • traceId string

      Unique identifier for this error response, useful for tracking and support inquiries.
PUT /api/v1/di-projects/{projectId}/bindings 
import { createQlikApi } from '@qlik/api'


const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})


await qlik.diProjects.setDiProjectExportVariables(
  '65424a71c11367914c1e659b',
  { variables: {} },
)
qlik di-project export-variables set '65424a71c11367914c1e659b'
curl "https://{tenant}.{region}.qlikcloud.com/api/v1/di-projects/{projectId}/bindings" \
-X PUT \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{"variables":{}}'

Example Response

{}

List project tasks

Lists data tasks within a given data integration project.

Facts

Rate limit Tier 1 (1000 requests per minute)

Path Parameters

  • projectId string
    Required

    Identifier of the data project.

Responses

200

OK

  • application/json object
    Show application/json properties
    • dataTasks array of objects
      Show dataTasks properties
      • id string
      • name string
      • type string

        Can be one of: "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"

      • ownerId string
      • spaceId string
      • description string

400

Bad Request

  • application/json object

    Standard error response wrapper containing one or more error details and a trace ID for diagnostics.

    Show application/json properties
    • errors array of objects

      Array of error objects describing what went wrong.

      Show errors properties
      • code string

        Machine-readable error code for programmatic handling.

      • title string

        Brief human-readable summary of the error.

      • detail string

        Detailed explanation of the error and suggested remediation steps.

      • source object

        Identifies the location of the error in the request.

        Show source properties
        • pointer string

          JSON Pointer (RFC 6901) to the field in the request body that caused the error.

        • parameter string

          Name of the query parameter or path parameter that caused the error.
      • status integer

        HTTP status code associated with the error.

        format = int32

    • traceId string

      Unique identifier for this error response, useful for tracking and support inquiries.

404

Not Found

  • application/json object

    Standard error response wrapper containing one or more error details and a trace ID for diagnostics.

    Show application/json properties
    • errors array of objects

      Array of error objects describing what went wrong.

      Show errors properties
      • code string

        Machine-readable error code for programmatic handling.

      • title string

        Brief human-readable summary of the error.

      • detail string

        Detailed explanation of the error and suggested remediation steps.

      • source object

        Identifies the location of the error in the request.

        Show source properties
        • pointer string

          JSON Pointer (RFC 6901) to the field in the request body that caused the error.

        • parameter string

          Name of the query parameter or path parameter that caused the error.
      • status integer

        HTTP status code associated with the error.

        format = int32

    • traceId string

      Unique identifier for this error response, useful for tracking and support inquiries.
GET /api/v1/di-projects/{projectId}/di-tasks 
import { createQlikApi } from '@qlik/api'


const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})


await qlik.diProjects.getDiProjectDiTasks(
  '65424a71c11367914c1e659b',
)
qlik di-project di-task ls \
  --di-projectId '65424a71c11367914c1e659b'
curl "https://{tenant}.{region}.qlikcloud.com/api/v1/di-projects/{projectId}/di-tasks" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "dataTasks": [
    {
      "id": "string",
      "name": "string",
      "type": "LANDING",
      "ownerId": "string",
      "spaceId": "string",
      "description": "string"
    }
  ]
}

Get a project task

Get a specific data task within a project.

Facts

Rate limit Tier 1 (1000 requests per minute)

Path Parameters

  • dataTaskId string
    Required

    Identifier of the data task.

  • projectId string
    Required

    Identifier of the data project.

Responses

200

OK

  • application/json object
    Show application/json properties
    • id string
    • name string
    • type string

      Can be one of: "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"

    • ownerId string
    • spaceId string
    • description string

400

Bad Request

  • application/json object

    Standard error response wrapper containing one or more error details and a trace ID for diagnostics.

    Show application/json properties
    • errors array of objects

      Array of error objects describing what went wrong.

      Show errors properties
      • code string

        Machine-readable error code for programmatic handling.

      • title string

        Brief human-readable summary of the error.

      • detail string

        Detailed explanation of the error and suggested remediation steps.

      • source object

        Identifies the location of the error in the request.

        Show source properties
        • pointer string

          JSON Pointer (RFC 6901) to the field in the request body that caused the error.

        • parameter string

          Name of the query parameter or path parameter that caused the error.
      • status integer

        HTTP status code associated with the error.

        format = int32

    • traceId string

      Unique identifier for this error response, useful for tracking and support inquiries.

404

Not Found

  • application/json object

    Standard error response wrapper containing one or more error details and a trace ID for diagnostics.

    Show application/json properties
    • errors array of objects

      Array of error objects describing what went wrong.

      Show errors properties
      • code string

        Machine-readable error code for programmatic handling.

      • title string

        Brief human-readable summary of the error.

      • detail string

        Detailed explanation of the error and suggested remediation steps.

      • source object

        Identifies the location of the error in the request.

        Show source properties
        • pointer string

          JSON Pointer (RFC 6901) to the field in the request body that caused the error.

        • parameter string

          Name of the query parameter or path parameter that caused the error.
      • status integer

        HTTP status code associated with the error.

        format = int32

    • traceId string

      Unique identifier for this error response, useful for tracking and support inquiries.
GET /api/v1/di-projects/{projectId}/di-tasks/{dataTaskId} 
import { createQlikApi } from '@qlik/api'


const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})


await qlik.diProjects.getDiProjectDiTask(
  '65424a71c11367914c1e659b',
  'task-cYSY',
)
qlik di-project di-task get 'task-cYSY' \
  --di-projectId '65424a71c11367914c1e659b'
curl "https://{tenant}.{region}.qlikcloud.com/api/v1/di-projects/{projectId}/di-tasks/{dataTaskId}" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "id": "string",
  "name": "string",
  "type": "LANDING",
  "ownerId": "string",
  "spaceId": "string",
  "description": "string"
}

Prepare a project task

Prepares the specified data task for execution.

Facts

Rate limit Tier 2 (100 requests per minute)

Path Parameters

  • dataTaskId string
    Required

    Identifier of the data task.

  • projectId string
    Required

    Identifier of the data project.

Request Body

  • application/json object
    Show application/json properties
    • allowRecreate boolean
      Required

      Allow recreation of existing artifacts

      default = false

Responses

202

Preparation started

  • application/json object
    Show application/json properties
    • actionId string
      Required

      Identifier for tracking the action

400

Invalid request

  • application/json object

    Standard error response wrapper containing one or more error details and a trace ID for diagnostics.

    Show application/json properties
    • errors array of objects

      Array of error objects describing what went wrong.

      Show errors properties
      • code string

        Machine-readable error code for programmatic handling.

      • title string

        Brief human-readable summary of the error.

      • detail string

        Detailed explanation of the error and suggested remediation steps.

      • source object

        Identifies the location of the error in the request.

        Show source properties
        • pointer string

          JSON Pointer (RFC 6901) to the field in the request body that caused the error.

        • parameter string

          Name of the query parameter or path parameter that caused the error.
      • status integer

        HTTP status code associated with the error.

        format = int32

    • traceId string

      Unique identifier for this error response, useful for tracking and support inquiries.

404

Task not found

  • application/json object

    Standard error response wrapper containing one or more error details and a trace ID for diagnostics.

    Show application/json properties
    • errors array of objects

      Array of error objects describing what went wrong.

      Show errors properties
      • code string

        Machine-readable error code for programmatic handling.

      • title string

        Brief human-readable summary of the error.

      • detail string

        Detailed explanation of the error and suggested remediation steps.

      • source object

        Identifies the location of the error in the request.

        Show source properties
        • pointer string

          JSON Pointer (RFC 6901) to the field in the request body that caused the error.

        • parameter string

          Name of the query parameter or path parameter that caused the error.
      • status integer

        HTTP status code associated with the error.

        format = int32

    • traceId string

      Unique identifier for this error response, useful for tracking and support inquiries.
POST /api/v1/di-projects/{projectId}/di-tasks/{dataTaskId}/actions/prepare 
import { createQlikApi } from '@qlik/api'


const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})


await qlik.diProjects.prepareDiProjectDiTask(
  '65424a71c11367914c1e659b',
  'task-cYSY',
  {},
)
qlik di-project di-task prepare \
  --di-projectId '65424a71c11367914c1e659b' \
  --di-taskId 'task-cYSY' \
  --allowRecreate false
curl "https://{tenant}.{region}.qlikcloud.com/api/v1/di-projects/{projectId}/di-tasks/{dataTaskId}/actions/prepare" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{"allowRecreate":false}'

Example Response

{
  "actionId": "action-123456"
}

Recreate task datasets

Recreates datasets in the specified data task.

Facts

Rate limit Tier 2 (100 requests per minute)

Path Parameters

  • dataTaskId string
    Required

    Identifier of the data task.

  • projectId string
    Required

    Identifier of the data project.

Request Body

  • application/json object

    Request body to recreate task datasets.

Responses

202

Started recreating datasets

  • application/json object
    Show application/json properties
    • actionId string
      Required

      Identifier for tracking the action

400

Invalid request

  • application/json object

    Standard error response wrapper containing one or more error details and a trace ID for diagnostics.

    Show application/json properties
    • errors array of objects

      Array of error objects describing what went wrong.

      Show errors properties
      • code string

        Machine-readable error code for programmatic handling.

      • title string

        Brief human-readable summary of the error.

      • detail string

        Detailed explanation of the error and suggested remediation steps.

      • source object

        Identifies the location of the error in the request.

        Show source properties
        • pointer string

          JSON Pointer (RFC 6901) to the field in the request body that caused the error.

        • parameter string

          Name of the query parameter or path parameter that caused the error.
      • status integer

        HTTP status code associated with the error.

        format = int32

    • traceId string

      Unique identifier for this error response, useful for tracking and support inquiries.

404

Task or project not found

  • application/json object

    Standard error response wrapper containing one or more error details and a trace ID for diagnostics.

    Show application/json properties
    • errors array of objects

      Array of error objects describing what went wrong.

      Show errors properties
      • code string

        Machine-readable error code for programmatic handling.

      • title string

        Brief human-readable summary of the error.

      • detail string

        Detailed explanation of the error and suggested remediation steps.

      • source object

        Identifies the location of the error in the request.

        Show source properties
        • pointer string

          JSON Pointer (RFC 6901) to the field in the request body that caused the error.

        • parameter string

          Name of the query parameter or path parameter that caused the error.
      • status integer

        HTTP status code associated with the error.

        format = int32

    • traceId string

      Unique identifier for this error response, useful for tracking and support inquiries.
POST /api/v1/di-projects/{projectId}/di-tasks/{dataTaskId}/actions/recreate-datasets 
import { createQlikApi } from '@qlik/api'


const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})


await qlik.diProjects.recreateDatasetsDiProjectDiTask(
  '65424a71c11367914c1e659b',
  'task-cYSY',
  {},
)
qlik di-project di-task recreate-datasets \
  --di-projectId '65424a71c11367914c1e659b' \
  --di-taskId 'task-cYSY'
curl "https://{tenant}.{region}.qlikcloud.com/api/v1/di-projects/{projectId}/di-tasks/{dataTaskId}/actions/recreate-datasets" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{}'

Example Response

{
  "actionId": "action-123456"
}

Request dataset reload

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.

Facts

Rate limit Tier 2 (100 requests per minute)

Path Parameters

  • dataTaskId string
    Required

    Identifier of the data task.

  • projectId string
    Required

    Identifier of the data project.

Request Body

Required
  • application/json object
    Show application/json properties
    • reloadStrategy string

      Reload strategy (optional, applies to materialized SQL transformations and transformation flows tasks)

      Can be one of: "NONE""TRUNCATE""COMPARE_AND_APPLY"

    • selectedDatasets array of objects

      Datasets to reload (optional, if omitted or empty, all datasets will be reloaded).

      Show selectedDatasets properties
      • datasetId string

Responses

200

Reload request registered.

  • application/json object

    Indicates whether the reload request was registered successfully.

    Show application/json properties
    • success boolean
      Required

      Always true when the server successfully registers the request.

400

Bad Request

  • application/json object

    Standard error response wrapper containing one or more error details and a trace ID for diagnostics.

    Show application/json properties
    • errors array of objects

      Array of error objects describing what went wrong.

      Show errors properties
      • code string

        Machine-readable error code for programmatic handling.

      • title string

        Brief human-readable summary of the error.

      • detail string

        Detailed explanation of the error and suggested remediation steps.

      • source object

        Identifies the location of the error in the request.

        Show source properties
        • pointer string

          JSON Pointer (RFC 6901) to the field in the request body that caused the error.

        • parameter string

          Name of the query parameter or path parameter that caused the error.
      • status integer

        HTTP status code associated with the error.

        format = int32

    • traceId string

      Unique identifier for this error response, useful for tracking and support inquiries.

404

Not Found

  • application/json object

    Standard error response wrapper containing one or more error details and a trace ID for diagnostics.

    Show application/json properties
    • errors array of objects

      Array of error objects describing what went wrong.

      Show errors properties
      • code string

        Machine-readable error code for programmatic handling.

      • title string

        Brief human-readable summary of the error.

      • detail string

        Detailed explanation of the error and suggested remediation steps.

      • source object

        Identifies the location of the error in the request.

        Show source properties
        • pointer string

          JSON Pointer (RFC 6901) to the field in the request body that caused the error.

        • parameter string

          Name of the query parameter or path parameter that caused the error.
      • status integer

        HTTP status code associated with the error.

        format = int32

    • traceId string

      Unique identifier for this error response, useful for tracking and support inquiries.
POST /api/v1/di-projects/{projectId}/di-tasks/{dataTaskId}/actions/request-reload 
import { createQlikApi } from '@qlik/api'


const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})


await qlik.diProjects.requestReloadDiProjectDiTask(
  '65424a71c11367914c1e659b',
  'task-cYSY',
  {
    reloadStrategy: 'NONE',
    selectedDatasets: [{ datasetId: 'string' }],
  },
)
qlik di-project di-task request-reload \
  --di-projectId '65424a71c11367914c1e659b' \
  --di-taskId 'task-cYSY'
curl "https://{tenant}.{region}.qlikcloud.com/api/v1/di-projects/{projectId}/di-tasks/{dataTaskId}/actions/request-reload" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{"reloadStrategy":"NONE","selectedDatasets":[{"datasetId":"string"}]}'

Example Response

{
  "success": true
}

Validate a project task

Validates the specified data task.

Facts

Rate limit Tier 2 (100 requests per minute)

Path Parameters

  • dataTaskId string
    Required

    Identifier of the data task.

  • projectId string
    Required

    Identifier of the data project.

Request Body

  • application/json object

    Request body for task validation

Responses

202

Validation started

  • application/json object
    Show application/json properties
    • actionId string
      Required

      Identifier for tracking the action

400

Invalid request

  • application/json object

    Standard error response wrapper containing one or more error details and a trace ID for diagnostics.

    Show application/json properties
    • errors array of objects

      Array of error objects describing what went wrong.

      Show errors properties
      • code string

        Machine-readable error code for programmatic handling.

      • title string

        Brief human-readable summary of the error.

      • detail string

        Detailed explanation of the error and suggested remediation steps.

      • source object

        Identifies the location of the error in the request.

        Show source properties
        • pointer string

          JSON Pointer (RFC 6901) to the field in the request body that caused the error.

        • parameter string

          Name of the query parameter or path parameter that caused the error.
      • status integer

        HTTP status code associated with the error.

        format = int32

    • traceId string

      Unique identifier for this error response, useful for tracking and support inquiries.

404

Task not found

  • application/json object

    Standard error response wrapper containing one or more error details and a trace ID for diagnostics.

    Show application/json properties
    • errors array of objects

      Array of error objects describing what went wrong.

      Show errors properties
      • code string

        Machine-readable error code for programmatic handling.

      • title string

        Brief human-readable summary of the error.

      • detail string

        Detailed explanation of the error and suggested remediation steps.

      • source object

        Identifies the location of the error in the request.

        Show source properties
        • pointer string

          JSON Pointer (RFC 6901) to the field in the request body that caused the error.

        • parameter string

          Name of the query parameter or path parameter that caused the error.
      • status integer

        HTTP status code associated with the error.

        format = int32

    • traceId string

      Unique identifier for this error response, useful for tracking and support inquiries.
POST /api/v1/di-projects/{projectId}/di-tasks/{dataTaskId}/actions/validate 
import { createQlikApi } from '@qlik/api'


const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})


await qlik.diProjects.validateDiProjectDiTask(
  '65424a71c11367914c1e659b',
  'task-cYSY',
  {},
)
qlik di-project di-task validate \
  --di-projectId '65424a71c11367914c1e659b' \
  --di-taskId 'task-cYSY'
curl "https://{tenant}.{region}.qlikcloud.com/api/v1/di-projects/{projectId}/di-tasks/{dataTaskId}/actions/validate" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{}'

Example Response

{
  "actionId": "action-123456"
}

Start a project task

Start a data task on a data integration project.

Facts

Rate limit Tier 2 (100 requests per minute)

Path Parameters

  • dataTaskId string
    Required

    Identifier of the data task.

  • projectId string
    Required

    Identifier of the data project.

Request Body

  • application/json object
    Show application/json properties
    • option string

      Task run option for the task (optional, applies to Replication tasks only).

      Can be one of: "PROCESS_CHANGES_FROM_TIMESTAMP""PROCESS_CHANGES_FROM_POSITION""RECOVER_USING_LOCALLY_STORED_CHECKPOINT"

    • processChangesFrom string

      The value indicating where to resume the process, either a timestamp or an offset depending on the run option (optional, applies to Replication tasks only).

Responses

204

NO CONTENT

400

Bad Request

  • application/json object

    Standard error response wrapper containing one or more error details and a trace ID for diagnostics.

    Show application/json properties
    • errors array of objects

      Array of error objects describing what went wrong.

      Show errors properties
      • code string

        Machine-readable error code for programmatic handling.

      • title string

        Brief human-readable summary of the error.

      • detail string

        Detailed explanation of the error and suggested remediation steps.

      • source object

        Identifies the location of the error in the request.

        Show source properties
        • pointer string

          JSON Pointer (RFC 6901) to the field in the request body that caused the error.

        • parameter string

          Name of the query parameter or path parameter that caused the error.
      • status integer

        HTTP status code associated with the error.

        format = int32

    • traceId string

      Unique identifier for this error response, useful for tracking and support inquiries.

404

Not Found

  • application/json object

    Standard error response wrapper containing one or more error details and a trace ID for diagnostics.

    Show application/json properties
    • errors array of objects

      Array of error objects describing what went wrong.

      Show errors properties
      • code string

        Machine-readable error code for programmatic handling.

      • title string

        Brief human-readable summary of the error.

      • detail string

        Detailed explanation of the error and suggested remediation steps.

      • source object

        Identifies the location of the error in the request.

        Show source properties
        • pointer string

          JSON Pointer (RFC 6901) to the field in the request body that caused the error.

        • parameter string

          Name of the query parameter or path parameter that caused the error.
      • status integer

        HTTP status code associated with the error.

        format = int32

    • traceId string

      Unique identifier for this error response, useful for tracking and support inquiries.
POST /api/v1/di-projects/{projectId}/di-tasks/{dataTaskId}/runtime/actions/start 
import { createQlikApi } from '@qlik/api'


const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})


await qlik.diProjects.startDiProjectDiTaskRuntime(
  '65424a71c11367914c1e659b',
  'task-cYSY',
)
qlik di-project di-task runtime start \
  --di-projectId '65424a71c11367914c1e659b' \
  --di-taskId 'task-cYSY'
curl "https://{tenant}.{region}.qlikcloud.com/api/v1/di-projects/{projectId}/di-tasks/{dataTaskId}/runtime/actions/start" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{"option":"PROCESS_CHANGES_FROM_TIMESTAMP","processChangesFrom":"string"}'

Stop a project task

Stop a data task on a data integration project.

Facts

Rate limit Tier 2 (100 requests per minute)

Path Parameters

  • dataTaskId string
    Required

    Identifier of the data task.

  • projectId string
    Required

    Identifier of the data project.

Responses

204

NO CONTENT

400

Bad Request

  • application/json object

    Standard error response wrapper containing one or more error details and a trace ID for diagnostics.

    Show application/json properties
    • errors array of objects

      Array of error objects describing what went wrong.

      Show errors properties
      • code string

        Machine-readable error code for programmatic handling.

      • title string

        Brief human-readable summary of the error.

      • detail string

        Detailed explanation of the error and suggested remediation steps.

      • source object

        Identifies the location of the error in the request.

        Show source properties
        • pointer string

          JSON Pointer (RFC 6901) to the field in the request body that caused the error.

        • parameter string

          Name of the query parameter or path parameter that caused the error.
      • status integer

        HTTP status code associated with the error.

        format = int32

    • traceId string

      Unique identifier for this error response, useful for tracking and support inquiries.

404

Not Found

  • application/json object

    Standard error response wrapper containing one or more error details and a trace ID for diagnostics.

    Show application/json properties
    • errors array of objects

      Array of error objects describing what went wrong.

      Show errors properties
      • code string

        Machine-readable error code for programmatic handling.

      • title string

        Brief human-readable summary of the error.

      • detail string

        Detailed explanation of the error and suggested remediation steps.

      • source object

        Identifies the location of the error in the request.

        Show source properties
        • pointer string

          JSON Pointer (RFC 6901) to the field in the request body that caused the error.

        • parameter string

          Name of the query parameter or path parameter that caused the error.
      • status integer

        HTTP status code associated with the error.

        format = int32

    • traceId string

      Unique identifier for this error response, useful for tracking and support inquiries.
POST /api/v1/di-projects/{projectId}/di-tasks/{dataTaskId}/runtime/actions/stop 
import { createQlikApi } from '@qlik/api'


const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})


await qlik.diProjects.stopDiProjectDiTaskRuntime(
  '65424a71c11367914c1e659b',
  'task-cYSY',
)
qlik di-project di-task runtime stop \
  --di-projectId '65424a71c11367914c1e659b' \
  --di-taskId 'task-cYSY'
curl "https://{tenant}.{region}.qlikcloud.com/api/v1/di-projects/{projectId}/di-tasks/{dataTaskId}/runtime/actions/stop" \
-X POST \
-H "Authorization: Bearer <access_token>"

Get task run history state

Returns the state of a specific historical run instance for a data task, including execution progress and any errors encountered.

Facts

Rate limit Tier 1 (1000 requests per minute)

Path Parameters

  • dataTaskId string
    Required

    Identifier of the data task.

  • projectId string
    Required

    Identifier of the data project.

  • runId string
    Required

    Identifier of the run instance.

Responses

200

Run execution state retrieved successfully.

  • application/json object

    Represents the current or historical execution state of a data task, including progress information, error details, and dataset-level statistics.

    Show application/json properties
    • name string

      Name of the data task

    • type string

      Can be one of: "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"

    • lastRun object

      Represents the execution state of a task instance, including progress metrics, errors, and operation-specific statistics.

      Show lastRun properties
      • state string

        Can be one of: "STARTING""RUNNING""COMPLETED""FAILED""CANCELED""STOPPING"

      • errors array of objects

        List of errors encountered during the last run

        Show errors properties
        • code string

          Machine-readable error code for programmatic handling.

        • title string

          Brief human-readable summary of the error.

        • detail string

          Detailed explanation of the error and suggested remediation steps.

        • source object

          Identifies the location of the error in the request.

          Show source properties
          • pointer string

            JSON Pointer (RFC 6901) to the field in the request body that caused the error.

          • parameter string

            Name of the query parameter or path parameter that caused the error.
        • status integer

          HTTP status code associated with the error.

          format = int32

      • endTime string

        Timestamp indicating when the task instance ended

        format = "date-time"

      • general object

        Overall task execution statistics including dataset counts, data freshness timestamps, and infrastructure details.

        Show general properties
        • gatewayId string

          For tasks that run on a gateway, this is the id of the gateway

        • gatewayName string

          For tasks that run on a gateway, this is the name of the gateway

        • datasetCount number

          Total number of datasets produced by the task, including ones in error

        • gatewayTaskName string

          For tasks that run on a gateway, this is the internal name of the task on the gateway

        • dataTaskUpdatedTo string

          The latest point in time the data reflects, based on updates from the source system.

          format = "date-time"

        • lakehouseClusterId string

          For lakehouse storage tasks, this is the id of the cluster where the task runs

        • liveViewsUpdatedTo string

          The latest point in time the live views reflect, based on updates from the source system.

          format = "date-time"

        • datasetsInErrorCount number

          Count of datasets that encountered errors

        • lakehouseClusterName string

          For lakehouse storage tasks, this is the name of the cluster where the task runs
      • message string
      • traceId string

        Trace identifier for the last run, useful for diagnostics and support

      • duration string

        Duration in HH:MM:SS format (hours:minutes:seconds)

      • fullLoad object

        Statistics for the full load phase of the task run, tracking dataset processing progress.

        Show fullLoad properties
        • errorCount number

          Number of datasets that have failed full load in this task run

        • queuedCount number

          Number of datasets that are queued for full load in this task run

        • loadingCount number

          Number of datasets that are currently being loaded in this task run

        • completedCount number

          Number of datasets that have completed full load in this task run
      • cdcStatus object

        Change Data Capture status information for tasks performing incremental updates, including latency and processing counts.

        Show cdcStatus properties
        • latency string

          Duration in HH:MM:SS format (hours:minutes:seconds)

        • totalProcessedCount number
        • applyingChangesCount number
        • incomingChangesCount number

          Number of incoming changes. Only relevant for 'Iceberg Storage' and 'Streaming Transform' tasks.

        • accumulatingChangesCount number
        • throughputInKilobytesPerSecond number

          Throughput in kilobytes per second
      • startTime string

        Timestamp indicating when the task instance started

        format = "date-time"

      • streaming object

        Real-time streaming statistics for tasks that continuously process data streams.

        Show streaming properties
        • latency string

          Duration in HH:MM:SS format (hours:minutes:seconds)

        • errorCount number

          Number of streaming datasets that have encountered errors

        • queuedCount number

          Number of streaming datasets that are queued

        • runningCount number

          Number of streaming datasets that are currently running

        • totalProcessedCount number

          Total number of records processed
      • lastBatchOfChanges object

        Statistics for the most recent batch of changes processed during the task run, including timing and throughput metrics.

        Show lastBatchOfChanges properties
        • relatesToRecordsTo string

          This batch ends with operational source changes from this time.

          format = "date-time"

        • totalProcessedCount number
        • relatesToRecordsFrom string

          This batch starts with operational source changes from this time.

          format = "date-time"

        • throughputInRecordsPerSecond number

          Throughput in records per second
    • runReadiness object
      Show runReadiness properties
      • state string

        Can be one of: "READY_TO_RUN""ALREADY_RUNNING""NOT_RUNNABLE"

      • message string

400

Invalid request or missing parameters.

  • application/json object

    Standard error response wrapper containing one or more error details and a trace ID for diagnostics.

    Show application/json properties
    • errors array of objects

      Array of error objects describing what went wrong.

      Show errors properties
      • code string

        Machine-readable error code for programmatic handling.

      • title string

        Brief human-readable summary of the error.

      • detail string

        Detailed explanation of the error and suggested remediation steps.

      • source object

        Identifies the location of the error in the request.

        Show source properties
        • pointer string

          JSON Pointer (RFC 6901) to the field in the request body that caused the error.

        • parameter string

          Name of the query parameter or path parameter that caused the error.
      • status integer

        HTTP status code associated with the error.

        format = int32

    • traceId string

      Unique identifier for this error response, useful for tracking and support inquiries.

404

Task run not found.

  • application/json object

    Standard error response wrapper containing one or more error details and a trace ID for diagnostics.

    Show application/json properties
    • errors array of objects

      Array of error objects describing what went wrong.

      Show errors properties
      • code string

        Machine-readable error code for programmatic handling.

      • title string

        Brief human-readable summary of the error.

      • detail string

        Detailed explanation of the error and suggested remediation steps.

      • source object

        Identifies the location of the error in the request.

        Show source properties
        • pointer string

          JSON Pointer (RFC 6901) to the field in the request body that caused the error.

        • parameter string

          Name of the query parameter or path parameter that caused the error.
      • status integer

        HTTP status code associated with the error.

        format = int32

    • traceId string

      Unique identifier for this error response, useful for tracking and support inquiries.
GET /api/v1/di-projects/{projectId}/di-tasks/{dataTaskId}/runtime/runs/{runId}/state 
import { createQlikApi } from '@qlik/api'


const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})


await qlik.diProjects.getDiProjectDiTaskRuntimeRunState(
  '65424a71c11367914c1e659b',
  'task-cYSY',
  'run-abc123',
)
qlik di-project di-task runtime run state get \
  --di-projectId '65424a71c11367914c1e659b' \
  --di-taskId 'task-cYSY' \
  --runId 'run-abc123'
curl "https://{tenant}.{region}.qlikcloud.com/api/v1/di-projects/{projectId}/di-tasks/{dataTaskId}/runtime/runs/{runId}/state" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "name": "string",
  "type": "LANDING",
  "lastRun": {
    "state": "STARTING",
    "errors": [
      {
        "code": "string",
        "title": "string",
        "detail": "string",
        "source": {
          "pointer": "string",
          "parameter": "string"
        },
        "status": 42
      }
    ],
    "endTime": "2018-10-30T07:06:22Z",
    "general": {
      "gatewayId": "string",
      "gatewayName": "string",
      "datasetCount": 42,
      "gatewayTaskName": "string",
      "dataTaskUpdatedTo": "2018-10-30T07:06:22Z",
      "lakehouseClusterId": "string",
      "liveViewsUpdatedTo": "2018-10-30T07:06:22Z",
      "datasetsInErrorCount": 42,
      "lakehouseClusterName": "string"
    },
    "message": "string",
    "traceId": "string",
    "duration": "string",
    "fullLoad": {
      "errorCount": 42,
      "queuedCount": 42,
      "loadingCount": 42,
      "completedCount": 42
    },
    "cdcStatus": {
      "latency": "01:30:45",
      "totalProcessedCount": 42,
      "applyingChangesCount": 42,
      "incomingChangesCount": 42,
      "accumulatingChangesCount": 42,
      "throughputInKilobytesPerSecond": 42
    },
    "startTime": "2018-10-30T07:06:22Z",
    "streaming": {
      "latency": "string",
      "errorCount": 42,
      "queuedCount": 42,
      "runningCount": 42,
      "totalProcessedCount": 42
    },
    "lastBatchOfChanges": {
      "relatesToRecordsTo": "2018-10-30T07:06:22Z",
      "totalProcessedCount": 42,
      "relatesToRecordsFrom": "2018-10-30T07:06:22Z",
      "throughputInRecordsPerSecond": 42
    }
  },
  "runReadiness": {
    "state": "READY_TO_RUN",
    "message": "string"
  }
}

List dataset run history states

Returns dataset-level state for a specific historical run instance of a data task. All datasets for the run are returned in a single response; this endpoint does not paginate.

Facts

Rate limit Tier 1 (1000 requests per minute)

Path Parameters

  • dataTaskId string
    Required

    Identifier of the data task.

  • projectId string
    Required

    Identifier of the data project.

  • runId string
    Required

    Identifier of the run instance.

Responses

200

Dataset-level state for the specified run instance retrieved successfully.

  • application/json object
    Show application/json properties
    • datasets array of objects

      Represents the execution state of a single dataset within a task run, including full load, CDC, and streaming progress.

      Show datasets properties
      • name string

        Name of the dataset

      • fullLoad object
        Show fullLoad properties
        • state string

          Can be one of: "QUEUED""LOADING""COMPLETED""ERROR"

        • endTime string

          format = "date-time"

        • message string
        • duration string

          Duration in HH:MM:SS format (hours:minutes:seconds)

        • fileStats object

          Statistics for file-based tasks.

          Show fileStats properties
          • volume string

            Volume of data processed (e.g. '10.91 MiB').

          • processedCount number

            Number of files processed.
        • startTime string

          format = "date-time"

        • cachedChangesCount number

          Number of changes captured and cached during full load (CDC landing/replication tasks only)

        • failedRecordsCount number

          Number of records that failed to load (currently only for knowledge marts)

        • totalProcessedCount number

          Number of records (or docs in knowledge marts) were loaded.
      • cdcStatus object

        Change Data Capture state for the dataset, tracking incremental changes applied and any errors.

        Show cdcStatus properties
        • state string

          Can be one of: "QUEUED""PROCESSING""ACCUMULATING_CHANGES""COMPLETED""ERROR"

        • message string
        • ddlCount number

          Number of DDL statements executed during the last run

        • deleteCount number

          delete portion of totalProcessedCount. Only available for some task types

        • insertCount number

          Insert portion of totalProcessedCount. Only available for some task types

        • updateCount number

          update portion of totalProcessedCount. Only available for some task types

        • lastProcessed string

          format = "date-time"

        • totalProcessedCount number

          Total number of changes/DMLs applied to the dataset

        • incomingChangesCount number

          Number of incoming changes for the dataset. Only relevant for 'Iceberg Storage' and 'Streaming Transform' tasks.

        • unoptimizedRecordsCount number

          Number of records that are queryable via the view, but not yet merged into optimized Iceberg partitions. Only relevant for 'Iceberg Storage' and 'Streaming Transform' tasks.
      • datasetId string

        Id of the dataset

      • streaming object

        Real-time streaming state for the dataset, tracking record processing and transformation statistics.

        Show streaming properties
        • state string

          Can be one of: "QUEUED""RUNNING""ERROR"

        • message string
        • lastProcessed string

          Timestamp of the latest source record inserted into the target dataset.

          format = "date-time"

        • parseIssueCount number

          Number of records that had parsing issues

        • recordsWrittenCount number

          Total number of records written to the dataset

        • totalProcessedCount number

          Total number of processed changes for the dataset

        • recordsFilteredCount number

          Total number of records filtered out and not written to the dataset

        • unoptimizedRecordsCount number

          Queryable records pending merge into optimized Iceberg partitions.
      • sourceName string

        Original name of the dataset, relevant only for data movement tasks

      • dataReadiness string

        Is the data ready for use?

        Can be one of: "READY""NOT_READY""ERROR"

      • lastBatchOfChanges object
        Show lastBatchOfChanges properties
        • state string

          Can be one of: "QUEUED""PROCESSING""COMPLETED""ERROR"

        • endTime string

          format = "date-time"

        • message string
        • duration string

          Duration in HH:MM:SS format (hours:minutes:seconds)

        • fileStats object

          Statistics for file-based tasks.

          Show fileStats properties
          • volume string

            Volume of data processed (e.g. '10.91 MiB').

          • processedCount number

            Number of files processed.
        • startTime string

          format = "date-time"

        • operationStats object

          Breakdown of operations for record-oriented tasks.

          Show operationStats properties
          • deleteCount number

            Number of delete operations.

          • failedCount number

            Number of failed operations.

          • insertCount number

            Number of insert operations.

          • updateCount number

            Number of update operations.
        • totalProcessedCount number
        • throughputInRecordsPerSecond number

          Throughput in records per second

400

Invalid request or missing parameters.

  • application/json object

    Standard error response wrapper containing one or more error details and a trace ID for diagnostics.

    Show application/json properties
    • errors array of objects

      Array of error objects describing what went wrong.

      Show errors properties
      • code string

        Machine-readable error code for programmatic handling.

      • title string

        Brief human-readable summary of the error.

      • detail string

        Detailed explanation of the error and suggested remediation steps.

      • source object

        Identifies the location of the error in the request.

        Show source properties
        • pointer string

          JSON Pointer (RFC 6901) to the field in the request body that caused the error.

        • parameter string

          Name of the query parameter or path parameter that caused the error.
      • status integer

        HTTP status code associated with the error.

        format = int32

    • traceId string

      Unique identifier for this error response, useful for tracking and support inquiries.

404

Task run not found.

  • application/json object

    Standard error response wrapper containing one or more error details and a trace ID for diagnostics.

    Show application/json properties
    • errors array of objects

      Array of error objects describing what went wrong.

      Show errors properties
      • code string

        Machine-readable error code for programmatic handling.

      • title string

        Brief human-readable summary of the error.

      • detail string

        Detailed explanation of the error and suggested remediation steps.

      • source object

        Identifies the location of the error in the request.

        Show source properties
        • pointer string

          JSON Pointer (RFC 6901) to the field in the request body that caused the error.

        • parameter string

          Name of the query parameter or path parameter that caused the error.
      • status integer

        HTTP status code associated with the error.

        format = int32

    • traceId string

      Unique identifier for this error response, useful for tracking and support inquiries.

410

Gone — the dataset state for this run has been purged due to retention policy.

  • application/json object

    Standard error response wrapper containing one or more error details and a trace ID for diagnostics.

    Show application/json properties
    • errors array of objects

      Array of error objects describing what went wrong.

      Show errors properties
      • code string

        Machine-readable error code for programmatic handling.

      • title string

        Brief human-readable summary of the error.

      • detail string

        Detailed explanation of the error and suggested remediation steps.

      • source object

        Identifies the location of the error in the request.

        Show source properties
        • pointer string

          JSON Pointer (RFC 6901) to the field in the request body that caused the error.

        • parameter string

          Name of the query parameter or path parameter that caused the error.
      • status integer

        HTTP status code associated with the error.

        format = int32

    • traceId string

      Unique identifier for this error response, useful for tracking and support inquiries.

413

Payload Too Large — the dataset state for this run exceeds the per-response size limit. This is a soft guard against pathologically large tasks; if you hit this consistently, contact support.

  • application/json object

    Standard error response wrapper containing one or more error details and a trace ID for diagnostics.

    Show application/json properties
    • errors array of objects

      Array of error objects describing what went wrong.

      Show errors properties
      • code string

        Machine-readable error code for programmatic handling.

      • title string

        Brief human-readable summary of the error.

      • detail string

        Detailed explanation of the error and suggested remediation steps.

      • source object

        Identifies the location of the error in the request.

        Show source properties
        • pointer string

          JSON Pointer (RFC 6901) to the field in the request body that caused the error.

        • parameter string

          Name of the query parameter or path parameter that caused the error.
      • status integer

        HTTP status code associated with the error.

        format = int32

    • traceId string

      Unique identifier for this error response, useful for tracking and support inquiries.
GET /api/v1/di-projects/{projectId}/di-tasks/{dataTaskId}/runtime/runs/{runId}/state/datasets 
import { createQlikApi } from '@qlik/api'


const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})


await qlik.diProjects.getDiProjectDiTaskRuntimeRunStateDatasets(
  '65424a71c11367914c1e659b',
  'task-cYSY',
  'run-abc123',
)
qlik di-project di-task runtime run state dataset ls \
  --di-projectId '65424a71c11367914c1e659b' \
  --di-taskId 'task-cYSY' \
  --runId 'run-abc123'
curl "https://{tenant}.{region}.qlikcloud.com/api/v1/di-projects/{projectId}/di-tasks/{dataTaskId}/runtime/runs/{runId}/state/datasets" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "datasets": [
    {
      "name": "string",
      "fullLoad": {
        "state": "QUEUED",
        "endTime": "2018-10-30T07:06:22Z",
        "message": "string",
        "duration": "string",
        "fileStats": {
          "volume": "string",
          "processedCount": 42
        },
        "startTime": "2018-10-30T07:06:22Z",
        "cachedChangesCount": 42,
        "failedRecordsCount": 42,
        "totalProcessedCount": 42
      },
      "cdcStatus": {
        "state": "QUEUED",
        "message": "string",
        "ddlCount": 42,
        "deleteCount": 42,
        "insertCount": 42,
        "updateCount": 42,
        "lastProcessed": "2018-10-30T07:06:22Z",
        "totalProcessedCount": 42,
        "incomingChangesCount": 42,
        "unoptimizedRecordsCount": 42
      },
      "datasetId": "string",
      "streaming": {
        "state": "QUEUED",
        "message": "string",
        "lastProcessed": "2018-10-30T07:06:22Z",
        "parseIssueCount": 42,
        "recordsWrittenCount": 42,
        "totalProcessedCount": 42,
        "recordsFilteredCount": 42,
        "unoptimizedRecordsCount": 42
      },
      "sourceName": "string",
      "dataReadiness": "READY",
      "lastBatchOfChanges": {
        "state": "QUEUED",
        "endTime": "2018-10-30T07:06:22Z",
        "message": "string",
        "duration": "string",
        "fileStats": {
          "volume": "string",
          "processedCount": 42
        },
        "startTime": "2018-10-30T07:06:22Z",
        "operationStats": {
          "deleteCount": 42,
          "failedCount": 42,
          "insertCount": 42,
          "updateCount": 42
        },
        "totalProcessedCount": 42,
        "throughputInRecordsPerSecond": 42
      }
    }
  ]
}

Search task run history

Returns a paginated list of historical run instances for the specified data task, filtered by the provided criteria.

Facts

Rate limit Tier 2 (100 requests per minute)

Path Parameters

  • dataTaskId string
    Required

    Identifier of the data task.

  • projectId string
    Required

    Identifier of the data project.

Request Body

Required

Search criteria and pagination options for task run history query.

  • application/json object

    Request parameters for searching task run history, including filter criteria and pagination options.

    Show application/json properties
    • limit integer

      Maximum number of runs to return.

      minimum = 1, maximum = 200, default = 50, format = int32, default = 50

    • lastId string

      Cursor for paging. Pass the runId of the last item from the previous response to fetch the next page; omit on the first request.

    • filters array of objects

      Field filters to apply to the search.

      Show filters properties
      • field string
        Required

        The run-history field to filter on.

        Can be one of: "ID""STATUS""SUB_STATUS""PERIOD"

      • value array of strings
        Required

        Values to match. For BETWEEN on PERIOD, supply exactly two ISO-8601 timestamps.

      • operator string
        Required

        Filter operator.

        • IN / NOT_IN: exact match against the values list (recommended for ID, STATUS, SUB_STATUS).
        • BETWEEN: only valid with the PERIOD field. The value list must contain two ISO-8601 timestamps (start, end).

        Can be one of: "IN""NOT_IN""BETWEEN"

Responses

200

Search results retrieved successfully.

  • application/json object
    Show application/json properties
    • runs array of objects

      List of task run instances matching the search.

      Show runs properties
      • runId string

        Identifier of the run instance.

      • status string

        Execution status of a task run instance.

        Can be one of: "STARTING""RUNNING""COMPLETED""FAILED""CANCELED""MISFIRED"

      • endTime string

        Timestamp indicating when the run ended.

        format = "date-time"

      • duration string

        Duration of the run in HH:MM:SS format.

      • startTime string

        Timestamp indicating when the run started.

        format = "date-time"

      • subStatus string

        Sub-status of the run, when applicable.

      • errorMessage string

        Error message, if the run failed.

        default = ""

      • datasetsCount integer

        Total number of datasets processed in this run.

        format = int32

      • originSubStatus string

        Origin-specific sub-status of the run, when applicable.

      • datasetsErrorCount integer

        Number of datasets that encountered errors in this run.

        format = int32

    • lastId string

      Identifier of the last run in this page. Pass this value back as lastId in the next request to fetch the following page.

    • nextPageExists boolean

      True when more pages are available after this one; false when this is the last page.

400

Invalid request. Check parameter formats and filter syntax.

  • application/json object

    Standard error response wrapper containing one or more error details and a trace ID for diagnostics.

    Show application/json properties
    • errors array of objects

      Array of error objects describing what went wrong.

      Show errors properties
      • code string

        Machine-readable error code for programmatic handling.

      • title string

        Brief human-readable summary of the error.

      • detail string

        Detailed explanation of the error and suggested remediation steps.

      • source object

        Identifies the location of the error in the request.

        Show source properties
        • pointer string

          JSON Pointer (RFC 6901) to the field in the request body that caused the error.

        • parameter string

          Name of the query parameter or path parameter that caused the error.
      • status integer

        HTTP status code associated with the error.

        format = int32

    • traceId string

      Unique identifier for this error response, useful for tracking and support inquiries.

404

Project or task not found.

  • application/json object

    Standard error response wrapper containing one or more error details and a trace ID for diagnostics.

    Show application/json properties
    • errors array of objects

      Array of error objects describing what went wrong.

      Show errors properties
      • code string

        Machine-readable error code for programmatic handling.

      • title string

        Brief human-readable summary of the error.

      • detail string

        Detailed explanation of the error and suggested remediation steps.

      • source object

        Identifies the location of the error in the request.

        Show source properties
        • pointer string

          JSON Pointer (RFC 6901) to the field in the request body that caused the error.

        • parameter string

          Name of the query parameter or path parameter that caused the error.
      • status integer

        HTTP status code associated with the error.

        format = int32

    • traceId string

      Unique identifier for this error response, useful for tracking and support inquiries.
POST /api/v1/di-projects/{projectId}/di-tasks/{dataTaskId}/runtime/runs/actions/search 
import { createQlikApi } from '@qlik/api'


const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})


await qlik.diProjects.searchDiProjectDiTaskRuntimeRuns(
  '65424a71c11367914c1e659b',
  'task-cYSY',
  {
    filters: [
      {
        field: 'STATUS',
        operator: 'IN',
        value: ['COMPLETED', 'FAILED'],
      },


      {
        field: 'PERIOD',
        operator: 'BETWEEN',
        value: [
          '2024-03-01T00:00:00Z',


          '2024-03-31T23:59:59Z',
        ],
      },
    ],
    lastId:
      'caf50cbf-d6f8-47c6-a5e0-b31e0d11102a',
    limit: 50,
  },
)
qlik di-project di-task runtime run search \
  --di-projectId '65424a71c11367914c1e659b' \
  --di-taskId 'task-cYSY' \
  --filters-field '' \
  --filters-operator '' \
  --filters-value ''
curl "https://{tenant}.{region}.qlikcloud.com/api/v1/di-projects/{projectId}/di-tasks/{dataTaskId}/runtime/runs/actions/search" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{"limit":50,"lastId":"caf50cbf-d6f8-47c6-a5e0-b31e0d11102a","filters":[{"field":"STATUS","value":["COMPLETED","FAILED"],"operator":"IN"},{"field":"PERIOD","value":["2024-03-01T00:00:00Z","2024-03-31T23:59:59Z"],"operator":"BETWEEN"}]}'

Example Response

{
  "runs": [
    {
      "runId": "caf50cbf-d6f8-47c6-a5e0-b31e0d11102a",
      "status": "STARTING",
      "endTime": "2024-03-01T09:30:00Z",
      "duration": "00:30:00",
      "startTime": "2024-03-01T09:00:00Z",
      "subStatus": "string",
      "errorMessage": "",
      "datasetsCount": 10,
      "originSubStatus": "string",
      "datasetsErrorCount": 0
    }
  ],
  "lastId": "caf50cbf-d6f8-47c6-a5e0-b31e0d11102a",
  "nextPageExists": true
}

Get project task runtime state

Get the current runtime state of a data task

Facts

Rate limit Special (120 requests per minute)

Path Parameters

  • dataTaskId string
    Required

    Identifier of the data task.

  • projectId string
    Required

    Identifier of the data project.

Responses

200

OK

  • application/json object

    Represents the current or historical execution state of a data task, including progress information, error details, and dataset-level statistics.

    Show application/json properties
    • name string

      Name of the data task

    • type string

      Can be one of: "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"

    • lastRun object

      Represents the execution state of a task instance, including progress metrics, errors, and operation-specific statistics.

      Show lastRun properties
      • state string

        Can be one of: "STARTING""RUNNING""COMPLETED""FAILED""CANCELED""STOPPING"

      • errors array of objects

        List of errors encountered during the last run

        Show errors properties
        • code string

          Machine-readable error code for programmatic handling.

        • title string

          Brief human-readable summary of the error.

        • detail string

          Detailed explanation of the error and suggested remediation steps.

        • source object

          Identifies the location of the error in the request.

          Show source properties
          • pointer string

            JSON Pointer (RFC 6901) to the field in the request body that caused the error.

          • parameter string

            Name of the query parameter or path parameter that caused the error.
        • status integer

          HTTP status code associated with the error.

          format = int32

      • endTime string

        Timestamp indicating when the task instance ended

        format = "date-time"

      • general object

        Overall task execution statistics including dataset counts, data freshness timestamps, and infrastructure details.

        Show general properties
        • gatewayId string

          For tasks that run on a gateway, this is the id of the gateway

        • gatewayName string

          For tasks that run on a gateway, this is the name of the gateway

        • datasetCount number

          Total number of datasets produced by the task, including ones in error

        • gatewayTaskName string

          For tasks that run on a gateway, this is the internal name of the task on the gateway

        • dataTaskUpdatedTo string

          The latest point in time the data reflects, based on updates from the source system.

          format = "date-time"

        • lakehouseClusterId string

          For lakehouse storage tasks, this is the id of the cluster where the task runs

        • liveViewsUpdatedTo string

          The latest point in time the live views reflect, based on updates from the source system.

          format = "date-time"

        • datasetsInErrorCount number

          Count of datasets that encountered errors

        • lakehouseClusterName string

          For lakehouse storage tasks, this is the name of the cluster where the task runs
      • message string
      • traceId string

        Trace identifier for the last run, useful for diagnostics and support

      • duration string

        Duration in HH:MM:SS format (hours:minutes:seconds)

      • fullLoad object

        Statistics for the full load phase of the task run, tracking dataset processing progress.

        Show fullLoad properties
        • errorCount number

          Number of datasets that have failed full load in this task run

        • queuedCount number

          Number of datasets that are queued for full load in this task run

        • loadingCount number

          Number of datasets that are currently being loaded in this task run

        • completedCount number

          Number of datasets that have completed full load in this task run
      • cdcStatus object

        Change Data Capture status information for tasks performing incremental updates, including latency and processing counts.

        Show cdcStatus properties
        • latency string

          Duration in HH:MM:SS format (hours:minutes:seconds)

        • totalProcessedCount number
        • applyingChangesCount number
        • incomingChangesCount number

          Number of incoming changes. Only relevant for 'Iceberg Storage' and 'Streaming Transform' tasks.

        • accumulatingChangesCount number
        • throughputInKilobytesPerSecond number

          Throughput in kilobytes per second
      • startTime string

        Timestamp indicating when the task instance started

        format = "date-time"

      • streaming object

        Real-time streaming statistics for tasks that continuously process data streams.

        Show streaming properties
        • latency string

          Duration in HH:MM:SS format (hours:minutes:seconds)

        • errorCount number

          Number of streaming datasets that have encountered errors

        • queuedCount number

          Number of streaming datasets that are queued

        • runningCount number

          Number of streaming datasets that are currently running

        • totalProcessedCount number

          Total number of records processed
      • lastBatchOfChanges object

        Statistics for the most recent batch of changes processed during the task run, including timing and throughput metrics.

        Show lastBatchOfChanges properties
        • relatesToRecordsTo string

          This batch ends with operational source changes from this time.

          format = "date-time"

        • totalProcessedCount number
        • relatesToRecordsFrom string

          This batch starts with operational source changes from this time.

          format = "date-time"

        • throughputInRecordsPerSecond number

          Throughput in records per second
    • runReadiness object
      Show runReadiness properties
      • state string

        Can be one of: "READY_TO_RUN""ALREADY_RUNNING""NOT_RUNNABLE"

      • message string

400

Bad Request

  • application/json object

    Standard error response wrapper containing one or more error details and a trace ID for diagnostics.

    Show application/json properties
    • errors array of objects

      Array of error objects describing what went wrong.

      Show errors properties
      • code string

        Machine-readable error code for programmatic handling.

      • title string

        Brief human-readable summary of the error.

      • detail string

        Detailed explanation of the error and suggested remediation steps.

      • source object

        Identifies the location of the error in the request.

        Show source properties
        • pointer string

          JSON Pointer (RFC 6901) to the field in the request body that caused the error.

        • parameter string

          Name of the query parameter or path parameter that caused the error.
      • status integer

        HTTP status code associated with the error.

        format = int32

    • traceId string

      Unique identifier for this error response, useful for tracking and support inquiries.

404

Not Found

  • application/json object

    Standard error response wrapper containing one or more error details and a trace ID for diagnostics.

    Show application/json properties
    • errors array of objects

      Array of error objects describing what went wrong.

      Show errors properties
      • code string

        Machine-readable error code for programmatic handling.

      • title string

        Brief human-readable summary of the error.

      • detail string

        Detailed explanation of the error and suggested remediation steps.

      • source object

        Identifies the location of the error in the request.

        Show source properties
        • pointer string

          JSON Pointer (RFC 6901) to the field in the request body that caused the error.

        • parameter string

          Name of the query parameter or path parameter that caused the error.
      • status integer

        HTTP status code associated with the error.

        format = int32

    • traceId string

      Unique identifier for this error response, useful for tracking and support inquiries.
GET /api/v1/di-projects/{projectId}/di-tasks/{dataTaskId}/runtime/state 
import { createQlikApi } from '@qlik/api'


const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})


await qlik.diProjects.getDiProjectDiTaskRuntimeState(
  '65424a71c11367914c1e659b',
  'task-cYSY',
)
qlik di-project di-task runtime state \
  --di-projectId '65424a71c11367914c1e659b' \
  --di-taskId 'task-cYSY'
curl "https://{tenant}.{region}.qlikcloud.com/api/v1/di-projects/{projectId}/di-tasks/{dataTaskId}/runtime/state" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "name": "string",
  "type": "LANDING",
  "lastRun": {
    "state": "STARTING",
    "errors": [
      {
        "code": "string",
        "title": "string",
        "detail": "string",
        "source": {
          "pointer": "string",
          "parameter": "string"
        },
        "status": 42
      }
    ],
    "endTime": "2018-10-30T07:06:22Z",
    "general": {
      "gatewayId": "string",
      "gatewayName": "string",
      "datasetCount": 42,
      "gatewayTaskName": "string",
      "dataTaskUpdatedTo": "2018-10-30T07:06:22Z",
      "lakehouseClusterId": "string",
      "liveViewsUpdatedTo": "2018-10-30T07:06:22Z",
      "datasetsInErrorCount": 42,
      "lakehouseClusterName": "string"
    },
    "message": "string",
    "traceId": "string",
    "duration": "string",
    "fullLoad": {
      "errorCount": 42,
      "queuedCount": 42,
      "loadingCount": 42,
      "completedCount": 42
    },
    "cdcStatus": {
      "latency": "01:30:45",
      "totalProcessedCount": 42,
      "applyingChangesCount": 42,
      "incomingChangesCount": 42,
      "accumulatingChangesCount": 42,
      "throughputInKilobytesPerSecond": 42
    },
    "startTime": "2018-10-30T07:06:22Z",
    "streaming": {
      "latency": "string",
      "errorCount": 42,
      "queuedCount": 42,
      "runningCount": 42,
      "totalProcessedCount": 42
    },
    "lastBatchOfChanges": {
      "relatesToRecordsTo": "2018-10-30T07:06:22Z",
      "totalProcessedCount": 42,
      "relatesToRecordsFrom": "2018-10-30T07:06:22Z",
      "throughputInRecordsPerSecond": 42
    }
  },
  "runReadiness": {
    "state": "READY_TO_RUN",
    "message": "string"
  }
}

List dataset runtime states

Returns dataset-level runtime state for a data task

Facts

Rate limit Special (120 requests per minute)

Path Parameters

  • dataTaskId string
    Required

    Identifier of the data task.

  • projectId string
    Required

    Identifier of the data project.

Responses

200

Returns all datasets for the specified data task

  • application/json object
    Show application/json properties
    • datasets array of objects

      Represents the execution state of a single dataset within a task run, including full load, CDC, and streaming progress.

      Show datasets properties
      • name string

        Name of the dataset

      • fullLoad object
        Show fullLoad properties
        • state string

          Can be one of: "QUEUED""LOADING""COMPLETED""ERROR"

        • endTime string

          format = "date-time"

        • message string
        • duration string

          Duration in HH:MM:SS format (hours:minutes:seconds)

        • fileStats object

          Statistics for file-based tasks.

          Show fileStats properties
          • volume string

            Volume of data processed (e.g. '10.91 MiB').

          • processedCount number

            Number of files processed.
        • startTime string

          format = "date-time"

        • cachedChangesCount number

          Number of changes captured and cached during full load (CDC landing/replication tasks only)

        • failedRecordsCount number

          Number of records that failed to load (currently only for knowledge marts)

        • totalProcessedCount number

          Number of records (or docs in knowledge marts) were loaded.
      • cdcStatus object

        Change Data Capture state for the dataset, tracking incremental changes applied and any errors.

        Show cdcStatus properties
        • state string

          Can be one of: "QUEUED""PROCESSING""ACCUMULATING_CHANGES""COMPLETED""ERROR"

        • message string
        • ddlCount number

          Number of DDL statements executed during the last run

        • deleteCount number

          delete portion of totalProcessedCount. Only available for some task types

        • insertCount number

          Insert portion of totalProcessedCount. Only available for some task types

        • updateCount number

          update portion of totalProcessedCount. Only available for some task types

        • lastProcessed string

          format = "date-time"

        • totalProcessedCount number

          Total number of changes/DMLs applied to the dataset

        • incomingChangesCount number

          Number of incoming changes for the dataset. Only relevant for 'Iceberg Storage' and 'Streaming Transform' tasks.

        • unoptimizedRecordsCount number

          Number of records that are queryable via the view, but not yet merged into optimized Iceberg partitions. Only relevant for 'Iceberg Storage' and 'Streaming Transform' tasks.
      • datasetId string

        Id of the dataset

      • streaming object

        Real-time streaming state for the dataset, tracking record processing and transformation statistics.

        Show streaming properties
        • state string

          Can be one of: "QUEUED""RUNNING""ERROR"

        • message string
        • lastProcessed string

          Timestamp of the latest source record inserted into the target dataset.

          format = "date-time"

        • parseIssueCount number

          Number of records that had parsing issues

        • recordsWrittenCount number

          Total number of records written to the dataset

        • totalProcessedCount number

          Total number of processed changes for the dataset

        • recordsFilteredCount number

          Total number of records filtered out and not written to the dataset

        • unoptimizedRecordsCount number

          Queryable records pending merge into optimized Iceberg partitions.
      • sourceName string

        Original name of the dataset, relevant only for data movement tasks

      • dataReadiness string

        Is the data ready for use?

        Can be one of: "READY""NOT_READY""ERROR"

      • lastBatchOfChanges object
        Show lastBatchOfChanges properties
        • state string

          Can be one of: "QUEUED""PROCESSING""COMPLETED""ERROR"

        • endTime string

          format = "date-time"

        • message string
        • duration string

          Duration in HH:MM:SS format (hours:minutes:seconds)

        • fileStats object

          Statistics for file-based tasks.

          Show fileStats properties
          • volume string

            Volume of data processed (e.g. '10.91 MiB').

          • processedCount number

            Number of files processed.
        • startTime string

          format = "date-time"

        • operationStats object

          Breakdown of operations for record-oriented tasks.

          Show operationStats properties
          • deleteCount number

            Number of delete operations.

          • failedCount number

            Number of failed operations.

          • insertCount number

            Number of insert operations.

          • updateCount number

            Number of update operations.
        • totalProcessedCount number
        • throughputInRecordsPerSecond number

          Throughput in records per second

400

Bad Request

  • application/json object

    Standard error response wrapper containing one or more error details and a trace ID for diagnostics.

    Show application/json properties
    • errors array of objects

      Array of error objects describing what went wrong.

      Show errors properties
      • code string

        Machine-readable error code for programmatic handling.

      • title string

        Brief human-readable summary of the error.

      • detail string

        Detailed explanation of the error and suggested remediation steps.

      • source object

        Identifies the location of the error in the request.

        Show source properties
        • pointer string

          JSON Pointer (RFC 6901) to the field in the request body that caused the error.

        • parameter string

          Name of the query parameter or path parameter that caused the error.
      • status integer

        HTTP status code associated with the error.

        format = int32

    • traceId string

      Unique identifier for this error response, useful for tracking and support inquiries.

404

Not Found

  • application/json object

    Standard error response wrapper containing one or more error details and a trace ID for diagnostics.

    Show application/json properties
    • errors array of objects

      Array of error objects describing what went wrong.

      Show errors properties
      • code string

        Machine-readable error code for programmatic handling.

      • title string

        Brief human-readable summary of the error.

      • detail string

        Detailed explanation of the error and suggested remediation steps.

      • source object

        Identifies the location of the error in the request.

        Show source properties
        • pointer string

          JSON Pointer (RFC 6901) to the field in the request body that caused the error.

        • parameter string

          Name of the query parameter or path parameter that caused the error.
      • status integer

        HTTP status code associated with the error.

        format = int32

    • traceId string

      Unique identifier for this error response, useful for tracking and support inquiries.
GET /api/v1/di-projects/{projectId}/di-tasks/{dataTaskId}/runtime/state/datasets 
import { createQlikApi } from '@qlik/api'


const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})


await qlik.diProjects.getDiProjectDiTaskRuntimeStateDatasets(
  'string',
  'string',
)
qlik di-project di-task runtime state-datasets \
  --di-projectId 'string' \
  --di-taskId 'string'
curl "https://{tenant}.{region}.qlikcloud.com/api/v1/di-projects/{projectId}/di-tasks/{dataTaskId}/runtime/state/datasets" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "datasets": [
    {
      "name": "string",
      "fullLoad": {
        "state": "QUEUED",
        "endTime": "2018-10-30T07:06:22Z",
        "message": "string",
        "duration": "string",
        "fileStats": {
          "volume": "string",
          "processedCount": 42
        },
        "startTime": "2018-10-30T07:06:22Z",
        "cachedChangesCount": 42,
        "failedRecordsCount": 42,
        "totalProcessedCount": 42
      },
      "cdcStatus": {
        "state": "QUEUED",
        "message": "string",
        "ddlCount": 42,
        "deleteCount": 42,
        "insertCount": 42,
        "updateCount": 42,
        "lastProcessed": "2018-10-30T07:06:22Z",
        "totalProcessedCount": 42,
        "incomingChangesCount": 42,
        "unoptimizedRecordsCount": 42
      },
      "datasetId": "string",
      "streaming": {
        "state": "QUEUED",
        "message": "string",
        "lastProcessed": "2018-10-30T07:06:22Z",
        "parseIssueCount": 42,
        "recordsWrittenCount": 42,
        "totalProcessedCount": 42,
        "recordsFilteredCount": 42,
        "unoptimizedRecordsCount": 42
      },
      "sourceName": "string",
      "dataReadiness": "READY",
      "lastBatchOfChanges": {
        "state": "QUEUED",
        "endTime": "2018-10-30T07:06:22Z",
        "message": "string",
        "duration": "string",
        "fileStats": {
          "volume": "string",
          "processedCount": 42
        },
        "startTime": "2018-10-30T07:06:22Z",
        "operationStats": {
          "deleteCount": 42,
          "failedCount": 42,
          "insertCount": 42,
          "updateCount": 42
        },
        "totalProcessedCount": 42,
        "throughputInRecordsPerSecond": 42
      }
    }
  ]
}

Get Action status

Retrieves the status of an asynchronous operation.

Facts

Rate limit Tier 1 (1000 requests per minute)

Query Parameters

  • detailed boolean

    Specifies whether to include detailed status information in the response. Set to true to return detailed information.

    default = false

Path Parameters

  • actionId string
    Required

    Identifier of the action.

Responses

200

OK

  • application/json object
    Show application/json properties
    • name string

      Name of the async operation

    • type string

      Type of action being performed

      Can be one of: "PROJECT_PREPARE""PROJECT_VALIDATE""TASK_PREPARE""TASK_VALIDATE""PROJECT_IMPORT"

    • error object
      Show error properties
      • code string

        Error code

      • details string

        Additional error details

      • message string

        Error message
    • state string

      State of the action

      Can be one of: "PENDING""EXECUTING""COMPLETED""FAILED""CANCELED""SKIPPED"

    • endTime string

      format = "date-time"

    • startTime string

      format = "date-time"

    • taskDetails array of objects
      Show taskDetails properties
      • info string

        Additional details about task state

      • name string
      • error object
        Show error properties
        • code string

          Error code

        • details string

          Additional error details

        • message string

          Error message
      • state string

        State of the action

        Can be one of: "PENDING""EXECUTING""COMPLETED""FAILED""CANCELED""SKIPPED"

      • taskId string
    • taskProgress object
      Show taskProgress properties
      • failed integer

        Number of tasks that failed

      • pending integer

        Number of tasks pending execution

      • skipped integer

        Number of tasks skipped due to conflicts

      • canceled integer

        Number of tasks canceled

      • completed integer

        Number of tasks completed successfully

      • executing integer

        Number of tasks currently executing

404

Action not found

  • application/json object

    Standard error response wrapper containing one or more error details and a trace ID for diagnostics.

    Show application/json properties
    • errors array of objects

      Array of error objects describing what went wrong.

      Show errors properties
      • code string

        Machine-readable error code for programmatic handling.

      • title string

        Brief human-readable summary of the error.

      • detail string

        Detailed explanation of the error and suggested remediation steps.

      • source object

        Identifies the location of the error in the request.

        Show source properties
        • pointer string

          JSON Pointer (RFC 6901) to the field in the request body that caused the error.

        • parameter string

          Name of the query parameter or path parameter that caused the error.
      • status integer

        HTTP status code associated with the error.

        format = int32

    • traceId string

      Unique identifier for this error response, useful for tracking and support inquiries.
GET /api/v1/di-projects/actions/{actionId} 
import { createQlikApi } from '@qlik/api'


const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})


await qlik.diProjects.getDiProject(
  'action-123456',
  {},
)
# qlik-cli has not implemented support for GET /api/v1/di-projects/actions/{actionId} yet.
curl "https://{tenant}.{region}.qlikcloud.com/api/v1/di-projects/actions/{actionId}" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "name": "Prepare project myspace.demoproject",
  "type": "PROJECT_PREPARE",
  "error": {
    "code": "string",
    "details": "string",
    "message": "string"
  },
  "state": "PENDING",
  "endTime": "2018-10-30T07:06:22Z",
  "startTime": "2018-10-30T07:06:22Z",
  "taskDetails": [
    {
      "info": "string",
      "name": "string",
      "error": {
        "code": "string",
        "details": "string",
        "message": "string"
      },
      "state": "PENDING",
      "taskId": "string"
    }
  ],
  "taskProgress": {
    "failed": 42,
    "pending": 42,
    "skipped": 42,
    "canceled": 42,
    "completed": 42,
    "executing": 42
  }
}

Validate project definitions

Validates the project definition files in a .zip and returns a structured report of warnings and errors. The validation runs synchronously and completes before the response is returned. Use this operation before importing with POST /di-projects/{projectId}/actions/import-async to confirm that YAML-based pipeline definitions are correct.

Facts

Rate limit Tier 2 (100 requests per minute)

Request Body

Required

A .zip file containing the project definition files to validate.

  • multipart/form-data object
    Show multipart/form-data properties
    • zip string

      format = "binary"

Responses

200

Validation completed. The response contains a report of warnings and errors found in the project definitions.

  • application/json object
    Show application/json properties
    • reports array of objects

      List of validation findings. An empty array indicates no issues were found.

      Show reports properties
      • path string

        Path to the field or file in the project definition where the issue was found.

      • level string

        Severity of the validation finding. WARNING indicates a potential issue that does not block import; ERROR indicates a critical issue that must be resolved before importing.

        Can be one of: "WARNING""ERROR"

      • reason string

        Human-readable description of the validation finding.

400

Bad Request

  • application/json object

    Standard error response wrapper containing one or more error details and a trace ID for diagnostics.

    Show application/json properties
    • errors array of objects

      Array of error objects describing what went wrong.

      Show errors properties
      • code string

        Machine-readable error code for programmatic handling.

      • title string

        Brief human-readable summary of the error.

      • detail string

        Detailed explanation of the error and suggested remediation steps.

      • source object

        Identifies the location of the error in the request.

        Show source properties
        • pointer string

          JSON Pointer (RFC 6901) to the field in the request body that caused the error.

        • parameter string

          Name of the query parameter or path parameter that caused the error.
      • status integer

        HTTP status code associated with the error.

        format = int32

    • traceId string

      Unique identifier for this error response, useful for tracking and support inquiries.

404

Not Found

  • application/json object

    Standard error response wrapper containing one or more error details and a trace ID for diagnostics.

    Show application/json properties
    • errors array of objects

      Array of error objects describing what went wrong.

      Show errors properties
      • code string

        Machine-readable error code for programmatic handling.

      • title string

        Brief human-readable summary of the error.

      • detail string

        Detailed explanation of the error and suggested remediation steps.

      • source object

        Identifies the location of the error in the request.

        Show source properties
        • pointer string

          JSON Pointer (RFC 6901) to the field in the request body that caused the error.

        • parameter string

          Name of the query parameter or path parameter that caused the error.
      • status integer

        HTTP status code associated with the error.

        format = int32

    • traceId string

      Unique identifier for this error response, useful for tracking and support inquiries.

500

Internal Server Error

  • application/json object

    Standard error response wrapper containing one or more error details and a trace ID for diagnostics.

    Show application/json properties
    • errors array of objects

      Array of error objects describing what went wrong.

      Show errors properties
      • code string

        Machine-readable error code for programmatic handling.

      • title string

        Brief human-readable summary of the error.

      • detail string

        Detailed explanation of the error and suggested remediation steps.

      • source object

        Identifies the location of the error in the request.

        Show source properties
        • pointer string

          JSON Pointer (RFC 6901) to the field in the request body that caused the error.

        • parameter string

          Name of the query parameter or path parameter that caused the error.
      • status integer

        HTTP status code associated with the error.

        format = int32

    • traceId string

      Unique identifier for this error response, useful for tracking and support inquiries.
POST /api/v1/di-projects/utils/actions/validate-project-definitions 
import { createQlikApi } from '@qlik/api'
import { readFileSync } from 'node:fs'


const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})


await qlik.diProjects.validateProjectDefinitions({
  zip: new Uint8Array(
    readFileSync('<file-path>'),
  ),
})
qlik di-project util validate-project-definitions
curl "https://{tenant}.{region}.qlikcloud.com/api/v1/di-projects/utils/actions/validate-project-definitions" \
-X POST \
-H "Content-type: multipart/form-data" \
-H "Authorization: Bearer <access_token>" \
-F "zip=@/path/to/file"

Example Response

{
  "reports": [
    {
      "path": "string",
      "level": "WARNING",
      "reason": "string"
    }
  ]
}