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

    Warning

    Exported ZIP files are deployment artifacts. Their contents are not intended to be edited or inspected.
    To create or edit a project, use the Qlik Cloud UI.

  • 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

  • spaceIdstring

    Filter by space id

Responses

200

OK

  • application/jsonobject
    Show application/json properties
    • projectsarray of objects
      Show projects properties
      • idstring
      • namestring
      • typestring

        The type of the project

        Can be one of: "DATA_PIPELINE""DATA_MOVEMENT"

      • ownerIdstring
      • spaceIdstring
      • descriptionstring
      • platformTypestring

        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/jsonobject

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

    Show application/json properties
    • errorsarray of objects

      Array of error objects describing what went wrong.

      Show errors properties
      • codestring

        Machine-readable error code for programmatic handling.

      • titlestring

        Brief human-readable summary of the error.

      • detailstring

        Detailed explanation of the error and suggested remediation steps.

      • sourceobject

        Identifies the location of the error in the request.

        Show source properties
        • pointerstring

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

        • parameterstring

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

        HTTP status code associated with the error.

        format = int32

    • traceIdstring

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

404

Not Found

  • application/jsonobject

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

    Show application/json properties
    • errorsarray of objects

      Array of error objects describing what went wrong.

      Show errors properties
      • codestring

        Machine-readable error code for programmatic handling.

      • titlestring

        Brief human-readable summary of the error.

      • detailstring

        Detailed explanation of the error and suggested remediation steps.

      • sourceobject

        Identifies the location of the error in the request.

        Show source properties
        • pointerstring

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

        • parameterstring

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

        HTTP status code associated with the error.

        format = int32

    • traceIdstring

      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/jsonobject
    Show application/json properties
    • namestring

      The name of the project

    • typestring

      The type of the project

      Can be one of: "DATA_PIPELINE""DATA_MOVEMENT"

    • spacestring

      The ID of the space where the project will be created

    • descriptionstring

      A description of the project

    • platformTypestring

      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"

    • platformConnectionstring

      The platform connection string

    • cloudStagingConnectionstring

      The cloud staging connection string

Responses

201

Created

  • application/jsonobject
    Show application/json properties
    • idstring
    • namestring
    • typestring

      The type of the project

      Can be one of: "DATA_PIPELINE""DATA_MOVEMENT"

    • ownerIdstring
    • spaceIdstring
    • descriptionstring
    • platformTypestring

      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/jsonobject

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

    Show application/json properties
    • errorsarray of objects

      Array of error objects describing what went wrong.

      Show errors properties
      • codestring

        Machine-readable error code for programmatic handling.

      • titlestring

        Brief human-readable summary of the error.

      • detailstring

        Detailed explanation of the error and suggested remediation steps.

      • sourceobject

        Identifies the location of the error in the request.

        Show source properties
        • pointerstring

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

        • parameterstring

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

        HTTP status code associated with the error.

        format = int32

    • traceIdstring

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

500

Internal Server Error

  • application/jsonobject

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

    Show application/json properties
    • errorsarray of objects

      Array of error objects describing what went wrong.

      Show errors properties
      • codestring

        Machine-readable error code for programmatic handling.

      • titlestring

        Brief human-readable summary of the error.

      • detailstring

        Detailed explanation of the error and suggested remediation steps.

      • sourceobject

        Identifies the location of the error in the request.

        Show source properties
        • pointerstring

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

        • parameterstring

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

        HTTP status code associated with the error.

        format = int32

    • traceIdstring

      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

  • projectIdstring
    Required

    Identifier of the data project.

Responses

200

OK

  • application/jsonobject
    Show application/json properties
    • idstring
    • namestring
    • typestring

      The type of the project

      Can be one of: "DATA_PIPELINE""DATA_MOVEMENT"

    • ownerIdstring
    • spaceIdstring
    • descriptionstring
    • platformTypestring

      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/jsonobject

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

    Show application/json properties
    • errorsarray of objects

      Array of error objects describing what went wrong.

      Show errors properties
      • codestring

        Machine-readable error code for programmatic handling.

      • titlestring

        Brief human-readable summary of the error.

      • detailstring

        Detailed explanation of the error and suggested remediation steps.

      • sourceobject

        Identifies the location of the error in the request.

        Show source properties
        • pointerstring

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

        • parameterstring

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

        HTTP status code associated with the error.

        format = int32

    • traceIdstring

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

404

Not Found

  • application/jsonobject

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

    Show application/json properties
    • errorsarray of objects

      Array of error objects describing what went wrong.

      Show errors properties
      • codestring

        Machine-readable error code for programmatic handling.

      • titlestring

        Brief human-readable summary of the error.

      • detailstring

        Detailed explanation of the error and suggested remediation steps.

      • sourceobject

        Identifies the location of the error in the request.

        Show source properties
        • pointerstring

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

        • parameterstring

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

        HTTP status code associated with the error.

        format = int32

    • traceIdstring

      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

  • Acceptstring

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

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

Path Parameters

  • projectIdstring
    Required

    Identifier of the data project.

Request Body

Options for the export process

  • application/jsonobject
    Show application/json properties
    • modestring

      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"

    • includeBindingsboolean

      Include bindings in the exported zip file (optional, default is false)

Responses

200

OK

  • application/octet-streamstring

    format = "binary"

400

Bad Request

  • application/jsonobject

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

    Show application/json properties
    • errorsarray of objects

      Array of error objects describing what went wrong.

      Show errors properties
      • codestring

        Machine-readable error code for programmatic handling.

      • titlestring

        Brief human-readable summary of the error.

      • detailstring

        Detailed explanation of the error and suggested remediation steps.

      • sourceobject

        Identifies the location of the error in the request.

        Show source properties
        • pointerstring

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

        • parameterstring

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

        HTTP status code associated with the error.

        format = int32

    • traceIdstring

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

404

Not Found

  • application/jsonobject

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

    Show application/json properties
    • errorsarray of objects

      Array of error objects describing what went wrong.

      Show errors properties
      • codestring

        Machine-readable error code for programmatic handling.

      • titlestring

        Brief human-readable summary of the error.

      • detailstring

        Detailed explanation of the error and suggested remediation steps.

      • sourceobject

        Identifies the location of the error in the request.

        Show source properties
        • pointerstring

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

        • parameterstring

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

        HTTP status code associated with the error.

        format = int32

    • traceIdstring

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

