Di projects

Download specification

list data integration projects

List data integration projects

Facts

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

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

404

application/json

Not Found

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
    • traceIdstring
GET /v1/di-projects 
curl "https://your-tenant.us.qlikcloud.com/api/v1/di-projects" \
-H "Authorization: Bearer <API-key>"

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 <API-key>'
    }
  }
  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"
    }
  ]
}

get data integration project

Facts

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

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

404

application/json

Not Found

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
    • traceIdstring
GET /v1/di-projects/{projectId} 
curl "https://your-tenant.us.qlikcloud.com/api/v1/di-projects/{projectId}" \
-H "Authorization: Bearer <API-key>"

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 <API-key>'
    }
  }
  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"
}

list data tasks within data project

Facts

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

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

404

application/json

Not Found

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
    • 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 <API-key>"

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 <API-key>'
    }
  }
  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 data task

Facts

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

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

404

application/json

Not Found

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
    • 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 <API-key>"

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 <API-key>'
    }
  }
  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 data task

Facts

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

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

404

application/json

Not Found

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
    • 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 <API-key>"

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 <API-key>'
    }
  }
  const req = https.request(options)
  

This API is not included yet in qlik-cli

stop data task

Facts

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

Path Parameters

  • dataTaskIdstring
    Required
  • projectIdstring
    Required

Responses

204

NO CONTENT

400

application/json

Bad Request

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
    • traceIdstring

404

application/json

Not Found

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
    • 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 <API-key>"

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 <API-key>'
    }
  }
  const req = https.request(options)
  

This API is not included yet in qlik-cli

get data task runtime state

Facts

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

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

404

application/json

Not Found

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
    • 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 <API-key>"

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 <API-key>'
    }
  }
  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"
  }
}