Data integration projects

Data integration projects are containers for data tasks and provide the context for building, monitoring, and controlling data integration pipelines.

Download specification

Endpoints

GET

/v1/di-projects
POST

/v1/di-projects
GET

/v1/di-projects/{projectId}
POST

/v1/di-projects/{projectId}/actions/export
POST

/v1/di-projects/{projectId}/actions/import
POST

/v1/di-projects/{projectId}/actions/prepare
POST

/v1/di-projects/{projectId}/actions/validate
GET

/v1/di-projects/{projectId}/bindings
PUT

/v1/di-projects/{projectId}/bindings
GET

/v1/di-projects/{projectId}/di-tasks
GET

/v1/di-projects/{projectId}/di-tasks/{dataTaskId}
POST

/v1/di-projects/{projectId}/di-tasks/{dataTaskId}/actions/prepare
POST

/v1/di-projects/{projectId}/di-tasks/{dataTaskId}/actions/validate
POST

/v1/di-projects/{projectId}/di-tasks/{dataTaskId}/runtime/actions/start
POST

/v1/di-projects/{projectId}/di-tasks/{dataTaskId}/runtime/actions/stop
GET

/v1/di-projects/{projectId}/di-tasks/{dataTaskId}/runtime/state
GET

/v1/di-projects/actions/{actionId}

List data integration projects.

Facts

Rate limit	Tier 1 (1000 requests per minute)
Categories	manage

Query Parameters

spaceIdstring

Filter by space id

Responses

200

application/json

OK

application/jsonobject
Show application/json properties
- projectsarray of objects
  
  Show projects properties
  
  idstring
  
  namestring
  
  ownerIdstring
  
  spaceIdstring
  
  descriptionstring

400

application/json

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  
  titlestring
  
  detailstring
  
  sourceobject
  
  Show source properties
  
  pointerstring
  
  parameterstring
  
  statusinteger
  
  format = int32
- traceIdstring

404

application/json

Not Found

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  
  titlestring
  
  detailstring
  
  sourceobject
  
  Show source properties
  
  pointerstring
  
  parameterstring
  
  statusinteger
  
  format = int32
- traceIdstring

GET /v1/di-projects

curl "https://your-tenant.us.qlikcloud.com/api/v1/di-projects" \
-H "Authorization: Bearer <access_token>"

const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/di-projects',
    'method': 'GET',
    'headers': {
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)

This API is not included yet in qlik-cli

Response

{
  "projects": [
    {
      "id": "string",
      "name": "string",
      "ownerId": "string",
      "spaceId": "string",
      "description": "string"
    }
  ]
}

Creates a new data integration project in the specified space.

Facts

Rate limit	Tier 2 (100 requests per minute)
Categories

Request Body

Required

application/json

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
  
  Can be one of: "SNOWFLAKE""BIGQUERY""SYNAPSE""DATABRICKS""REDSHIFT""MSSQL""FABRIC"
- platformConnectionstring
  
  The platform connection string
- cloudStagingConnectionstring
  
  The cloud staging connection string

Responses

201

application/json

Created

application/jsonobject
Show application/json properties
- idstring
- namestring
- ownerIdstring
- spaceIdstring
- descriptionstring

400

application/json

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  
  titlestring
  
  detailstring
  
  sourceobject
  
  Show source properties
  
  pointerstring
  
  parameterstring
  
  statusinteger
  
  format = int32
- traceIdstring

500

application/json

Internal Server Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  
  titlestring
  
  detailstring
  
  sourceobject
  
  Show source properties
  
  pointerstring
  
  parameterstring
  
  statusinteger
  
  format = int32
- traceIdstring

POST /v1/di-projects

curl "https://your-tenant.us.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"}'

const https = require('https')
  const data = JSON.stringify({"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"})
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/di-projects',
    'method': 'POST',
    'headers': {
      'Content-type': 'application/json',
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)
  req.write(data)

This API is not included yet in qlik-cli

Request

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

Response

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

Get a specific data integration project.

Facts

Rate limit	Tier 1 (1000 requests per minute)
Categories	manage

Path Parameters