500

Internal Server Error

  • application/jsonobject

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

    Show application/json properties
    • errorsarray of objects

      Array of error objects describing what went wrong.

      Show errors properties
      • codestring

        Machine-readable error code for programmatic handling.

      • titlestring

        Brief human-readable summary of the error.

      • detailstring

        Detailed explanation of the error and suggested remediation steps.

      • sourceobject

        Identifies the location of the error in the request.

        Show source properties
        • pointerstring

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

        • parameterstring

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

        HTTP status code associated with the error.

        format = int32

    • traceIdstring

      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',
  {},
)
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

Imports a data integration project from a .zip file.

Facts

Rate limit Tier 2 (100 requests per minute)

Path Parameters

  • projectIdstring
    Required

    Identifier of the data project.

Request Body

Required

The ZIP file containing the project to import

  • multipart/form-dataobject
    Show multipart/form-data properties
    • zipstring

      format = "binary"

Responses

200

OK

  • application/jsonobject

400

Bad Request

  • application/jsonobject

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

    Show application/json properties
    • errorsarray of objects

      Array of error objects describing what went wrong.

      Show errors properties
      • codestring

        Machine-readable error code for programmatic handling.

      • titlestring

        Brief human-readable summary of the error.

      • detailstring

        Detailed explanation of the error and suggested remediation steps.

      • sourceobject

        Identifies the location of the error in the request.

        Show source properties
        • pointerstring

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

        • parameterstring

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

        HTTP status code associated with the error.

        format = int32

    • traceIdstring

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

404

Not Found

  • application/jsonobject

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

    Show application/json properties
    • errorsarray of objects

      Array of error objects describing what went wrong.

      Show errors properties
      • codestring

        Machine-readable error code for programmatic handling.

      • titlestring

        Brief human-readable summary of the error.

      • detailstring

        Detailed explanation of the error and suggested remediation steps.

      • sourceobject

        Identifies the location of the error in the request.

        Show source properties
        • pointerstring

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

        • parameterstring

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

        HTTP status code associated with the error.

        format = int32

    • traceIdstring

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

500

Internal Server Error

  • application/jsonobject

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

    Show application/json properties
    • errorsarray of objects

      Array of error objects describing what went wrong.

      Show errors properties
      • codestring

        Machine-readable error code for programmatic handling.

      • titlestring

        Brief human-readable summary of the error.

      • detailstring

        Detailed explanation of the error and suggested remediation steps.

      • sourceobject

        Identifies the location of the error in the request.

        Show source properties
        • pointerstring

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

        • parameterstring

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

        HTTP status code associated with the error.

        format = int32

    • traceIdstring

      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

{}

Prepare a project

Prepares the data integration project and its tasks for execution.

Facts

Rate limit Tier 2 (100 requests per minute)

Path Parameters

  • projectIdstring
    Required

    Identifier of the data project.

Request Body

Required
  • application/jsonobject
    Show application/json properties
    • allowRecreateboolean

      default = false

    • selectedTasksarray 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
      • taskIdstring
        Required

        Task identifier

Responses

202

Preparation started

  • application/jsonobject
    Show application/json properties
    • actionIdstring
      Required

      Identifier for tracking the action

400

Invalid request

  • application/jsonobject

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

    Show application/json properties
    • errorsarray of objects

      Array of error objects describing what went wrong.

      Show errors properties
      • codestring

        Machine-readable error code for programmatic handling.

      • titlestring

        Brief human-readable summary of the error.

      • detailstring

        Detailed explanation of the error and suggested remediation steps.

      • sourceobject

        Identifies the location of the error in the request.

        Show source properties
        • pointerstring

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

        • parameterstring

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

        HTTP status code associated with the error.

        format = int32

    • traceIdstring

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

404

Project not found

  • application/jsonobject

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

    Show application/json properties
    • errorsarray of objects

      Array of error objects describing what went wrong.

      Show errors properties
      • codestring

        Machine-readable error code for programmatic handling.

      • titlestring

        Brief human-readable summary of the error.

      • detailstring

        Detailed explanation of the error and suggested remediation steps.

      • sourceobject

        Identifies the location of the error in the request.

        Show source properties
        • pointerstring

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

        • parameterstring

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

        HTTP status code associated with the error.

        format = int32

    • traceIdstring

      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

  • projectIdstring
    Required

    Identifier of the data project.

Request Body

Required
  • application/jsonobject
    Show application/json properties
    • selectedTasksarray 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
      • taskIdstring
        Required

        Task identifier

Responses

202

Validation started

  • application/jsonobject
    Show application/json properties
    • actionIdstring
      Required

      Identifier for tracking the action

400

Invalid request

  • application/jsonobject

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

    Show application/json properties
    • errorsarray of objects

      Array of error objects describing what went wrong.

      Show errors properties
      • codestring

        Machine-readable error code for programmatic handling.

      • titlestring

        Brief human-readable summary of the error.

      • detailstring

        Detailed explanation of the error and suggested remediation steps.

      • sourceobject

        Identifies the location of the error in the request.

        Show source properties
        • pointerstring

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

        • parameterstring

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

        HTTP status code associated with the error.

        format = int32

    • traceIdstring

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

404

Project not found

  • application/jsonobject

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

    Show application/json properties
    • errorsarray of objects

      Array of error objects describing what went wrong.

      Show errors properties
      • codestring

        Machine-readable error code for programmatic handling.

      • titlestring

        Brief human-readable summary of the error.

      • detailstring

        Detailed explanation of the error and suggested remediation steps.

      • sourceobject

        Identifies the location of the error in the request.

        Show source properties
        • pointerstring

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

        • parameterstring

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

        HTTP status code associated with the error.

        format = int32

    • traceIdstring

      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

  • recalculateboolean

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

    default = true

Path Parameters

  • projectIdstring
    Required

    Identifier of the data project.

Responses

200

OK

  • application/jsonobject
    Show application/json properties
    • variablesobject

      additional properties

    • nameToIdMapobject

      additional properties

400

