Data stores

Data stores are part of the catalog in Qlik Cloud. A data store may contain one or more data stores, which in turn may contain multiple data sets.

Download OpenAPI spec

Endpoints

GET

/api/v1/data-stores
POST

/api/v1/data-stores
DELETE

/api/v1/data-stores
GET

/api/v1/data-stores/{data-store-id}
PATCH

/api/v1/data-stores/{data-store-id}
PUT

/api/v1/data-stores/{data-store-id}
GET

/api/v1/data-stores/{data-store-ids}/data-assets
DELETE

/api/v1/data-stores/{data-store-ids}/data-assets
GET

/api/v1/data-stores/{data-store-ids}/data-assets/{data-asset-ids}/data-sets
DELETE

/api/v1/data-stores/{data-store-ids}/data-assets/{data-asset-ids}/data-sets

Facts

Rate limit

Tier 1 (1000 requests per minute)

Query Parameters

limit integer

Page size limit.

maximum = 100, default = 20, format = int32, default = 20
page integer

default = 0, format = int32, default = 0
projections array of strings

Comma-separated fields to return in the response.
sort array of strings

Comma-separated fields and field start with '-' character sorts the result set in descending order.

Responses

200

Successful Operation

application/json object
Show application/json properties
- data array of objects
  
  Show data properties
  
  id string
  
  Only required when updating the resource. Must be null for new resources.
  
  uri string
  
  minLength = 0, maxLength = 512
  
  name string
  
  minLength = 0, maxLength = 255
  
  tags array of strings
  
  uniqueItems = true
  
  type string
  
  Required
  
  minLength = 1, maxLength = 64
  
  ownerId string
  
  The value is automatically set by the application.
  
  spaceId string
  
  version integer
  
  Only required when updating the resource. Must be null for new resources.
  
  format = int64
  
  tenantId string
  
  The value is automatically set by the application. User defined value is ignored.
  
  createdBy string
  
  The value is automatically set by the application. User defined value is ignored.
  
  properties object
  
  A Map of name-value pairs.
  
  Show additional optional properties
  
  object object
  
  A Map of name-value pairs.
  
  createdTime string
  
  The value is automatically set by the application. User defined value is ignored.
  
  format = "date-time"
  
  description string
  
  minLength = 0, maxLength = 1024
  
  technicalName string
  
  Required
  
  minLength = 1, maxLength = 255
  
  lastModifiedBy string
  
  The value is automatically set by the application. User defined value is ignored.
  
  lastModifiedTime string
  
  The value is automatically set by the application. User defined value is ignored.
  
  format = "date-time"
  
  technicalDescription string
  
  minLength = 0, maxLength = 1024
- page integer
  
  format = int32
- limit integer
  
  format = int32
- links object
  
  Show links properties
  
  last object
  
  Show last properties
  
  href string
  
  next object
  
  Show next properties
  
  href string
  
  prev object
  
  Show prev properties
  
  href string
  
  self object
  
  Show self properties
  
  href string
  
  first object
  
  Show first properties
  
  href string
- pages integer
  
  format = int32
- total integer
  
  format = int64

400

The request is in incorrect format.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  meta object
  
  Optional free-form metadata associated with the error.
  
  additionalProperties = true
  
  title string
  
  detail string
  
  status string
- traceId string

401

User does not have valid authentication credentials.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  meta object
  
  Optional free-form metadata associated with the error.
  
  additionalProperties = true
  
  title string
  
  detail string
  
  status string
- traceId string

403

User does not have access to the resource.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  meta object
  
  Optional free-form metadata associated with the error.
  
  additionalProperties = true
  
  title string
  
  detail string
  
  status string
- traceId string

404

Resource does not exist.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  meta object
  
  Optional free-form metadata associated with the error.
  
  additionalProperties = true
  
  title string
  
  detail string
  
  status string
- traceId string

409

The input request conflicts with the current state of the resource.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  meta object
  
  Optional free-form metadata associated with the error.
  
  additionalProperties = true
  
  title string
  
  detail string
  
  status string
- traceId string

500

Internal Server Error.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  meta object
  
  Optional free-form metadata associated with the error.
  
  additionalProperties = true
  
  title string
  
  detail string
  
  status string
- traceId string

503

Requested service is not available.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  meta object
  
  Optional free-form metadata associated with the error.
  
  additionalProperties = true
  
  title string
  
  detail string
  
  status string
- traceId string

GET /api/v1/data-stores

import { createQlikApi } from '@qlik/api'

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

await qlik.dataStores.getDataStores({})

qlik data-store ls

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/data-stores" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "data": [
    {
      "id": "string",
      "uri": "string",
      "name": "string",
      "tags": [
        "string"
      ],
      "type": "string",
      "ownerId": "string",
      "spaceId": "string",
      "version": 42,
      "tenantId": "string",
      "createdBy": "string",
      "properties": {},
      "createdTime": "2018-10-30T07:06:22Z",
      "description": "string",
      "technicalName": "string",
      "lastModifiedBy": "string",
      "lastModifiedTime": "2018-10-30T07:06:22Z",
      "technicalDescription": "string"
    }
  ],
  "page": 42,
  "limit": 42,
  "links": {
    "last": {
      "href": "string"
    },
    "next": {
      "href": "string"
    },
    "prev": {
      "href": "string"
    },
    "self": {
      "href": "string"
    },
    "first": {
      "href": "string"
    }
  },
  "pages": 42,
  "total": 42
}

Facts

Rate limit

Tier 2 (100 requests per minute)

Request Body

Required

application/json object
Show application/json properties
- id string
  
  Only required when updating the resource. Must be null for new resources.
- uri string
  
  minLength = 0, maxLength = 512
- name string
  
  minLength = 0, maxLength = 255
- tags array of strings
  
  uniqueItems = true
- type string
  
  Required
  
  minLength = 1, maxLength = 64
- ownerId string
  
  The value is automatically set by the application.
- spaceId string
- version integer
  
  Only required when updating the resource. Must be null for new resources.
  
  format = int64
- properties object
  
  A Map of name-value pairs.
  
  Show additional optional properties
  
  object object
  
  A Map of name-value pairs.
- description string
  
  minLength = 0, maxLength = 1024
- technicalName string
  
  Required
  
  minLength = 1, maxLength = 255