projectIdstring
Required

Responses

200

application/json

OK

application/jsonobject
Show application/json properties
- idstring
- namestring
- ownerIdstring
- spaceIdstring
- descriptionstring

400

application/json

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  
  titlestring
  
  detailstring
  
  sourceobject
  
  Show source properties
  
  pointerstring
  
  parameterstring
  
  statusinteger
  
  format = int32
- traceIdstring

404

application/json

Not Found

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  
  titlestring
  
  detailstring
  
  sourceobject
  
  Show source properties
  
  pointerstring
  
  parameterstring
  
  statusinteger
  
  format = int32
- traceIdstring

GET /v1/di-projects/{projectId}

curl "https://your-tenant.us.qlikcloud.com/api/v1/di-projects/{projectId}" \
-H "Authorization: Bearer <access_token>"

const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/di-projects/{projectId}',
    'method': 'GET',
    'headers': {
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)

This API is not included yet in qlik-cli

Response

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

Exports the specified data integration project.

Facts

Rate limit	Tier 2 (100 requests per minute)
Categories

Header Parameters

Acceptstring

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

Path Parameters

projectIdstring
Required

Data project ID

Request Body

application/json

Options for the export process

application/jsonobject
Show application/json properties
- includeBindingsboolean
  
  Include bindings in the exported zip file (optional, default is false)

Responses

200

application/octet-stream

OK

application/octet-streamstring

format = "binary"

400

application/json

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  
  titlestring
  
  detailstring
  
  sourceobject
  
  Show source properties
  
  pointerstring
  
  parameterstring
  
  statusinteger
  
  format = int32
- traceIdstring

404

application/json

Not Found

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  
  titlestring
  
  detailstring
  
  sourceobject
  
  Show source properties
  
  pointerstring
  
  parameterstring
  
  statusinteger
  
  format = int32
- traceIdstring

500

application/json

Internal Server Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  
  titlestring
  
  detailstring
  
  sourceobject
  
  Show source properties
  
  pointerstring
  
  parameterstring
  
  statusinteger
  
  format = int32
- traceIdstring

POST /v1/di-projects/{projectId}/actions/export

curl "https://your-tenant.us.qlikcloud.com/api/v1/di-projects/{projectId}/actions/export" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{"includeBindings":false}' \
-o "output-file"

const https = require('https')
  const data = JSON.stringify({"includeBindings":false})
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/di-projects/{projectId}/actions/export',
    'method': 'POST',
    'headers': {
      'Content-type': 'application/json',
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)
  req.write(data)

This API is not included yet in qlik-cli

Request

{
  "includeBindings": false
}

Imports a data integration project from a .zip file.

Facts

Rate limit	Tier 2 (100 requests per minute)
Categories

Path Parameters

projectIdstring
Required

Data project ID

Request Body

Required

multipart/form-data

The ZIP file containing the project to import

multipart/form-dataobject
Show multipart/form-data properties
- zipstring
  
  format = "binary"

Responses

200

application/json

OK

application/jsonobject

400

application/json

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  
  titlestring
  
  detailstring
  
  sourceobject
  
  Show source properties
  
  pointerstring
  
  parameterstring
  
  statusinteger
  
  format = int32
- traceIdstring

404

application/json

Not Found

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  
  titlestring
  
  detailstring
  
  sourceobject
  
  Show source properties
  
  pointerstring
  
  parameterstring
  
  statusinteger
  
  format = int32
- traceIdstring

500

application/json

Internal Server Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  
  titlestring
  
  detailstring
  
  sourceobject
  
  Show source properties
  
  pointerstring
  
  parameterstring
  
  statusinteger
  
  format = int32
- traceIdstring

POST /v1/di-projects/{projectId}/actions/import

curl "https://your-tenant.us.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"

const https = require('https')
  const data = JSON.stringify({"zip":"string"})
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/di-projects/{projectId}/actions/import',
    'method': 'POST',
    'headers': {
      'Content-type': 'multipart/form-data',
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)
  req.write(formData)

This API is not included yet in qlik-cli

Request

{
  "zip": "string"
}

Response

{}