Bad Request

  • application/jsonobject

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

    Show application/json properties
    • errorsarray of objects

      Array of error objects describing what went wrong.

      Show errors properties
      • codestring

        Machine-readable error code for programmatic handling.

      • titlestring

        Brief human-readable summary of the error.

      • detailstring

        Detailed explanation of the error and suggested remediation steps.

      • sourceobject

        Identifies the location of the error in the request.

        Show source properties
        • pointerstring

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

        • parameterstring

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

        HTTP status code associated with the error.

        format = int32

    • traceIdstring

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

404

Not Found

  • application/jsonobject

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

    Show application/json properties
    • errorsarray of objects

      Array of error objects describing what went wrong.

      Show errors properties
      • codestring

        Machine-readable error code for programmatic handling.

      • titlestring

        Brief human-readable summary of the error.

      • detailstring

        Detailed explanation of the error and suggested remediation steps.

      • sourceobject

        Identifies the location of the error in the request.

        Show source properties
        • pointerstring

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

        • parameterstring

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

        HTTP status code associated with the error.

        format = int32

    • traceIdstring

      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

  • projectIdstring
    Required

    Identifier of the data project.

Request Body

Required

The details of the export variables to update

  • application/jsonobject
    Show application/json properties
    • variablesobject

      additional properties

Responses

200

OK

  • application/jsonobject

400

Bad Request

  • application/jsonobject

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

    Show application/json properties
    • errorsarray of objects

      Array of error objects describing what went wrong.

      Show errors properties
      • codestring

        Machine-readable error code for programmatic handling.

      • titlestring

        Brief human-readable summary of the error.

      • detailstring

        Detailed explanation of the error and suggested remediation steps.

      • sourceobject

        Identifies the location of the error in the request.

        Show source properties
        • pointerstring

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

        • parameterstring

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

        HTTP status code associated with the error.

        format = int32

    • traceIdstring

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

404

Not Found

  • application/jsonobject

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

    Show application/json properties
    • errorsarray of objects

      Array of error objects describing what went wrong.

      Show errors properties
      • codestring

        Machine-readable error code for programmatic handling.

      • titlestring

        Brief human-readable summary of the error.

      • detailstring

        Detailed explanation of the error and suggested remediation steps.

      • sourceobject

        Identifies the location of the error in the request.

        Show source properties
        • pointerstring

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

        • parameterstring

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

        HTTP status code associated with the error.

        format = int32

    • traceIdstring

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

500

Internal Server Error

  • application/jsonobject

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

    Show application/json properties
    • errorsarray of objects

      Array of error objects describing what went wrong.

      Show errors properties
      • codestring

        Machine-readable error code for programmatic handling.

      • titlestring

        Brief human-readable summary of the error.

      • detailstring

        Detailed explanation of the error and suggested remediation steps.

      • sourceobject

        Identifies the location of the error in the request.

        Show source properties
        • pointerstring

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

        • parameterstring

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

        HTTP status code associated with the error.

        format = int32

    • traceIdstring

      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

  • projectIdstring
    Required

    Identifier of the data project.

Responses

200

OK

  • application/jsonobject
    Show application/json properties
    • dataTasksarray of objects
      Show dataTasks properties
      • idstring
      • namestring
      • typestring

        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"

      • ownerIdstring
      • spaceIdstring
      • descriptionstring

400

Bad Request

  • application/jsonobject

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

    Show application/json properties
    • errorsarray of objects

      Array of error objects describing what went wrong.

      Show errors properties
      • codestring

        Machine-readable error code for programmatic handling.

      • titlestring

        Brief human-readable summary of the error.

      • detailstring

        Detailed explanation of the error and suggested remediation steps.

      • sourceobject

        Identifies the location of the error in the request.

        Show source properties
        • pointerstring

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

        • parameterstring

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

        HTTP status code associated with the error.

        format = int32

    • traceIdstring

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

404

Not Found

  • application/jsonobject

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

    Show application/json properties
    • errorsarray of objects

      Array of error objects describing what went wrong.

      Show errors properties
      • codestring

        Machine-readable error code for programmatic handling.

      • titlestring

        Brief human-readable summary of the error.

      • detailstring

        Detailed explanation of the error and suggested remediation steps.

      • sourceobject

        Identifies the location of the error in the request.

        Show source properties
        • pointerstring

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

        • parameterstring

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

        HTTP status code associated with the error.

        format = int32

    • traceIdstring

      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

  • dataTaskIdstring
    Required

    Identifier of the data task.

  • projectIdstring
    Required

    Identifier of the data project.

Responses

200

OK

  • application/jsonobject
    Show application/json properties
    • idstring
    • namestring
    • typestring

      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"

    • ownerIdstring
    • spaceIdstring
    • descriptionstring

400

Bad Request

  • application/jsonobject

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

    Show application/json properties
    • errorsarray of objects

      Array of error objects describing what went wrong.

      Show errors properties
      • codestring

        Machine-readable error code for programmatic handling.

      • titlestring

        Brief human-readable summary of the error.

      • detailstring

        Detailed explanation of the error and suggested remediation steps.

      • sourceobject

        Identifies the location of the error in the request.

        Show source properties
        • pointerstring

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

        • parameterstring

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

        HTTP status code associated with the error.

        format = int32

    • traceIdstring

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

404

Not Found

  • application/jsonobject

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

    Show application/json properties
    • errorsarray of objects

      Array of error objects describing what went wrong.

      Show errors properties
      • codestring

        Machine-readable error code for programmatic handling.

      • titlestring

        Brief human-readable summary of the error.

      • detailstring

        Detailed explanation of the error and suggested remediation steps.

      • sourceobject

        Identifies the location of the error in the request.

        Show source properties
        • pointerstring

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

        • parameterstring

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

        HTTP status code associated with the error.

        format = int32

    • traceIdstring

      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

  • dataTaskIdstring
    Required

    Identifier of the data task.

  • projectIdstring
    Required

    Identifier of the data project.

Request Body

  • application/jsonobject
    Show application/json properties
    • allowRecreateboolean
      Required

      Allow recreation of existing artifacts

      default = false

Responses

202

Preparation started

  • application/jsonobject
    Show application/json properties
    • actionIdstring
      Required

      Identifier for tracking the action

400