- technicalDescription string
  
  minLength = 0, maxLength = 1024

Responses

201

Created new data store successfully.

application/json object
Show application/json properties
- id string
  
  Only required when updating the resource. Must be null for new resources.
- uri string
  
  minLength = 0, maxLength = 512
- name string
  
  minLength = 0, maxLength = 255
- tags array of strings
  
  uniqueItems = true
- type string
  
  Required
  
  minLength = 1, maxLength = 64
- ownerId string
  
  The value is automatically set by the application.
- spaceId string
- version integer
  
  Only required when updating the resource. Must be null for new resources.
  
  format = int64
- tenantId string
  
  The value is automatically set by the application. User defined value is ignored.
- createdBy string
  
  The value is automatically set by the application. User defined value is ignored.
- properties object
  
  A Map of name-value pairs.
  
  Show additional optional properties
  
  object object
  
  A Map of name-value pairs.
- createdTime string
  
  The value is automatically set by the application. User defined value is ignored.
  
  format = "date-time"
- description string
  
  minLength = 0, maxLength = 1024
- technicalName string
  
  Required
  
  minLength = 1, maxLength = 255
- lastModifiedBy string
  
  The value is automatically set by the application. User defined value is ignored.
- lastModifiedTime string
  
  The value is automatically set by the application. User defined value is ignored.
  
  format = "date-time"
- technicalDescription string
  
  minLength = 0, maxLength = 1024

400

The request is in incorrect format.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  meta object
  
  Optional free-form metadata associated with the error.
  
  additionalProperties = true
  
  title string
  
  detail string
  
  status string
- traceId string

401

User does not have valid authentication credentials.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  meta object
  
  Optional free-form metadata associated with the error.
  
  additionalProperties = true
  
  title string
  
  detail string
  
  status string
- traceId string

403

User does not have access to the resource.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  meta object
  
  Optional free-form metadata associated with the error.
  
  additionalProperties = true
  
  title string
  
  detail string
  
  status string
- traceId string

404

Resource does not exist.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  meta object
  
  Optional free-form metadata associated with the error.
  
  additionalProperties = true
  
  title string
  
  detail string
  
  status string
- traceId string

409

The input request conflicts with the current state of the resource.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  meta object
  
  Optional free-form metadata associated with the error.
  
  additionalProperties = true
  
  title string
  
  detail string
  
  status string
- traceId string

500

Internal Server Error.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  meta object
  
  Optional free-form metadata associated with the error.
  
  additionalProperties = true
  
  title string
  
  detail string
  
  status string
- traceId string

503

Requested service is not available.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  meta object
  
  Optional free-form metadata associated with the error.
  
  additionalProperties = true
  
  title string
  
  detail string
  
  status string
- traceId string

POST /api/v1/data-stores

import { createQlikApi } from '@qlik/api'

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

await qlik.dataStores.createDataStore({
  description: 'string',
  id: 'string',
  name: 'string',
  ownerId: 'string',
  properties: {},
  spaceId: 'string',
  tags: ['string'],
  technicalDescription: 'string',
  technicalName: 'string',
  type: 'string',
  uri: 'string',
  version: 42,
})

qlik data-store create \
  --technicalName 'string' \
  --type 'string'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/data-stores" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{"id":"string","uri":"string","name":"string","tags":["string"],"type":"string","ownerId":"string","spaceId":"string","version":42,"properties":{},"description":"string","technicalName":"string","technicalDescription":"string"}'

Example Response

{
  "id": "string",
  "uri": "string",
  "name": "string",
  "tags": [
    "string"
  ],
  "type": "string",
  "ownerId": "string",
  "spaceId": "string",
  "version": 42,
  "tenantId": "string",
  "createdBy": "string",
  "properties": {},
  "createdTime": "2018-10-30T07:06:22Z",
  "description": "string",
  "technicalName": "string",
  "lastModifiedBy": "string",
  "lastModifiedTime": "2018-10-30T07:06:22Z",
  "technicalDescription": "string"
}

Facts

Rate limit

Tier 2 (100 requests per minute)

Request Body

Required

application/json object
Show application/json properties
- ids array of strings
  
  uniqueItems = true

Responses

204

Deleted empty data stores.

400

The request is in incorrect format.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  meta object
  
  Optional free-form metadata associated with the error.
  
  additionalProperties = true
  
  title string
  
  detail string
  
  status string
- traceId string

401

User does not have valid authentication credentials.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  meta object
  
  Optional free-form metadata associated with the error.
  
  additionalProperties = true
  
  title string
  
  detail string
  
  status string
- traceId string

403

User does not have access to the resource.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  meta object
  
  Optional free-form metadata associated with the error.
  
  additionalProperties = true
  
  title string
  
  detail string
  
  status string
- traceId string

404

Resource does not exist.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  meta object
  
  Optional free-form metadata associated with the error.
  
  additionalProperties = true
  
  title string
  
  detail string
  
  status string
- traceId string

409

The input request conflicts with the current state of the resource.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  meta object
  
  Optional free-form metadata associated with the error.
  
  additionalProperties = true
  
  title string
  
  detail string
  
  status string
- traceId string

500

Internal Server Error.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  meta object
  
  Optional free-form metadata associated with the error.
  
  additionalProperties = true
  
  title string
  
  detail string
  
  status string
- traceId string

503

Requested service is not available.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  meta object
  
  Optional free-form metadata associated with the error.
  
  additionalProperties = true
  
  title string
  
  detail string
  
  status string
- traceId string

DELETE /api/v1/data-stores

import { createQlikApi } from '@qlik/api'

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

await qlik.dataStores.deleteDataStores({
  ids: ['string'],
})

qlik data-store delete-many

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/data-stores" \
-X DELETE \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{"ids":["string"]}'

Facts

Rate limit

Tier 1 (1000 requests per minute)

Query Parameters

projections array of strings

Comma-separated fields to return in the response.

Path Parameters

data-store-id string

Required

Responses

200

Successful Operation.

application/json object
Show application/json properties
- id string
  
  Only required when updating the resource. Must be null for new resources.
- uri string
  
  minLength = 0, maxLength = 512
- name string
  
  minLength = 0, maxLength = 255
- tags array of strings
  
  uniqueItems = true
- type string
  
  Required
  
  minLength = 1, maxLength = 64