Prepares the data integration project and its tasks for execution.

Facts

Rate limit	Tier 2 (100 requests per minute)
Categories

Path Parameters

projectIdstring
Required

Data project ID

Request Body

Required

application/json

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

application/json

Preparation started

application/jsonobject
Show application/json properties
- actionIdstring
  Required
  
  Identifier for tracking the action

400

application/json

Invalid request

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  
  titlestring
  
  detailstring
  
  sourceobject
  
  Show source properties
  
  pointerstring
  
  parameterstring
  
  statusinteger
  
  format = int32
- traceIdstring

404

application/json

Project not found

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  
  titlestring
  
  detailstring
  
  sourceobject
  
  Show source properties
  
  pointerstring
  
  parameterstring
  
  statusinteger
  
  format = int32
- traceIdstring

POST /v1/di-projects/{projectId}/actions/prepare

curl "https://your-tenant.us.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"}]}'

const https = require('https')
  const data = JSON.stringify({"allowRecreate":false,"selectedTasks":[{"taskId":"string"}]})
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/di-projects/{projectId}/actions/prepare',
    'method': 'POST',
    'headers': {
      'Content-type': 'application/json',
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)
  req.write(data)

This API is not included yet in qlik-cli

Request

{
  "allowRecreate": false,
  "selectedTasks": [
    {
      "taskId": "string"
    }
  ]
}

Response

{
  "actionId": "action-123456"
}

Validates the data integration project and its tasks.

Facts

Rate limit	Tier 2 (100 requests per minute)
Categories

Path Parameters

projectIdstring
Required

Data project ID

Request Body

Required

application/json

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

application/json

Validation started

application/jsonobject
Show application/json properties
- actionIdstring
  Required
  
  Identifier for tracking the action

400

application/json

Invalid request

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  
  titlestring
  
  detailstring
  
  sourceobject
  
  Show source properties
  
  pointerstring
  
  parameterstring
  
  statusinteger
  
  format = int32
- traceIdstring

404

application/json

Project not found

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  
  titlestring
  
  detailstring
  
  sourceobject
  
  Show source properties
  
  pointerstring
  
  parameterstring
  
  statusinteger
  
  format = int32
- traceIdstring

POST /v1/di-projects/{projectId}/actions/validate

curl "https://your-tenant.us.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"}]}'

const https = require('https')
  const data = JSON.stringify({"selectedTasks":[{"taskId":"string"}]})
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/di-projects/{projectId}/actions/validate',
    'method': 'POST',
    'headers': {
      'Content-type': 'application/json',
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)
  req.write(data)

This API is not included yet in qlik-cli

Request

{
  "selectedTasks": [
    {
      "taskId": "string"
    }
  ]
}

Response

{
  "actionId": "action-123456"
}

Retrieves the export variables for a specific data integration project.

Facts

Rate limit	Tier 1 (1000 requests per minute)
Categories

Query Parameters

recalculateboolean

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

default = false

Path Parameters

projectIdstring
Required

Data project ID

Responses

200

application/json

OK

application/jsonobject
Show application/json properties
- variablesobject
  
  additional properties

400

application/json

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  
  titlestring
  
  detailstring
  
  sourceobject
  
  Show source properties
  
  pointerstring
  
  parameterstring
  
  statusinteger
  
  format = int32
- traceIdstring

404

application/json

Not Found

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  
  titlestring
  
  detailstring
  
  sourceobject
  
  Show source properties
  
  pointerstring
  
  parameterstring
  
  statusinteger
  
  format = int32
- traceIdstring

GET /v1/di-projects/{projectId}/bindings

curl "https://your-tenant.us.qlikcloud.com/api/v1/di-projects/{projectId}/bindings" \
-H "Authorization: Bearer <access_token>"

const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/di-projects/{projectId}/bindings',
    'method': 'GET',
    'headers': {
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)

This API is not included yet in qlik-cli

Response

{
  "variables": {}
}

Updates the export variables for a specific data integration project.

Facts

Rate limit	Tier 2 (100 requests per minute)
Categories

Path Parameters

projectIdstring
Required