Invalid request

  • application/jsonobject

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

    Show application/json properties
    • errorsarray of objects

      Array of error objects describing what went wrong.

      Show errors properties
      • codestring

        Machine-readable error code for programmatic handling.

      • titlestring

        Brief human-readable summary of the error.

      • detailstring

        Detailed explanation of the error and suggested remediation steps.

      • sourceobject

        Identifies the location of the error in the request.

        Show source properties
        • pointerstring

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

        • parameterstring

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

        HTTP status code associated with the error.

        format = int32

    • traceIdstring

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

404

Task not found

  • application/jsonobject

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

    Show application/json properties
    • errorsarray of objects

      Array of error objects describing what went wrong.

      Show errors properties
      • codestring

        Machine-readable error code for programmatic handling.

      • titlestring

        Brief human-readable summary of the error.

      • detailstring

        Detailed explanation of the error and suggested remediation steps.

      • sourceobject

        Identifies the location of the error in the request.

        Show source properties
        • pointerstring

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

        • parameterstring

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

        HTTP status code associated with the error.

        format = int32

    • traceIdstring

      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

  • dataTaskIdstring
    Required

    Identifier of the data task.

  • projectIdstring
    Required

    Identifier of the data project.

Request Body

  • application/jsonobject

    Request body to recreate task datasets.

Responses

202

Started recreating datasets

  • application/jsonobject
    Show application/json properties
    • actionIdstring
      Required

      Identifier for tracking the action

400

Invalid request

  • application/jsonobject

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

    Show application/json properties
    • errorsarray of objects

      Array of error objects describing what went wrong.

      Show errors properties
      • codestring

        Machine-readable error code for programmatic handling.

      • titlestring

        Brief human-readable summary of the error.

      • detailstring

        Detailed explanation of the error and suggested remediation steps.

      • sourceobject

        Identifies the location of the error in the request.

        Show source properties
        • pointerstring

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

        • parameterstring

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

        HTTP status code associated with the error.

        format = int32

    • traceIdstring

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

404

Task or project not found

  • application/jsonobject

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

    Show application/json properties
    • errorsarray of objects

      Array of error objects describing what went wrong.

      Show errors properties
      • codestring

        Machine-readable error code for programmatic handling.

      • titlestring

        Brief human-readable summary of the error.

      • detailstring

        Detailed explanation of the error and suggested remediation steps.

      • sourceobject

        Identifies the location of the error in the request.

        Show source properties
        • pointerstring

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

        • parameterstring

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

        HTTP status code associated with the error.

        format = int32

    • traceIdstring

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


const response = await fetch(
  '/api/v1/di-projects/{projectId}/di-tasks/{dataTaskId}/actions/recreate-datasets',
  {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({}),
  },
)
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

  • dataTaskIdstring
    Required

    Identifier of the data task.

  • projectIdstring
    Required

    Identifier of the data project.

Request Body

Required
  • application/jsonobject
    Show application/json properties
    • reloadStrategystring

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

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

    • selectedDatasetsarray of objects

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

      Show selectedDatasets properties
      • datasetIdstring

Responses

200

Reload request registered.

  • application/jsonobject

    Indicates whether the reload request was registered successfully.

    Show application/json properties
    • successboolean
      Required

      Always true when the server successfully registers the request.

400

Bad Request

  • application/jsonobject

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

    Show application/json properties
    • errorsarray of objects

      Array of error objects describing what went wrong.

      Show errors properties
      • codestring

        Machine-readable error code for programmatic handling.

      • titlestring

        Brief human-readable summary of the error.

      • detailstring

        Detailed explanation of the error and suggested remediation steps.

      • sourceobject

        Identifies the location of the error in the request.

        Show source properties
        • pointerstring

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

        • parameterstring

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

        HTTP status code associated with the error.

        format = int32

    • traceIdstring

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

404

Not Found

  • application/jsonobject

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

    Show application/json properties
    • errorsarray of objects

      Array of error objects describing what went wrong.

      Show errors properties
      • codestring

        Machine-readable error code for programmatic handling.

      • titlestring

        Brief human-readable summary of the error.

      • detailstring

        Detailed explanation of the error and suggested remediation steps.

      • sourceobject

        Identifies the location of the error in the request.

        Show source properties
        • pointerstring

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

        • parameterstring

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

        HTTP status code associated with the error.

        format = int32

    • traceIdstring

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