- ownerId string
  
  The value is automatically set by the application.
- spaceId string
- version integer
  
  Only required when updating the resource. Must be null for new resources.
  
  format = int64
- tenantId string
  
  The value is automatically set by the application. User defined value is ignored.
- createdBy string
  
  The value is automatically set by the application. User defined value is ignored.
- properties object
  
  A Map of name-value pairs.
  
  Show additional optional properties
  
  object object
  
  A Map of name-value pairs.
- createdTime string
  
  The value is automatically set by the application. User defined value is ignored.
  
  format = "date-time"
- description string
  
  minLength = 0, maxLength = 1024
- technicalName string
  
  Required
  
  minLength = 1, maxLength = 255
- lastModifiedBy string
  
  The value is automatically set by the application. User defined value is ignored.
- lastModifiedTime string
  
  The value is automatically set by the application. User defined value is ignored.
  
  format = "date-time"
- technicalDescription string
  
  minLength = 0, maxLength = 1024

400

The request is in incorrect format.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  meta object
  
  Optional free-form metadata associated with the error.
  
  additionalProperties = true
  
  title string
  
  detail string
  
  status string
- traceId string

401

User does not have valid authentication credentials.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  meta object
  
  Optional free-form metadata associated with the error.
  
  additionalProperties = true
  
  title string
  
  detail string
  
  status string
- traceId string

403

User does not have access to the resource.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  meta object
  
  Optional free-form metadata associated with the error.
  
  additionalProperties = true
  
  title string
  
  detail string
  
  status string
- traceId string

404

Resource does not exist.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  meta object
  
  Optional free-form metadata associated with the error.
  
  additionalProperties = true
  
  title string
  
  detail string
  
  status string
- traceId string

409

The input request conflicts with the current state of the resource.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  meta object
  
  Optional free-form metadata associated with the error.
  
  additionalProperties = true
  
  title string
  
  detail string
  
  status string
- traceId string

500

Internal Server Error.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  meta object
  
  Optional free-form metadata associated with the error.
  
  additionalProperties = true
  
  title string
  
  detail string
  
  status string
- traceId string

503

Requested service is not available.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  meta object
  
  Optional free-form metadata associated with the error.
  
  additionalProperties = true
  
  title string
  
  detail string
  
  status string
- traceId string

GET /api/v1/data-stores/{data-store-id}

import { createQlikApi } from '@qlik/api'

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

await qlik.dataStores.getDataStore('string', {})

qlik data-store get 'string'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/data-stores/{data-store-id}" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "id": "string",
  "uri": "string",
  "name": "string",
  "tags": [
    "string"
  ],
  "type": "string",
  "ownerId": "string",
  "spaceId": "string",
  "version": 42,
  "tenantId": "string",
  "createdBy": "string",
  "properties": {},
  "createdTime": "2018-10-30T07:06:22Z",
  "description": "string",
  "technicalName": "string",
  "lastModifiedBy": "string",
  "lastModifiedTime": "2018-10-30T07:06:22Z",
  "technicalDescription": "string"
}

Facts

Rate limit

Tier 2 (100 requests per minute)

Path Parameters

data-store-id string

Required

Request Body

Required

application/json array of objects

Array of JSON patch documents as defined by RFC 6902.
Show application/json properties
- op string
  
  Required
  
  The operation to be performed.
  
  Can be one of: "add""remove""replace""move""copy""test"
- from string
  
  A JSON Pointer path pointing to the location to move/copy from.
- path string
  
  Required
  
  A JSON pointer to the property being affected.
- value object
  
  The value to add, replace or test.

Responses

200

Patched data store successfully.

application/json object
Show application/json properties
- id string
  
  Only required when updating the resource. Must be null for new resources.
- uri string
  
  minLength = 0, maxLength = 512
- name string
  
  minLength = 0, maxLength = 255
- tags array of strings
  
  uniqueItems = true
- type string
  
  Required
  
  minLength = 1, maxLength = 64
- ownerId string
  
  The value is automatically set by the application.
- spaceId string
- version integer
  
  Only required when updating the resource. Must be null for new resources.
  
  format = int64
- tenantId string
  
  The value is automatically set by the application. User defined value is ignored.
- createdBy string
  
  The value is automatically set by the application. User defined value is ignored.
- properties object
  
  A Map of name-value pairs.
  
  Show additional optional properties
  
  object object
  
  A Map of name-value pairs.
- createdTime string
  
  The value is automatically set by the application. User defined value is ignored.
  
  format = "date-time"
- description string
  
  minLength = 0, maxLength = 1024
- technicalName string
  
  Required
  
  minLength = 1, maxLength = 255
- lastModifiedBy string
  
  The value is automatically set by the application. User defined value is ignored.
- lastModifiedTime string
  
  The value is automatically set by the application. User defined value is ignored.
  
  format = "date-time"
- technicalDescription string
  
  minLength = 0, maxLength = 1024

204

Patched data store successfully.

application/json object
Show application/json properties
- id string
  
  Only required when updating the resource. Must be null for new resources.
- uri string
  
  minLength = 0, maxLength = 512
- name string
  
  minLength = 0, maxLength = 255
- tags array of strings
  
  uniqueItems = true
- type string
  
  Required
  
  minLength = 1, maxLength = 64
- ownerId string
  
  The value is automatically set by the application.
- spaceId string
- version integer
  
  Only required when updating the resource. Must be null for new resources.
  
  format = int64
- tenantId string
  
  The value is automatically set by the application. User defined value is ignored.
- createdBy string
  
  The value is automatically set by the application. User defined value is ignored.
- properties object
  
  A Map of name-value pairs.
  
  Show additional optional properties
  
  object object
  
  A Map of name-value pairs.
- createdTime string
  
  The value is automatically set by the application. User defined value is ignored.
  
  format = "date-time"
- description string
  
  minLength = 0, maxLength = 1024
- technicalName string
  
  Required
  
  minLength = 1, maxLength = 255
- lastModifiedBy string
  
  The value is automatically set by the application. User defined value is ignored.
- lastModifiedTime string
  
  The value is automatically set by the application. User defined value is ignored.
  
  format = "date-time"
- technicalDescription string
  
  minLength = 0, maxLength = 1024

400