Data project ID

Request Body

Required

application/json

The details of the export variables to update

application/jsonobject
Show application/json properties
- variablesobject
  
  additional properties

Responses

200

application/json

OK

application/jsonobject

400

application/json

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  
  titlestring
  
  detailstring
  
  sourceobject
  
  Show source properties
  
  pointerstring
  
  parameterstring
  
  statusinteger
  
  format = int32
- traceIdstring

404

application/json

Not Found

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  
  titlestring
  
  detailstring
  
  sourceobject
  
  Show source properties
  
  pointerstring
  
  parameterstring
  
  statusinteger
  
  format = int32
- traceIdstring

500

application/json

Internal Server Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  
  titlestring
  
  detailstring
  
  sourceobject
  
  Show source properties
  
  pointerstring
  
  parameterstring
  
  statusinteger
  
  format = int32
- traceIdstring

PUT /v1/di-projects/{projectId}/bindings

curl "https://your-tenant.us.qlikcloud.com/api/v1/di-projects/{projectId}/bindings" \
-X PUT \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{"variables":{}}'

const https = require('https')
  const data = JSON.stringify({"variables":{}})
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/di-projects/{projectId}/bindings',
    'method': 'PUT',
    'headers': {
      'Content-type': 'application/json',
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)
  req.write(data)

This API is not included yet in qlik-cli

Request

{
  "variables": {}
}

Response

{}

Lists data tasks within a given data integration project.

Facts

Rate limit	Tier 1 (1000 requests per minute)
Categories	manage

Path Parameters

projectIdstring
Required

Data project id

Responses

200

application/json

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"
  
  ownerIdstring
  
  spaceIdstring
  
  descriptionstring

400

application/json

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  
  titlestring
  
  detailstring
  
  sourceobject
  
  Show source properties
  
  pointerstring
  
  parameterstring
  
  statusinteger
  
  format = int32
- traceIdstring

404

application/json

Not Found

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  
  titlestring
  
  detailstring
  
  sourceobject
  
  Show source properties
  
  pointerstring
  
  parameterstring
  
  statusinteger
  
  format = int32
- traceIdstring

GET /v1/di-projects/{projectId}/di-tasks

curl "https://your-tenant.us.qlikcloud.com/api/v1/di-projects/{projectId}/di-tasks" \
-H "Authorization: Bearer <access_token>"

const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/di-projects/{projectId}/di-tasks',
    'method': 'GET',
    'headers': {
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)

This API is not included yet in qlik-cli

Response

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

Get a specific data task within a project.

Facts

Rate limit	Tier 1 (1000 requests per minute)
Categories	manage

Path Parameters

dataTaskIdstring
Required

Data task id
projectIdstring
Required

Data project id

Responses

200

application/json

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"
- ownerIdstring
- spaceIdstring
- descriptionstring

400

application/json

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  
  titlestring
  
  detailstring
  
  sourceobject
  
  Show source properties
  
  pointerstring
  
  parameterstring
  
  statusinteger
  
  format = int32
- traceIdstring

404

application/json

Not Found

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  
  titlestring
  
  detailstring
  
  sourceobject
  
  Show source properties
  
  pointerstring
  
  parameterstring
  
  statusinteger
  
  format = int32
- traceIdstring

GET /v1/di-projects/{projectId}/di-tasks/{dataTaskId}

curl "https://your-tenant.us.qlikcloud.com/api/v1/di-projects/{projectId}/di-tasks/{dataTaskId}" \
-H "Authorization: Bearer <access_token>"

const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/di-projects/{projectId}/di-tasks/{dataTaskId}',
    'method': 'GET',
    'headers': {
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)

This API is not included yet in qlik-cli

Response

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

Prepares the specified data task for execution.

Facts

Rate limit	Tier 2 (100 requests per minute)
Categories

Path Parameters

dataTaskIdstring
Required

Data task ID
projectIdstring
Required

Data project ID

Request Body

application/json

application/jsonobject
Show application/json properties
- allowRecreateboolean
  Required
  
  Allow recreation of existing artifacts
  
  default = false

Responses

202

application/json