const response = await fetch(
  '/api/v1/di-projects/{projectId}/di-tasks/{dataTaskId}/actions/request-reload',
  {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      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

  • dataTaskIdstring
    Required

    Identifier of the data task.

  • projectIdstring
    Required

    Identifier of the data project.

Request Body

  • application/jsonobject

    Request body for task validation

Responses

202

Validation started

  • application/jsonobject
    Show application/json properties
    • actionIdstring
      Required

      Identifier for tracking the action

400

Invalid request

  • application/jsonobject

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

    Show application/json properties
    • errorsarray of objects

      Array of error objects describing what went wrong.

      Show errors properties
      • codestring

        Machine-readable error code for programmatic handling.

      • titlestring

        Brief human-readable summary of the error.

      • detailstring

        Detailed explanation of the error and suggested remediation steps.

      • sourceobject

        Identifies the location of the error in the request.

        Show source properties
        • pointerstring

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

        • parameterstring

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

        HTTP status code associated with the error.

        format = int32

    • traceIdstring

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

404

Task not found

  • application/jsonobject

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

    Show application/json properties
    • errorsarray of objects

      Array of error objects describing what went wrong.

      Show errors properties
      • codestring

        Machine-readable error code for programmatic handling.

      • titlestring

        Brief human-readable summary of the error.

      • detailstring

        Detailed explanation of the error and suggested remediation steps.

      • sourceobject

        Identifies the location of the error in the request.

        Show source properties
        • pointerstring

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

        • parameterstring

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

        HTTP status code associated with the error.

        format = int32

    • traceIdstring

      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

  • dataTaskIdstring
    Required

    Identifier of the data task.

  • projectIdstring
    Required

    Identifier of the data project.

Request Body

  • application/jsonobject
    Show application/json properties
    • optionstring

      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"

    • processChangesFromstring

      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/jsonobject

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

    Show application/json properties
    • errorsarray of objects

      Array of error objects describing what went wrong.

      Show errors properties
      • codestring

        Machine-readable error code for programmatic handling.

      • titlestring

        Brief human-readable summary of the error.

      • detailstring

        Detailed explanation of the error and suggested remediation steps.

      • sourceobject

        Identifies the location of the error in the request.

        Show source properties
        • pointerstring

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

        • parameterstring

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

        HTTP status code associated with the error.

        format = int32

    • traceIdstring

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

404

Not Found

  • application/jsonobject

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

    Show application/json properties
    • errorsarray of objects

      Array of error objects describing what went wrong.

      Show errors properties
      • codestring

        Machine-readable error code for programmatic handling.

      • titlestring

        Brief human-readable summary of the error.

      • detailstring

        Detailed explanation of the error and suggested remediation steps.

      • sourceobject

        Identifies the location of the error in the request.

        Show source properties
        • pointerstring

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

        • parameterstring

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

        HTTP status code associated with the error.

        format = int32

    • traceIdstring

      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

  • dataTaskIdstring
    Required

    Identifier of the data task.

  • projectIdstring
    Required

    Identifier of the data project.

Responses

204

NO CONTENT

400

Bad Request

  • application/jsonobject

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

    Show application/json properties
    • errorsarray of objects

      Array of error objects describing what went wrong.

      Show errors properties
      • codestring

        Machine-readable error code for programmatic handling.

      • titlestring

        Brief human-readable summary of the error.

      • detailstring

        Detailed explanation of the error and suggested remediation steps.

      • sourceobject

        Identifies the location of the error in the request.

        Show source properties
        • pointerstring

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

        • parameterstring

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

        HTTP status code associated with the error.

        format = int32

    • traceIdstring

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

404

Not Found

  • application/jsonobject

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

    Show application/json properties
    • errorsarray of objects

      Array of error objects describing what went wrong.

      Show errors properties
      • codestring

        Machine-readable error code for programmatic handling.

      • titlestring

        Brief human-readable summary of the error.

      • detailstring

        Detailed explanation of the error and suggested remediation steps.

      • sourceobject

        Identifies the location of the error in the request.

        Show source properties
        • pointerstring

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

        • parameterstring

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

        HTTP status code associated with the error.

        format = int32

    • traceIdstring

      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 run 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

  • dataTaskIdstring
    Required

    Identifier of the data task.

  • projectIdstring
    Required

    Identifier of the data project.

  • runIdstring
    Required

    Identifier of the run instance.

Responses

200

Run execution state retrieved successfully.

  • application/jsonobject

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

    Show application/json properties
    • namestring

      Name of the data task

    • typestring

      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"

    • lastRunobject

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

      Show lastRun properties
      • statestring

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

      • errorsarray of objects

        List of errors encountered during the last run

        Show errors properties
        • codestring

          Machine-readable error code for programmatic handling.

        • titlestring

          Brief human-readable summary of the error.

        • detailstring

          Detailed explanation of the error and suggested remediation steps.

        • sourceobject

          Identifies the location of the error in the request.

          Show source properties
          • pointerstring

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

          • parameterstring

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

          HTTP status code associated with the error.

          format = int32

      • endTimestring

        Timestamp indicating when the task instance ended

        format = "date-time"

      • generalobject

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

        Show general properties
        • gatewayIdstring

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

        • gatewayNamestring

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

        • datasetCountnumber

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

        • gatewayTaskNamestring

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

        • dataTaskUpdatedTostring

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

          format = "date-time"

        • lakehouseClusterIdstring

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

        • liveViewsUpdatedTostring

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

          format = "date-time"

        • datasetsInErrorCountnumber

          Count of datasets that encountered errors

        • lakehouseClusterNamestring

          For lakehouse storage tasks, this is the name of the cluster where the task runs
      • messagestring
      • traceIdstring

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

      • durationstring

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

      • fullLoadobject

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

        Show fullLoad properties
        • errorCountnumber

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

        • queuedCountnumber

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

        • loadingCountnumber

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

        • completedCountnumber

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

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

        Show cdcStatus properties
        • latencystring

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

        • totalProcessedCountnumber
        • applyingChangesCountnumber
        • incomingChangesCountnumber

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

        • accumulatingChangesCountnumber
        • throughputInKilobytesPerSecondnumber

          Throughput in kilobytes per second
      • startTimestring

        Timestamp indicating when the task instance started

        format = "date-time"

      • streamingobject

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

        Show streaming properties
        • latencystring

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

        • errorCountnumber

          Number of streaming datasets that have encountered errors

        • queuedCountnumber

          Number of streaming datasets that are queued

        • runningCountnumber

          Number of streaming datasets that are currently running

        • totalProcessedCountnumber

          Total number of records processed
      • lastBatchOfChangesobject

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

        Show lastBatchOfChanges properties
        • relatesToRecordsTostring

          This batch ends with operational source changes from this time.

          format = "date-time"

        • totalProcessedCountnumber
        • relatesToRecordsFromstring

          This batch starts with operational source changes from this time.

          format = "date-time"

        • throughputInRecordsPerSecondnumber

          Throughput in records per second
    • runReadinessobject
      Show runReadiness properties
      • statestring

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

      • messagestring

400

Invalid request or missing parameters.

  • application/jsonobject

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

    Show application/json properties
    • errorsarray of objects

      Array of error objects describing what went wrong.

      Show errors properties
      • codestring

        Machine-readable error code for programmatic handling.

      • titlestring

        Brief human-readable summary of the error.

      • detailstring

        Detailed explanation of the error and suggested remediation steps.

      • sourceobject

        Identifies the location of the error in the request.

        Show source properties
        • pointerstring

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

        • parameterstring

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

        HTTP status code associated with the error.

        format = int32

    • traceIdstring

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

404

Task run not found.

  • application/jsonobject

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

    Show application/json properties
    • errorsarray of objects

      Array of error objects describing what went wrong.

      Show errors properties
      • codestring

        Machine-readable error code for programmatic handling.

      • titlestring

        Brief human-readable summary of the error.

      • detailstring

        Detailed explanation of the error and suggested remediation steps.

      • sourceobject

        Identifies the location of the error in the request.

        Show source properties
        • pointerstring

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

        • parameterstring

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

        HTTP status code associated with the error.

        format = int32

    • traceIdstring

      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 
// qlik-api has not implemented support for `GET /api/v1/di-projects/{projectId}/di-tasks/{dataTaskId}/runtime/runs/{runId}/state` yet.
// In the meantime, you can use fetch like this:


const response = await fetch(
  '/api/v1/di-projects/{projectId}/di-tasks/{dataTaskId}/runtime/runs/{runId}/state',
  {
    method: 'GET',
    headers: {
      'Content-Type': 'application/json',
    },
  },
)
# qlik-cli has not implemented support for GET /api/v1/di-projects/{projectId}/di-tasks/{dataTaskId}/runtime/runs/{runId}/state yet.
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 run dataset 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

  • dataTaskIdstring
    Required

    Identifier of the data task.

  • projectIdstring
    Required

    Identifier of the data project.

  • runIdstring
    Required

    Identifier of the run instance.

Responses

200

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

  • application/jsonobject
    Show application/json properties
    • datasetsarray of objects

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

      Show datasets properties
      • namestring

        Name of the dataset

      • fullLoadobject
        Show fullLoad properties
        • statestring

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

        • endTimestring

          format = "date-time"

        • messagestring
        • durationstring

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

        • fileStatsobject

          Statistics for file-based tasks.

          Show fileStats properties
          • volumestring

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

          • processedCountnumber

            Number of files processed.
        • startTimestring

          format = "date-time"

        • cachedChangesCountnumber

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

        • failedRecordsCountnumber

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

        • totalProcessedCountnumber

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

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

        Show cdcStatus properties
        • statestring

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

        • messagestring
        • ddlCountnumber

          Number of DDL statements executed during the last run

        • deleteCountnumber

          delete portion of totalProcessedCount. Only available for some task types

        • insertCountnumber

          Insert portion of totalProcessedCount. Only available for some task types

        • updateCountnumber

          update portion of totalProcessedCount. Only available for some task types

        • lastProcessedstring

          format = "date-time"

        • totalProcessedCountnumber

          Total number of changes/DMLs applied to the dataset

        • incomingChangesCountnumber

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

        • unoptimizedRecordsCountnumber

          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.
      • datasetIdstring

        Id of the dataset

      • streamingobject

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

        Show streaming properties
        • statestring

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

        • messagestring
        • lastProcessedstring

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

          format = "date-time"

        • parseIssueCountnumber

          Number of records that had parsing issues

        • recordsWrittenCountnumber

          Total number of records written to the dataset

        • totalProcessedCountnumber

          Total number of processed changes for the dataset

        • recordsFilteredCountnumber

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

        • unoptimizedRecordsCountnumber

          Queryable records pending merge into optimized Iceberg partitions.
      • sourceNamestring

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

      • dataReadinessstring

        Is the data ready for use?

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

      • lastBatchOfChangesobject
        Show lastBatchOfChanges properties
        • statestring

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

        • endTimestring

          format = "date-time"

        • messagestring
        • durationstring

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

        • fileStatsobject

          Statistics for file-based tasks.

          Show fileStats properties
          • volumestring

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

          • processedCountnumber

            Number of files processed.
        • startTimestring

          format = "date-time"

        • operationStatsobject

          Breakdown of operations for record-oriented tasks.

          Show operationStats properties
          • deleteCountnumber

            Number of delete operations.

          • failedCountnumber

            Number of failed operations.

          • insertCountnumber

            Number of insert operations.

          • updateCountnumber

            Number of update operations.
        • totalProcessedCountnumber
        • throughputInRecordsPerSecondnumber

          Throughput in records per second

400

Invalid request or missing parameters.

  • application/jsonobject

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

    Show application/json properties
    • errorsarray of objects

      Array of error objects describing what went wrong.

      Show errors properties
      • codestring

        Machine-readable error code for programmatic handling.

      • titlestring

        Brief human-readable summary of the error.

      • detailstring

        Detailed explanation of the error and suggested remediation steps.

      • sourceobject

        Identifies the location of the error in the request.

        Show source properties
        • pointerstring

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

        • parameterstring

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

        HTTP status code associated with the error.

        format = int32

    • traceIdstring

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

404

Task run not found.

  • application/jsonobject

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

    Show application/json properties
    • errorsarray of objects

      Array of error objects describing what went wrong.

      Show errors properties
      • codestring

        Machine-readable error code for programmatic handling.

      • titlestring

        Brief human-readable summary of the error.

      • detailstring

        Detailed explanation of the error and suggested remediation steps.

      • sourceobject

        Identifies the location of the error in the request.

        Show source properties
        • pointerstring

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

        • parameterstring

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

        HTTP status code associated with the error.

        format = int32

    • traceIdstring

      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/jsonobject

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

    Show application/json properties
    • errorsarray of objects

      Array of error objects describing what went wrong.

      Show errors properties
      • codestring

        Machine-readable error code for programmatic handling.

      • titlestring

        Brief human-readable summary of the error.

      • detailstring

        Detailed explanation of the error and suggested remediation steps.

      • sourceobject

        Identifies the location of the error in the request.

        Show source properties
        • pointerstring

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

        • parameterstring

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

        HTTP status code associated with the error.

        format = int32

    • traceIdstring

      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/jsonobject

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

    Show application/json properties
    • errorsarray of objects

      Array of error objects describing what went wrong.

      Show errors properties
      • codestring

        Machine-readable error code for programmatic handling.

      • titlestring

        Brief human-readable summary of the error.

      • detailstring

        Detailed explanation of the error and suggested remediation steps.

      • sourceobject

        Identifies the location of the error in the request.

        Show source properties
        • pointerstring

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

        • parameterstring

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

        HTTP status code associated with the error.

        format = int32

    • traceIdstring

      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 
// qlik-api has not implemented support for `GET /api/v1/di-projects/{projectId}/di-tasks/{dataTaskId}/runtime/runs/{runId}/state/datasets` yet.
// In the meantime, you can use fetch like this:


const response = await fetch(
  '/api/v1/di-projects/{projectId}/di-tasks/{dataTaskId}/runtime/runs/{runId}/state/datasets',
  {
    method: 'GET',
    headers: {
      'Content-Type': 'application/json',
    },
  },
)
# qlik-cli has not implemented support for GET /api/v1/di-projects/{projectId}/di-tasks/{dataTaskId}/runtime/runs/{runId}/state/datasets yet.
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

  • dataTaskIdstring
    Required

    Identifier of the data task.

  • projectIdstring
    Required

    Identifier of the data project.

Request Body

Required

Search criteria and pagination options for task run history query.

  • application/jsonobject

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

    Show application/json properties
    • limitinteger

      Maximum number of runs to return.

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

    • lastIdstring

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

    • filtersarray of objects

      Field filters to apply to the search.

      Show filters properties
      • fieldstring
        Required

        The run-history field to filter on.

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

      • valuearray of strings
        Required

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

      • operatorstring
        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/jsonobject
    Show application/json properties
    • runsarray of objects

      List of task run instances matching the search.

      Show runs properties
      • runIdstring

        Identifier of the run instance.

      • statusstring

        Execution status of a task run instance.

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

      • endTimestring

        Timestamp indicating when the run ended.

        format = "date-time"

      • durationstring

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

      • startTimestring

        Timestamp indicating when the run started.

        format = "date-time"

      • subStatusstring

        Sub-status of the run, when applicable.

      • errorMessagestring

        Error message, if the run failed.

        default = ""

      • datasetsCountinteger

        Total number of datasets processed in this run.

        format = int32

      • originSubStatusstring

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

      • datasetsErrorCountinteger

        Number of datasets that encountered errors in this run.

        format = int32

    • lastIdstring

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

    • nextPageExistsboolean

      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/jsonobject

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

    Show application/json properties
    • errorsarray of objects

      Array of error objects describing what went wrong.

      Show errors properties
      • codestring

        Machine-readable error code for programmatic handling.

      • titlestring

        Brief human-readable summary of the error.

      • detailstring

        Detailed explanation of the error and suggested remediation steps.

      • sourceobject

        Identifies the location of the error in the request.

        Show source properties
        • pointerstring

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

        • parameterstring

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

        HTTP status code associated with the error.

        format = int32

    • traceIdstring

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

404

Project or task not found.

  • application/jsonobject

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

    Show application/json properties
    • errorsarray of objects

      Array of error objects describing what went wrong.

      Show errors properties
      • codestring

        Machine-readable error code for programmatic handling.

      • titlestring

        Brief human-readable summary of the error.

      • detailstring

        Detailed explanation of the error and suggested remediation steps.

      • sourceobject

        Identifies the location of the error in the request.

        Show source properties
        • pointerstring

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

        • parameterstring

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

        HTTP status code associated with the error.

        format = int32

    • traceIdstring

      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 
// qlik-api has not implemented support for `POST /api/v1/di-projects/{projectId}/di-tasks/{dataTaskId}/runtime/runs/actions/search` yet.
// In the meantime, you can use fetch like this:


const response = await fetch(
  '/api/v1/di-projects/{projectId}/di-tasks/{dataTaskId}/runtime/runs/actions/search',
  {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      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',
        },
      ],
    }),
  },
)
# qlik-cli has not implemented support for POST /api/v1/di-projects/{projectId}/di-tasks/{dataTaskId}/runtime/runs/actions/search yet.
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

  • dataTaskIdstring
    Required

    Identifier of the data task.

  • projectIdstring
    Required

    Identifier of the data project.