The request is in incorrect format.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  meta object
  
  Optional free-form metadata associated with the error.
  
  additionalProperties = true
  
  title string
  
  detail string
  
  status string
- traceId string

401

User does not have valid authentication credentials.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  meta object
  
  Optional free-form metadata associated with the error.
  
  additionalProperties = true
  
  title string
  
  detail string
  
  status string
- traceId string

403

User does not have access to the resource.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  meta object
  
  Optional free-form metadata associated with the error.
  
  additionalProperties = true
  
  title string
  
  detail string
  
  status string
- traceId string

404

Resource does not exist.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  meta object
  
  Optional free-form metadata associated with the error.
  
  additionalProperties = true
  
  title string
  
  detail string
  
  status string
- traceId string

409

The input request conflicts with the current state of the resource.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  meta object
  
  Optional free-form metadata associated with the error.
  
  additionalProperties = true
  
  title string
  
  detail string
  
  status string
- traceId string

500

Internal Server Error.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  meta object
  
  Optional free-form metadata associated with the error.
  
  additionalProperties = true
  
  title string
  
  detail string
  
  status string
- traceId string

503

Requested service is not available.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  meta object
  
  Optional free-form metadata associated with the error.
  
  additionalProperties = true
  
  title string
  
  detail string
  
  status string
- traceId string

PATCH /api/v1/data-stores/{data-store-id}

import { createQlikApi } from '@qlik/api'

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

await qlik.dataStores.patchDataStore('string', [
  {
    from: 'string',
    op: 'add',
    path: 'string',
    value: {},
  },
])

qlik data-store patch 'string' \
  --op 'add' \
  --path 'string'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/data-stores/{data-store-id}" \
-X PATCH \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '[{"op":"add","from":"string","path":"string","value":{}}]'

Example Response

{
  "id": "string",
  "uri": "string",
  "name": "string",
  "tags": [
    "string"
  ],
  "type": "string",
  "ownerId": "string",
  "spaceId": "string",
  "version": 42,
  "tenantId": "string",
  "createdBy": "string",
  "properties": {},
  "createdTime": "2018-10-30T07:06:22Z",
  "description": "string",
  "technicalName": "string",
  "lastModifiedBy": "string",
  "lastModifiedTime": "2018-10-30T07:06:22Z",
  "technicalDescription": "string"
}

Facts

Rate limit

Tier 2 (100 requests per minute)

Path Parameters

data-store-id string

Required

Request Body

Required

application/json object
Show application/json properties
- id string
  
  Only required when updating the resource. Must be null for new resources.
- uri string
  
  minLength = 0, maxLength = 512
- name string
  
  minLength = 0, maxLength = 255
- tags array of strings
  
  uniqueItems = true
- type string
  
  Required
  
  minLength = 1, maxLength = 64
- ownerId string
  
  The value is automatically set by the application.
- spaceId string
- version integer
  
  Only required when updating the resource. Must be null for new resources.
  
  format = int64
- properties object
  
  A Map of name-value pairs.
  
  Show additional optional properties
  
  object object
  
  A Map of name-value pairs.
- description string
  
  minLength = 0, maxLength = 1024
- technicalName string
  
  Required
  
  minLength = 1, maxLength = 255
- technicalDescription string
  
  minLength = 0, maxLength = 1024

Responses

200

Updated data store successfully.

application/json object
Show application/json properties
- id string
  
  Only required when updating the resource. Must be null for new resources.
- uri string
  
  minLength = 0, maxLength = 512
- name string
  
  minLength = 0, maxLength = 255
- tags array of strings
  
  uniqueItems = true
- type string
  
  Required
  
  minLength = 1, maxLength = 64
- ownerId string
  
  The value is automatically set by the application.
- spaceId string
- version integer
  
  Only required when updating the resource. Must be null for new resources.
  
  format = int64
- tenantId string
  
  The value is automatically set by the application. User defined value is ignored.
- createdBy string
  
  The value is automatically set by the application. User defined value is ignored.
- properties object
  
  A Map of name-value pairs.
  
  Show additional optional properties
  
  object object
  
  A Map of name-value pairs.
- createdTime string
  
  The value is automatically set by the application. User defined value is ignored.
  
  format = "date-time"
- description string
  
  minLength = 0, maxLength = 1024
- technicalName string
  
  Required
  
  minLength = 1, maxLength = 255
- lastModifiedBy string
  
  The value is automatically set by the application. User defined value is ignored.
- lastModifiedTime string
  
  The value is automatically set by the application. User defined value is ignored.
  
  format = "date-time"
- technicalDescription string
  
  minLength = 0, maxLength = 1024

400

The request is in incorrect format.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  meta object
  
  Optional free-form metadata associated with the error.
  
  additionalProperties = true
  
  title string
  
  detail string
  
  status string
- traceId string

401

User does not have valid authentication credentials.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  meta object
  
  Optional free-form metadata associated with the error.
  
  additionalProperties = true
  
  title string
  
  detail string
  
  status string
- traceId string

403

User does not have access to the resource.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  meta object
  
  Optional free-form metadata associated with the error.
  
  additionalProperties = true
  
  title string
  
  detail string
  
  status string
- traceId string

404

Resource does not exist.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  meta object
  
  Optional free-form metadata associated with the error.
  
  additionalProperties = true
  
  title string
  
  detail string
  
  status string
- traceId string

409

The input request conflicts with the current state of the resource.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  meta object
  
  Optional free-form metadata associated with the error.
  
  additionalProperties = true
  
  title string
  
  detail string
  
  status string
- traceId string

500

Internal Server Error.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  meta object
  
  Optional free-form metadata associated with the error.
  
  additionalProperties = true
  
  title string
  
  detail string
  
  status string
- traceId string

503

Requested service is not available.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  meta object
  
  Optional free-form metadata associated with the error.
  
  additionalProperties = true
  
  title string
  
  detail string
  
  status string
- traceId string

PUT /api/v1/data-stores/{data-store-id}

import { createQlikApi } from '@qlik/api'

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

await qlik.dataStores.updateDataStore('string', {
  description: 'string',
  id: 'string',
  name: 'string',
  ownerId: 'string',
  properties: {},
  spaceId: 'string',
  tags: ['string'],
  technicalDescription: 'string',
  technicalName: 'string',
  type: 'string',
  uri: 'string',
  version: 42,
})