Preparation started

application/jsonobject
Show application/json properties
- actionIdstring
  Required
  
  Identifier for tracking the action

400

application/json

Invalid request

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  
  titlestring
  
  detailstring
  
  sourceobject
  
  Show source properties
  
  pointerstring
  
  parameterstring
  
  statusinteger
  
  format = int32
- traceIdstring

404

application/json

Task not found

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  
  titlestring
  
  detailstring
  
  sourceobject
  
  Show source properties
  
  pointerstring
  
  parameterstring
  
  statusinteger
  
  format = int32
- traceIdstring

POST /v1/di-projects/{projectId}/di-tasks/{dataTaskId}/actions/prepare

curl "https://your-tenant.us.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}'

const https = require('https')
  const data = JSON.stringify({"allowRecreate":false})
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/di-projects/{projectId}/di-tasks/{dataTaskId}/actions/prepare',
    'method': 'POST',
    'headers': {
      'Content-type': 'application/json',
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)
  req.write(data)

This API is not included yet in qlik-cli

Request

{
  "allowRecreate": false
}

Response

{
  "actionId": "action-123456"
}

Validates the specified data task.

Facts

Rate limit	Tier 2 (100 requests per minute)
Categories

Path Parameters

dataTaskIdstring
Required

Data task ID
projectIdstring
Required

Data project ID

Request Body

application/json

Request body for task validation

application/jsonobject

Request body for task validation

Responses

202

application/json

Validation started

application/jsonobject
Show application/json properties
- actionIdstring
  Required
  
  Identifier for tracking the action

400

application/json

Invalid request

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  
  titlestring
  
  detailstring
  
  sourceobject
  
  Show source properties
  
  pointerstring
  
  parameterstring
  
  statusinteger
  
  format = int32
- traceIdstring

404

application/json

Task not found

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  
  titlestring
  
  detailstring
  
  sourceobject
  
  Show source properties
  
  pointerstring
  
  parameterstring
  
  statusinteger
  
  format = int32
- traceIdstring

POST /v1/di-projects/{projectId}/di-tasks/{dataTaskId}/actions/validate

curl "https://your-tenant.us.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 '{}'

const https = require('https')
  const data = JSON.stringify({})
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/di-projects/{projectId}/di-tasks/{dataTaskId}/actions/validate',
    'method': 'POST',
    'headers': {
      'Content-type': 'application/json',
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)
  req.write(data)

This API is not included yet in qlik-cli

Request

{}

Response

{
  "actionId": "action-123456"
}

Start a data task on a data integration project.

Facts

Rate limit	Tier 2 (100 requests per minute)
Categories	manage

Path Parameters

dataTaskIdstring
Required

Data task id
projectIdstring
Required

Data project id

Responses

204

NO CONTENT

400

application/json

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  
  titlestring
  
  detailstring
  
  sourceobject
  
  Show source properties
  
  pointerstring
  
  parameterstring
  
  statusinteger
  
  format = int32
- traceIdstring

404

application/json

Not Found

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  
  titlestring
  
  detailstring
  
  sourceobject
  
  Show source properties
  
  pointerstring
  
  parameterstring
  
  statusinteger
  
  format = int32
- traceIdstring

POST /v1/di-projects/{projectId}/di-tasks/{dataTaskId}/runtime/actions/start

curl "https://your-tenant.us.qlikcloud.com/api/v1/di-projects/{projectId}/di-tasks/{dataTaskId}/runtime/actions/start" \
-X POST \
-H "Authorization: Bearer <access_token>"

const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/di-projects/{projectId}/di-tasks/{dataTaskId}/runtime/actions/start',
    'method': 'POST',
    'headers': {
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)

This API is not included yet in qlik-cli

Stop a data task on a data integration project.

Facts

Rate limit	Tier 2 (100 requests per minute)
Categories	manage

Path Parameters

dataTaskIdstring
Required
projectIdstring
Required

Responses

204

NO CONTENT

400

application/json

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  
  titlestring
  
  detailstring
  
  sourceobject
  
  Show source properties
  
  pointerstring
  
  parameterstring
  
  statusinteger
  
  format = int32