Responses

200

OK

  • application/jsonobject

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

    Show application/json properties
    • namestring

      Name of the data task

    • typestring

      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"

    • lastRunobject

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

      Show lastRun properties
      • statestring

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

      • errorsarray of objects

        List of errors encountered during the last run

        Show errors properties
        • codestring

          Machine-readable error code for programmatic handling.

        • titlestring

          Brief human-readable summary of the error.

        • detailstring

          Detailed explanation of the error and suggested remediation steps.

        • sourceobject

          Identifies the location of the error in the request.

          Show source properties
          • pointerstring

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

          • parameterstring

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

          HTTP status code associated with the error.

          format = int32

      • endTimestring

        Timestamp indicating when the task instance ended

        format = "date-time"

      • generalobject

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

        Show general properties
        • gatewayIdstring

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

        • gatewayNamestring

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

        • datasetCountnumber

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

        • gatewayTaskNamestring

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

        • dataTaskUpdatedTostring

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

          format = "date-time"

        • lakehouseClusterIdstring

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

        • liveViewsUpdatedTostring

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

          format = "date-time"

        • datasetsInErrorCountnumber

          Count of datasets that encountered errors

        • lakehouseClusterNamestring

          For lakehouse storage tasks, this is the name of the cluster where the task runs
      • messagestring
      • traceIdstring

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

      • durationstring

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

      • fullLoadobject

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

        Show fullLoad properties
        • errorCountnumber

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

        • queuedCountnumber

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

        • loadingCountnumber

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

        • completedCountnumber

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

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

        Show cdcStatus properties
        • latencystring

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

        • totalProcessedCountnumber
        • applyingChangesCountnumber
        • incomingChangesCountnumber

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

        • accumulatingChangesCountnumber
        • throughputInKilobytesPerSecondnumber

          Throughput in kilobytes per second
      • startTimestring

        Timestamp indicating when the task instance started

        format = "date-time"

      • streamingobject

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

        Show streaming properties
        • latencystring

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

        • errorCountnumber

          Number of streaming datasets that have encountered errors

        • queuedCountnumber

          Number of streaming datasets that are queued

        • runningCountnumber

          Number of streaming datasets that are currently running

        • totalProcessedCountnumber

          Total number of records processed
      • lastBatchOfChangesobject

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

        Show lastBatchOfChanges properties
        • relatesToRecordsTostring

          This batch ends with operational source changes from this time.

          format = "date-time"

        • totalProcessedCountnumber
        • relatesToRecordsFromstring

          This batch starts with operational source changes from this time.

          format = "date-time"

        • throughputInRecordsPerSecondnumber

          Throughput in records per second
    • runReadinessobject
      Show runReadiness properties
      • statestring

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

      • messagestring