qlik data-store update 'string' \
  --technicalName 'string' \
  --type 'string'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/data-stores/{data-store-id}" \
-X PUT \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{"id":"string","uri":"string","name":"string","tags":["string"],"type":"string","ownerId":"string","spaceId":"string","version":42,"properties":{},"description":"string","technicalName":"string","technicalDescription":"string"}'

Example Response

{
  "id": "string",
  "uri": "string",
  "name": "string",
  "tags": [
    "string"
  ],
  "type": "string",
  "ownerId": "string",
  "spaceId": "string",
  "version": 42,
  "tenantId": "string",
  "createdBy": "string",
  "properties": {},
  "createdTime": "2018-10-30T07:06:22Z",
  "description": "string",
  "technicalName": "string",
  "lastModifiedBy": "string",
  "lastModifiedTime": "2018-10-30T07:06:22Z",
  "technicalDescription": "string"
}

Facts

Rate limit

Tier 1 (1000 requests per minute)

Query Parameters

limit integer

Page size limit.

maximum = 100, default = 20, format = int32, default = 20
page integer

default = 0, format = int32, default = 0
projections array of strings

Comma-separated fields to return in the response.
sort array of strings

Comma-separated fields and field start with '-' character sorts the result set in descending order.

Path Parameters

data-store-ids array of strings

Required

Comma-separated data store IDs or * to include all data stores.

Responses

200

Successful Operation

application/json object
Show application/json properties
- data array of objects
  
  Show data properties
  
  id string
  
  Only required when updating the resource. Must be null for new resources.
  
  name string
  
  minLength = 0, maxLength = 255
  
  tags array of strings
  
  uniqueItems = true
  
  appId string
  
  appType string
  
  Required
  
  ownerId string
  
  The value is automatically set by the application.
  
  spaceId string
  
  version integer
  
  Only required when updating the resource. Must be null for new resources.
  
  format = int64
  
  tenantId string
  
  The value is automatically set by the application. User defined value is ignored.
  
  createdBy string
  
  The value is automatically set by the application. User defined value is ignored.
  
  properties object
  
  A Map of name-value pairs.
  
  Show additional optional properties
  
  object object
  
  A Map of name-value pairs.
  
  createdTime string
  
  The value is automatically set by the application. User defined value is ignored.
  
  format = "date-time"
  
  description string
  
  minLength = 0, maxLength = 1024
  
  dataFreshness string
  
  The date-time when the source data was last changed
  
  format = "date-time"
  
  dataStoreInfo object
  
  Show dataStoreInfo properties
  
  id string
  
  Required
  
  name string
  
  type string
  
  technicalName string
  
  Required
  
  minLength = 1, maxLength = 255
  
  lastModifiedBy string
  
  The value is automatically set by the application. User defined value is ignored.
  
  lastModifiedTime string
  
  The value is automatically set by the application. User defined value is ignored.
  
  format = "date-time"
  
  technicalDescription string
  
  minLength = 0, maxLength = 1024
- page integer
  
  format = int32
- limit integer
  
  format = int32
- links object
  
  Show links properties
  
  last object
  
  Show last properties
  
  href string
  
  next object
  
  Show next properties
  
  href string
  
  prev object
  
  Show prev properties
  
  href string
  
  self object
  
  Show self properties
  
  href string
  
  first object
  
  Show first properties
  
  href string
- pages integer
  
  format = int32
- total integer
  
  format = int64

400

The request is in incorrect format.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  meta object
  
  Optional free-form metadata associated with the error.
  
  additionalProperties = true
  
  title string
  
  detail string
  
  status string
- traceId string

401

User does not have valid authentication credentials.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  meta object
  
  Optional free-form metadata associated with the error.
  
  additionalProperties = true
  
  title string
  
  detail string
  
  status string
- traceId string

403

User does not have access to the resource.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  meta object
  
  Optional free-form metadata associated with the error.
  
  additionalProperties = true
  
  title string
  
  detail string
  
  status string
- traceId string

404

Resource does not exist.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  meta object
  
  Optional free-form metadata associated with the error.
  
  additionalProperties = true
  
  title string
  
  detail string
  
  status string
- traceId string

409

The input request conflicts with the current state of the resource.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  meta object
  
  Optional free-form metadata associated with the error.
  
  additionalProperties = true
  
  title string
  
  detail string
  
  status string
- traceId string

500

Internal Server Error.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  meta object
  
  Optional free-form metadata associated with the error.
  
  additionalProperties = true
  
  title string
  
  detail string
  
  status string
- traceId string

503

Requested service is not available.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  meta object
  
  Optional free-form metadata associated with the error.
  
  additionalProperties = true
  
  title string
  
  detail string
  
  status string
- traceId string

GET /api/v1/data-stores/{data-store-ids}/data-assets

import { createQlikApi } from '@qlik/api'

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

await qlik.dataStores.getDataStoreDataAssets(
  'value',
  {},
)

qlik data-store data-asset ls 'value'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/data-stores/{data-store-ids}/data-assets" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "data": [
    {
      "id": "string",
      "name": "string",
      "tags": [
        "string"
      ],
      "appId": "string",
      "appType": "string",
      "ownerId": "string",
      "spaceId": "string",
      "version": 42,
      "tenantId": "string",
      "createdBy": "string",
      "properties": {},
      "createdTime": "2018-10-30T07:06:22Z",
      "description": "string",
      "dataFreshness": "2018-10-30T07:06:22Z",
      "dataStoreInfo": {
        "id": "string",
        "name": "string",
        "type": "string"
      },
      "technicalName": "string",
      "lastModifiedBy": "string",
      "lastModifiedTime": "2018-10-30T07:06:22Z",
      "technicalDescription": "string"
    }
  ],
  "page": 42,
  "limit": 42,
  "links": {
    "last": {
      "href": "string"
    },
    "next": {
      "href": "string"
    },
    "prev": {
      "href": "string"
    },
    "self": {
      "href": "string"
    },
    "first": {
      "href": "string"
    }
  },
  "pages": 42,
  "total": 42
}

Facts

Rate limit

Tier 2 (100 requests per minute)

Path Parameters

data-store-ids array of strings

Required

Comma-separated data store IDs or * to include all data stores.

Responses

204

Deleted data assets successfully.

400