- traceIdstring

404

application/json

Not Found

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  
  titlestring
  
  detailstring
  
  sourceobject
  
  Show source properties
  
  pointerstring
  
  parameterstring
  
  statusinteger
  
  format = int32
- traceIdstring

POST /v1/di-projects/{projectId}/di-tasks/{dataTaskId}/runtime/actions/stop

curl "https://your-tenant.us.qlikcloud.com/api/v1/di-projects/{projectId}/di-tasks/{dataTaskId}/runtime/actions/stop" \
-X POST \
-H "Authorization: Bearer <access_token>"

const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/di-projects/{projectId}/di-tasks/{dataTaskId}/runtime/actions/stop',
    'method': 'POST',
    'headers': {
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)

This API is not included yet in qlik-cli

Get data task runtime state within a data integration project.

Facts

Rate limit	Tier 1 (1000 requests per minute)
Categories	manage

Path Parameters

dataTaskIdstring
Required
projectIdstring
Required

Responses

200

application/json

OK

application/jsonobject
Show application/json properties
- lastRunobject
  
  Show lastRun properties
  
  statestring
  
  Can be one of: "STARTING""RUNNING""COMPLETED""FAILED""CANCELED"
  
  messagestring
- runReadinessobject
  
  Show runReadiness properties
  
  statestring
  
  Can be one of: "READY_TO_RUN""ALREADY_RUNNING""NOT_RUNNABLE"
  
  messagestring

400

application/json

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  
  titlestring
  
  detailstring
  
  sourceobject
  
  Show source properties
  
  pointerstring
  
  parameterstring
  
  statusinteger
  
  format = int32
- traceIdstring

404

application/json

Not Found

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  
  titlestring
  
  detailstring
  
  sourceobject
  
  Show source properties
  
  pointerstring
  
  parameterstring
  
  statusinteger
  
  format = int32
- traceIdstring

GET /v1/di-projects/{projectId}/di-tasks/{dataTaskId}/runtime/state

curl "https://your-tenant.us.qlikcloud.com/api/v1/di-projects/{projectId}/di-tasks/{dataTaskId}/runtime/state" \
-H "Authorization: Bearer <access_token>"

const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/di-projects/{projectId}/di-tasks/{dataTaskId}/runtime/state',
    'method': 'GET',
    'headers': {
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)

This API is not included yet in qlik-cli

Response

{
  "lastRun": {
    "state": "STARTING",
    "message": "string"
  },
  "runReadiness": {
    "state": "READY_TO_RUN",
    "message": "string"
  }
}

Retrieves the status of an asynchronous operation.

Facts

Rate limit	Tier 1 (1000 requests per minute)
Categories

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

Action ID

Responses

200

application/json

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

application/json

Action not found

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  
  titlestring
  
  detailstring
  
  sourceobject
  
  Show source properties
  
  pointerstring
  
  parameterstring
  
  statusinteger
  
  format = int32
- traceIdstring

GET /v1/di-projects/actions/{actionId}

curl "https://your-tenant.us.qlikcloud.com/api/v1/di-projects/actions/{actionId}" \
-H "Authorization: Bearer <access_token>"

const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/di-projects/actions/{actionId}',
    'method': 'GET',
    'headers': {
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)

This API is not included yet in qlik-cli

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

Data integration projects

Endpoints

List projects

Facts

Query Parameters

Responses

200

400

404

Response

Create a new project

Facts

Request Body

Responses

201

400

500

Request

Response

Get a project

Facts

Path Parameters

Responses

200

400

404

Response

Export a project

Facts

Header Parameters

Path Parameters

Request Body

Responses

200

400

404

500

Request

Import a project

Facts

Path Parameters

Request Body

Responses

200

400

404

500

Request

Response

Prepare a project

Facts

Path Parameters

Request Body

Responses

202

400

404

Request

Response

Validate project

Facts

Path Parameters

Request Body

Responses

202

400

404

Request

Response

Get project export variables

Facts

Query Parameters

Path Parameters

Responses

200

400

404

Response

Update project export variables

Facts