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

List projects

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

Create a new project

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

    • 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

    • 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 project

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

Export a project

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
}

Import a project

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

{}

Get project export variables

Retrieves the export variables for a specific data integration project.

Facts

Rate limit Tier 1 (1000 requests per minute)
Categories

Path Parameters

  • projectIdstring
    Required

    Data project ID

Responses

200

application/json

OK

  • application/jsonobject
    Show application/json properties
    • variablesarray of objects
      Show variables properties
      • namestring

        The name of the variable

      • valuestring

        The value of the variable

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": [
    {
      "name": "variable1",
      "value": "value1"
    }
  ]
}

Update project export 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
    • variablesarray of objects
      Show variables properties
      • namestring

        The name of the variable

      • valuestring

        The value of the variable

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":[{"name":"variable1","value":"value1"}]}'

const https = require('https')
  const data = JSON.stringify({"variables":[{"name":"variable1","value":"value1"}]})
  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": [
    {
      "name": "variable1",
      "value": "value1"
    }
  ]
}

Response

{}

List project tasks

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 project task

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

Start a project task

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 project task

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 project task runtime state

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