The request is in incorrect format.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  meta object
  
  Optional free-form metadata associated with the error.
  
  additionalProperties = true
  
  title string
  
  detail string
  
  status string
- traceId string

401

User does not have valid authentication credentials.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  meta object
  
  Optional free-form metadata associated with the error.
  
  additionalProperties = true
  
  title string
  
  detail string
  
  status string
- traceId string

403

User does not have access to the resource.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  meta object
  
  Optional free-form metadata associated with the error.
  
  additionalProperties = true
  
  title string
  
  detail string
  
  status string
- traceId string

404

Resource does not exist.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  meta object
  
  Optional free-form metadata associated with the error.
  
  additionalProperties = true
  
  title string
  
  detail string
  
  status string
- traceId string

409

The input request conflicts with the current state of the resource.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  meta object
  
  Optional free-form metadata associated with the error.
  
  additionalProperties = true
  
  title string
  
  detail string
  
  status string
- traceId string

500

Internal Server Error.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  meta object
  
  Optional free-form metadata associated with the error.
  
  additionalProperties = true
  
  title string
  
  detail string
  
  status string
- traceId string

503

Requested service is not available.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  meta object
  
  Optional free-form metadata associated with the error.
  
  additionalProperties = true
  
  title string
  
  detail string
  
  status string
- traceId string

DELETE /api/v1/data-stores/{data-store-ids}/data-assets

import { createQlikApi } from '@qlik/api'

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

await qlik.dataStores.deleteDataStoreDataAssets(
  'value',
)

qlik data-store data-asset delete-many 'value'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/data-stores/{data-store-ids}/data-assets" \
-X DELETE \
-H "Authorization: Bearer <access_token>"

Facts

Rate limit

Tier 1 (1000 requests per minute)

Query Parameters

limit integer

Page size limit.

maximum = 100, default = 20, format = int32, default = 20
page integer

default = 0, format = int32, default = 0
projections array of strings

Comma-separated fields to return in the response.
sort array of strings

Comma-separated fields and field start with '-' character sorts the result set in descending order.

Path Parameters

data-asset-ids array of strings

Required

Comma-separated data asset IDs or * to include all data assets.
data-store-ids array of strings

Required

Comma-separated data store IDs or * to include all data stores.

Responses

200

Successful Operation.