400

Bad Request

  • application/jsonobject

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

    Show application/json properties
    • errorsarray of objects

      Array of error objects describing what went wrong.

      Show errors properties
      • codestring

        Machine-readable error code for programmatic handling.

      • titlestring

        Brief human-readable summary of the error.

      • detailstring

        Detailed explanation of the error and suggested remediation steps.

      • sourceobject

        Identifies the location of the error in the request.

        Show source properties
        • pointerstring

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

        • parameterstring

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

        HTTP status code associated with the error.

        format = int32

    • traceIdstring

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

404

Not Found

  • application/jsonobject

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

    Show application/json properties
    • errorsarray of objects

      Array of error objects describing what went wrong.

      Show errors properties
      • codestring

        Machine-readable error code for programmatic handling.

      • titlestring

        Brief human-readable summary of the error.

      • detailstring

        Detailed explanation of the error and suggested remediation steps.

      • sourceobject

        Identifies the location of the error in the request.

        Show source properties
        • pointerstring

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

        • parameterstring

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

        HTTP status code associated with the error.

        format = int32

    • traceIdstring

      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 runtime dataset states

Returns dataset-level runtime state for a data task

Facts

Rate limit Special (120 requests per minute)

Path Parameters

  • dataTaskIdstring
    Required

    Identifier of the data task.

  • projectIdstring
    Required

    Identifier of the data project.