application/json object
Show application/json properties
- data array of objects
  
  Show data properties
  
  id string
  
  Only required when updating the resource. Must be null for new resources.
  
  qri string
  
  Required
  
  NOTE: this will be deprecated after migration to secureQri. Required user defined field. All the parts in the format must be separated by ':'. The first part denotes the resourceType, followed by dataStoreType and tenant guid. The spaceGuid or userGuid is to be populated based on if the dataset is in shared or private space and finally the full file name. This field is auto populated for the dataSet generated for qix-datafiles.
  
  minLength = 8, maxLength = 1024, format = "qdf:<store-type>:<tenant-guid>:<<uid@/sid@>user/space guid>:<path-to-file>"
  
  name string
  
  minLength = 0, maxLength = 255
  
  tags array of strings
  
  uniqueItems = true
  
  type string
  
  schema object
  
  Optional field to specify additional schemas for files where multiple tables or sheets are available. User must define primary schema in 'schema' attribute and rest of the sheets/ tables can be defined using this field. This field is not populated for the dataSets with single schema
  
  Show schema properties
  
  anomalies array of strings
  
  Anomalies associated with this schema. Example: $warning-unknown-headers
  
  uniqueItems = true
  
  dataFields array of objects
  
  Required
  
  Show dataFields properties
  
  name string
  
  Required
  
  minLength = 1, maxLength = 255
  
  tags array of strings
  
  An array of system tags
  
  uniqueItems = true
  
  alias string
  
  Alias of the field. Must be unique within the schema and must not match another field's name. Returns 400 if violated.
  
  index integer
  
  format = int32
  
  orphan boolean
  
  dataType object
  
  Required
  
  Show dataType properties
  
  type string
  
  Required
  
  Each datatype may vary in terms of required properties. Example: Datatype DECIMAL requires two mandatory properties to be defined - precision and scale, each one accepts integer value. All other datatypes does not have any required properties.
  
  Can be one of: "DATE""TIME""DATETIME""TIMESTAMP""STRING""DOUBLE""DECIMAL""INTEGER""BOOLEAN""BINARY""CUSTOM"
  
  properties object
  
  The properties map key is string and the value is of type object. Please note, Datatype DECIMAL requires two mandatory properties to be defined; these properties must be named: precision and scale, each of these property accepts integer value. All other datatypes does not require any manadatory properties to be defined.
  
  Show additional optional properties
  
  object object
  
  The properties map key is string and the value is of type object. Please note, Datatype DECIMAL requires two mandatory properties to be defined; these properties must be named: precision and scale, each of these property accepts integer value. All other datatypes does not require any manadatory properties to be defined.
  
  originalType string
  
  nullable boolean
  
  userTags array of objects
  
  An array of user-supplied tags
  
  uniqueItems = true
  
  Show userTags properties
  
  id string
  
  The id of the tag in Collections
  
  name string
  
  minLength = 1, maxLength = 128
  
  encrypted boolean
  
  sensitive boolean
  
  primaryKey boolean
  
  properties object
  
  Show additional optional properties
  
  object object
  
  description string
  
  ordinalPositionInKey integer
  
  format = int32
  
  schemaName string
  
  loadOptions object
  
  Options for loading files. Example: "qLabel": "embedded labels"
  
  Show additional optional properties
  
  object object
  
  Options for loading files. Example: "qLabel": "embedded labels"
  
  effectiveDate string
  
  format = "date-time"
  
  overrideSchemaAnomalies boolean
  
  ownerId string
  
  The value is automatically set by the application.
  
  spaceId string
  
  version integer
  
  Only required when updating the resource. Must be null for new resources.
  
  format = int64
  
  tenantId string
  
  The value is automatically set by the application. User defined value is ignored.
  
  createdBy string
  
  The value is automatically set by the application. User defined value is ignored.
  
  secureQri string
  
  Required
  
  properties object
  
  A Map of name-value pairs.
  
  Show additional optional properties
  
  object object
  
  A Map of name-value pairs.
  
  createdTime string
  
  The value is automatically set by the application. User defined value is ignored.
  
  format = "date-time"
  
  description string
  
  minLength = 0, maxLength = 1024
  
  operational object
  
  Show operational properties
  
  size integer
  
  format = int64
  
  status string
  
  endDate string
  
  format = "date-time"
  
  location string
  
  rowCount integer
  
  format = int64
  
  startDate string
  
  format = "date-time"
  
  logMessage string
  
  tableOwner string
  
  lastLoadTime string
  
  format = "date-time"
  
  contentUpdated boolean
  
  lastUpdateTime string
  
  format = "date-time"
  
  tableConnectionInfo object
  
  Show tableConnectionInfo properties
  
  tableName string
  
  selectionScript string
  
  additionalProperties object
  
  Show additional optional properties
  
  string string
  
  dataAssetInfo object
  
  Required
  
  Show dataAssetInfo properties
  
  id string
  
  Required
  
  name string
  
  dataStoreInfo object
  
  Show dataStoreInfo properties
  
  id string
  
  Required
  
  name string
  
  type string
  
  technicalName string
  
  Required
  
  minLength = 1, maxLength = 255
  
  lastModifiedBy string
  
  The value is automatically set by the application. User defined value is ignored.
  
  appTypeOverride string
  
  Optional override of DataAsset appType.
  
  lastModifiedTime string
  
  The value is automatically set by the application. User defined value is ignored.
  
  format = "date-time"
  
  additionalSchemas array of objects
  
  Optional field to specify additional schemas for files where multiple tables or sheets are available. User must define primary schema in 'schema' attribute and rest of the sheets/ tables can be defined using this field. This field is not populated for the dataSets with single schema
  
  Show additionalSchemas properties
  
  anomalies array of strings
  
  Anomalies associated with this schema. Example: $warning-unknown-headers
  
  uniqueItems = true
  
  dataFields array of objects
  
  Required
  
  Show dataFields properties
  
  name string
  
  Required
  
  minLength = 1, maxLength = 255
  
  tags array of strings
  
  An array of system tags
  
  uniqueItems = true
  
  alias string
  
  Alias of the field. Must be unique within the schema and must not match another field's name. Returns 400 if violated.
  
  index integer
  
  format = int32
  
  orphan boolean
  
  dataType object
  
  Required
  
  Show dataType properties
  
  type string
  
  Required
  
  Each datatype may vary in terms of required properties. Example: Datatype DECIMAL requires two mandatory properties to be defined - precision and scale, each one accepts integer value. All other datatypes does not have any required properties.
  
  Can be one of: "DATE""TIME""DATETIME""TIMESTAMP""STRING""DOUBLE""DECIMAL""INTEGER""BOOLEAN""BINARY""CUSTOM"
  
  properties object
  
  The properties map key is string and the value is of type object. Please note, Datatype DECIMAL requires two mandatory properties to be defined; these properties must be named: precision and scale, each of these property accepts integer value. All other datatypes does not require any manadatory properties to be defined.
  
  Show additional optional properties
  
  object object
  
  The properties map key is string and the value is of type object. Please note, Datatype DECIMAL requires two mandatory properties to be defined; these properties must be named: precision and scale, each of these property accepts integer value. All other datatypes does not require any manadatory properties to be defined.
  
  originalType string
  
  nullable boolean
  
  userTags array of objects
  
  An array of user-supplied tags
  
  uniqueItems = true
  
  Show userTags properties
  
  id string
  
  The id of the tag in Collections
  
  name string
  
  minLength = 1, maxLength = 128
  
  encrypted boolean
  
  sensitive boolean
  
  primaryKey boolean
  
  properties object
  
  Show additional optional properties
  
  object object
  
  description string
  
  ordinalPositionInKey integer
  
  format = int32
  
  schemaName string
  
  loadOptions object
  
  Options for loading files. Example: "qLabel": "embedded labels"
  
  Show additional optional properties
  
  object object
  
  Options for loading files. Example: "qLabel": "embedded labels"
  
  effectiveDate string
  
  format = "date-time"
  
  overrideSchemaAnomalies boolean
  
  technicalDescription string
  
  minLength = 0, maxLength = 1024
  
  createdByConnectionId string
  
  The connectionId that created the Dataset. Optional.
- page integer
  
  format = int32
- limit integer
  
  format = int32
- links object
  
  Show links properties
  
  last object
  
  Show last properties
  
  href string
  
  next object
  
  Show next properties
  
  href string
  
  prev object
  
  Show prev properties
  
  href string
  
  self object
  
  Show self properties
  
  href string
  
  first object
  
  Show first properties
  
  href string
- pages integer
  
  format = int32
- total integer
  
  format = int64

400

The request is in incorrect format.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  meta object
  
  Optional free-form metadata associated with the error.
  
  additionalProperties = true
  
  title string
  
  detail string
  
  status string
- traceId string

401

User does not have valid authentication credentials.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  meta object
  
  Optional free-form metadata associated with the error.
  
  additionalProperties = true
  
  title string
  
  detail string
  
  status string
- traceId string

403

User does not have access to the resource.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  meta object
  
  Optional free-form metadata associated with the error.
  
  additionalProperties = true
  
  title string
  
  detail string
  
  status string
- traceId string

404

Resource does not exist.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  meta object
  
  Optional free-form metadata associated with the error.
  
  additionalProperties = true
  
  title string
  
  detail string
  
  status string
- traceId string

409

The input request conflicts with the current state of the resource.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  meta object
  
  Optional free-form metadata associated with the error.
  
  additionalProperties = true
  
  title string
  
  detail string
  
  status string
- traceId string

500

Internal Server Error.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  meta object
  
  Optional free-form metadata associated with the error.
  
  additionalProperties = true
  
  title string
  
  detail string
  
  status string
- traceId string

503

Requested service is not available.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  meta object
  
  Optional free-form metadata associated with the error.
  
  additionalProperties = true
  
  title string
  
  detail string
  
  status string
- traceId string

GET /api/v1/data-stores/{data-store-ids}/data-assets/{data-asset-ids}/data-sets

import { createQlikApi } from '@qlik/api'

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

await qlik.dataStores.getDataStoreDataAssetDataSets(
  'value',
  'value',
  {},
)

qlik data-store data-asset data-set ls \
  --data-store-ids 'value' \
  --data-asset-ids 'value'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/data-stores/{data-store-ids}/data-assets/{data-asset-ids}/data-sets" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "data": [
    {
      "id": "string",
      "qri": "string",
      "name": "string",
      "tags": [
        "string"
      ],
      "type": "string",
      "schema": {
        "anomalies": [
          "string"
        ],
        "dataFields": [
          {
            "name": "string",
            "tags": [
              "string"
            ],
            "alias": "string",
            "index": 42,
            "orphan": true,
            "dataType": {
              "type": "DATE",
              "properties": {},
              "originalType": "string"
            },
            "nullable": true,
            "userTags": [
              {
                "id": "string",
                "name": "string"
              }
            ],
            "encrypted": true,
            "sensitive": true,
            "primaryKey": true,
            "properties": {},
            "description": "string",
            "ordinalPositionInKey": 42
          }
        ],
        "schemaName": "string",
        "loadOptions": {},
        "effectiveDate": "2018-10-30T07:06:22Z",
        "overrideSchemaAnomalies": true
      },
      "ownerId": "string",
      "spaceId": "string",
      "version": 42,
      "tenantId": "string",
      "createdBy": "string",
      "secureQri": "string",
      "properties": {},
      "createdTime": "2018-10-30T07:06:22Z",
      "description": "string",
      "operational": {
        "size": 42,
        "status": "string",
        "endDate": "2018-10-30T07:06:22Z",
        "location": "string",
        "rowCount": 42,
        "startDate": "2018-10-30T07:06:22Z",
        "logMessage": "string",
        "tableOwner": "string",
        "lastLoadTime": "2018-10-30T07:06:22Z",
        "contentUpdated": true,
        "lastUpdateTime": "2018-10-30T07:06:22Z",
        "tableConnectionInfo": {
          "tableName": "string",
          "selectionScript": "string",
          "additionalProperties": {}
        }
      },
      "dataAssetInfo": {
        "id": "string",
        "name": "string",
        "dataStoreInfo": {
          "id": "string",
          "name": "string",
          "type": "string"
        }
      },
      "technicalName": "string",
      "lastModifiedBy": "string",
      "appTypeOverride": "string",
      "lastModifiedTime": "2018-10-30T07:06:22Z",
      "additionalSchemas": [
        {
          "anomalies": [
            "string"
          ],
          "dataFields": [
            {
              "name": "string",
              "tags": [
                "string"
              ],
              "alias": "string",
              "index": 42,
              "orphan": true,
              "dataType": {
                "type": "DATE",
                "properties": {},
                "originalType": "string"
              },
              "nullable": true,
              "userTags": [
                {
                  "id": "string",
                  "name": "string"
                }
              ],
              "encrypted": true,
              "sensitive": true,
              "primaryKey": true,
              "properties": {},
              "description": "string",
              "ordinalPositionInKey": 42
            }
          ],
          "schemaName": "string",
          "loadOptions": {},
          "effectiveDate": "2018-10-30T07:06:22Z",
          "overrideSchemaAnomalies": true
        }
      ],
      "technicalDescription": "string",
      "createdByConnectionId": "string"
    }
  ],
  "page": 42,
  "limit": 42,
  "links": {
    "last": {
      "href": "string"
    },
    "next": {
      "href": "string"
    },
    "prev": {
      "href": "string"
    },
    "self": {
      "href": "string"
    },
    "first": {
      "href": "string"
    }
  },
  "pages": 42,
  "total": 42
}

Facts

Rate limit

Tier 2 (100 requests per minute)

Path Parameters

data-asset-ids array of strings

Required

Comma-separated data asset IDs or * to include all data assets.
data-store-ids array of strings

Required

Comma-separated data store IDs or * to include all data stores.

Responses

204

Deleted data sets.

400

The request is in incorrect format.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  meta object
  
  Optional free-form metadata associated with the error.
  
  additionalProperties = true
  
  title string
  
  detail string
  
  status string
- traceId string

401

User does not have valid authentication credentials.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  meta object
  
  Optional free-form metadata associated with the error.
  
  additionalProperties = true
  
  title string
  
  detail string
  
  status string
- traceId string

403

User does not have access to the resource.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  meta object
  
  Optional free-form metadata associated with the error.
  
  additionalProperties = true
  
  title string
  
  detail string
  
  status string
- traceId string

404

Resource does not exist.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  meta object
  
  Optional free-form metadata associated with the error.
  
  additionalProperties = true
  
  title string
  
  detail string
  
  status string
- traceId string

409

The input request conflicts with the current state of the resource.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  meta object
  
  Optional free-form metadata associated with the error.
  
  additionalProperties = true
  
  title string
  
  detail string
  
  status string
- traceId string

500

Internal Server Error.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  meta object
  
  Optional free-form metadata associated with the error.
  
  additionalProperties = true
  
  title string
  
  detail string
  
  status string
- traceId string

503

Requested service is not available.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  meta object
  
  Optional free-form metadata associated with the error.
  
  additionalProperties = true
  
  title string
  
  detail string
  
  status string
- traceId string

DELETE /api/v1/data-stores/{data-store-ids}/data-assets/{data-asset-ids}/data-sets

import { createQlikApi } from '@qlik/api'

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

await qlik.dataStores.deleteDataStoreDataAssetDataSets(
  'value',
  'value',
)

qlik data-store data-asset data-set delete-many \
  --data-store-ids 'value' \
  --data-asset-ids 'value'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/data-stores/{data-store-ids}/data-assets/{data-asset-ids}/data-sets" \
-X DELETE \
-H "Authorization: Bearer <access_token>"

Data stores

Endpoints

Get all data stores.

Facts

Query Parameters

Responses

200

400

401

403

404

409

500

503

Example Response

Save new data store.

Facts

Request Body

Responses

201

400

401

403

404

409

500

503

Example Response

Delete data stores if it does not contain any data-assets.

Facts

Request Body

Responses

204

400

401

403

404

409

500

503

Get data store by ID.

Facts

Query Parameters

Path Parameters

Responses

200

400

401

403

404

409

500

503

Example Response

Patch data store.

Facts

Path Parameters

Request Body

Responses

200

204

400

401

403

404

409

500

503

Example Response

Update data store.

Facts

Path Parameters

Request Body

Responses

200

400

401

403

404

409