Responses

200

Returns all datasets for the specified data task

  • application/jsonobject
    Show application/json properties
    • datasetsarray of objects

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

      Show datasets properties
      • namestring

        Name of the dataset

      • fullLoadobject
        Show fullLoad properties
        • statestring

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

        • endTimestring

          format = "date-time"

        • messagestring
        • durationstring

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

        • fileStatsobject

          Statistics for file-based tasks.

          Show fileStats properties
          • volumestring

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

          • processedCountnumber

            Number of files processed.
        • startTimestring

          format = "date-time"

        • cachedChangesCountnumber

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

        • failedRecordsCountnumber

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

        • totalProcessedCountnumber

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

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

        Show cdcStatus properties
        • statestring

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

        • messagestring
        • ddlCountnumber

          Number of DDL statements executed during the last run

        • deleteCountnumber

          delete portion of totalProcessedCount. Only available for some task types

        • insertCountnumber

          Insert portion of totalProcessedCount. Only available for some task types

        • updateCountnumber

          update portion of totalProcessedCount. Only available for some task types

        • lastProcessedstring

          format = "date-time"

        • totalProcessedCountnumber

          Total number of changes/DMLs applied to the dataset

        • incomingChangesCountnumber

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

        • unoptimizedRecordsCountnumber

          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.
      • datasetIdstring

        Id of the dataset

      • streamingobject

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

        Show streaming properties
        • statestring

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

        • messagestring
        • lastProcessedstring

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

          format = "date-time"

        • parseIssueCountnumber

          Number of records that had parsing issues

        • recordsWrittenCountnumber

          Total number of records written to the dataset

        • totalProcessedCountnumber

          Total number of processed changes for the dataset

        • recordsFilteredCountnumber

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

        • unoptimizedRecordsCountnumber

          Queryable records pending merge into optimized Iceberg partitions.
      • sourceNamestring

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

      • dataReadinessstring

        Is the data ready for use?

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

      • lastBatchOfChangesobject
        Show lastBatchOfChanges properties
        • statestring

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

        • endTimestring

          format = "date-time"

        • messagestring
        • durationstring

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

        • fileStatsobject

          Statistics for file-based tasks.

          Show fileStats properties
          • volumestring

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

          • processedCountnumber

            Number of files processed.
        • startTimestring

          format = "date-time"

        • operationStatsobject

          Breakdown of operations for record-oriented tasks.

          Show operationStats properties
          • deleteCountnumber

            Number of delete operations.

          • failedCountnumber

            Number of failed operations.

          • insertCountnumber

            Number of insert operations.

          • updateCountnumber

            Number of update operations.
        • totalProcessedCountnumber
        • throughputInRecordsPerSecondnumber

          Throughput in records per second

400

Bad Request

  • application/jsonobject

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

    Show application/json properties
    • errorsarray of objects

      Array of error objects describing what went wrong.

      Show errors properties
      • codestring

        Machine-readable error code for programmatic handling.

      • titlestring

        Brief human-readable summary of the error.

      • detailstring

        Detailed explanation of the error and suggested remediation steps.

      • sourceobject

        Identifies the location of the error in the request.

        Show source properties
        • pointerstring

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

        • parameterstring

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

        HTTP status code associated with the error.

        format = int32

    • traceIdstring

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

404

Not Found

  • application/jsonobject

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

    Show application/json properties
    • errorsarray of objects

      Array of error objects describing what went wrong.

      Show errors properties
      • codestring

        Machine-readable error code for programmatic handling.

      • titlestring

        Brief human-readable summary of the error.

      • detailstring

        Detailed explanation of the error and suggested remediation steps.

      • sourceobject

        Identifies the location of the error in the request.

        Show source properties
        • pointerstring

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

        • parameterstring

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

        HTTP status code associated with the error.

        format = int32

    • traceIdstring

      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

  • detailedboolean

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

    default = false

Path Parameters

  • actionIdstring
    Required

    Identifier of the action.

Responses

200

OK

  • application/jsonobject
    Show application/json properties
    • namestring

      Name of the async operation

    • typestring

      Type of action being performed

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

    • errorobject
      Show error properties
      • codestring

        Error code

      • detailsstring

        Additional error details

      • messagestring

        Error message
    • statestring

      State of the action

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

    • endTimestring

      format = "date-time"

    • startTimestring

      format = "date-time"

    • taskDetailsarray of objects
      Show taskDetails properties
      • infostring

        Additional details about task state

      • namestring
      • errorobject
        Show error properties
        • codestring

          Error code

        • detailsstring

          Additional error details

        • messagestring

          Error message
      • statestring

        State of the action

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

      • taskIdstring
    • taskProgressobject
      Show taskProgress properties
      • failedinteger

        Number of tasks that failed

      • pendinginteger

        Number of tasks pending execution

      • skippedinteger

        Number of tasks skipped due to conflicts

      • canceledinteger

        Number of tasks canceled

      • completedinteger

        Number of tasks completed successfully

      • executinginteger

        Number of tasks currently executing

404

Action not found

  • application/jsonobject

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

    Show application/json properties
    • errorsarray of objects

      Array of error objects describing what went wrong.

      Show errors properties
      • codestring

        Machine-readable error code for programmatic handling.

      • titlestring

        Brief human-readable summary of the error.

      • detailstring

        Detailed explanation of the error and suggested remediation steps.

      • sourceobject

        Identifies the location of the error in the request.

        Show source properties
        • pointerstring

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

        • parameterstring

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

        HTTP status code associated with the error.

        format = int32

    • traceIdstring

      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
  }
}