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 specification

Get all data stores.

Facts

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

Query Parameters

  • limitinteger

    Page size limit.

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

  • pageinteger

    default = 0, format = int32, default = 0

  • projectionsarray of strings

    Comma-separated fields to return in the response.

  • sortarray of strings

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

Responses

200

Successful Operation

  • application/jsonobject
    Show application/json properties
    • dataarray of objects
      Show data properties
      • idstring

        Only required when updating the resource. Must be null for new resources.

      • uristring

        minLength = 0, maxLength = 512

      • namestring

        minLength = 0, maxLength = 255

      • tagsarray of strings

        uniqueItems = true

      • typestring
        Required

        minLength = 1, maxLength = 64

      • ownerIdstring

        The value is automatically set by the application.

      • spaceIdstring
      • versioninteger

        Only required when updating the resource. Must be null for new resources.

        format = int64

      • tenantIdstring

        The value is automatically set by the application. User defined value is ignored.

      • createdBystring

        The value is automatically set by the application. User defined value is ignored.

      • propertiesobject

        A Map of name-value pairs.

        additional properties

      • createdTimestring

        The value is automatically set by the application. User defined value is ignored.

        format = "date-time"

      • descriptionstring

        minLength = 0, maxLength = 1024

      • technicalNamestring
        Required

        minLength = 1, maxLength = 255

      • lastModifiedBystring

        The value is automatically set by the application. User defined value is ignored.

      • lastModifiedTimestring

        The value is automatically set by the application. User defined value is ignored.

        format = "date-time"

      • technicalDescriptionstring

        minLength = 0, maxLength = 1024

    • pageinteger

      format = int32

    • limitinteger

      format = int32

    • linksobject
      Show links properties
      • lastobject
        Show last properties
        • hrefstring
      • nextobject
        Show next properties
        • hrefstring
      • prevobject
        Show prev properties
        • hrefstring
      • selfobject
        Show self properties
        • hrefstring
      • firstobject
        Show first properties
        • hrefstring
    • pagesinteger

      format = int32

    • totalinteger

      format = int64

400

The request is in incorrect format.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
      • statusstring
    • traceIdstring

401

User does not have valid authentication credentials.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
      • statusstring
    • traceIdstring

403

User does not have access to the resource.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
      • statusstring
    • traceIdstring

404

Resource does not exist.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
      • statusstring
    • traceIdstring

409

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

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
      • statusstring
    • traceIdstring

500

Internal Server Error.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
      • statusstring
    • traceIdstring

503

Requested service is not available.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
      • statusstring
    • traceIdstring
GET /api/v1/data-stores 
curl "https://your-tenant.us.qlikcloud.com/api/v1/data-stores" \
-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/data-stores',
    'method': 'GET',
    'headers': {
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)
This API is not included yet in qlik-cli

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
}

Save new data store.

Facts

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

Request Body

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

      Only required when updating the resource. Must be null for new resources.

    • uristring

      minLength = 0, maxLength = 512

    • namestring

      minLength = 0, maxLength = 255

    • tagsarray of strings

      uniqueItems = true

    • typestring
      Required

      minLength = 1, maxLength = 64

    • ownerIdstring

      The value is automatically set by the application.

    • spaceIdstring
    • versioninteger

      Only required when updating the resource. Must be null for new resources.

      format = int64

    • propertiesobject

      A Map of name-value pairs.

      additional properties

    • descriptionstring

      minLength = 0, maxLength = 1024

    • technicalNamestring
      Required

      minLength = 1, maxLength = 255

    • technicalDescriptionstring

      minLength = 0, maxLength = 1024

Responses

201

Created new data store successfully.

  • application/jsonobject
    Show application/json properties
    • idstring

      Only required when updating the resource. Must be null for new resources.

    • uristring

      minLength = 0, maxLength = 512

    • namestring

      minLength = 0, maxLength = 255

    • tagsarray of strings

      uniqueItems = true

    • typestring
      Required

      minLength = 1, maxLength = 64

    • ownerIdstring

      The value is automatically set by the application.

    • spaceIdstring
    • versioninteger

      Only required when updating the resource. Must be null for new resources.

      format = int64

    • tenantIdstring

      The value is automatically set by the application. User defined value is ignored.

    • createdBystring

      The value is automatically set by the application. User defined value is ignored.

    • propertiesobject

      A Map of name-value pairs.

      additional properties

    • createdTimestring

      The value is automatically set by the application. User defined value is ignored.

      format = "date-time"

    • descriptionstring

      minLength = 0, maxLength = 1024

    • technicalNamestring
      Required

      minLength = 1, maxLength = 255

    • lastModifiedBystring

      The value is automatically set by the application. User defined value is ignored.

    • lastModifiedTimestring

      The value is automatically set by the application. User defined value is ignored.

      format = "date-time"

    • technicalDescriptionstring

      minLength = 0, maxLength = 1024

400

The request is in incorrect format.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
      • statusstring
    • traceIdstring

401

User does not have valid authentication credentials.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
      • statusstring
    • traceIdstring

403

User does not have access to the resource.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
      • statusstring
    • traceIdstring

404

Resource does not exist.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
      • statusstring
    • traceIdstring

409

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

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
      • statusstring
    • traceIdstring

500

Internal Server Error.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
      • statusstring
    • traceIdstring

503

Requested service is not available.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
      • statusstring
    • traceIdstring
POST /api/v1/data-stores 
curl "https://your-tenant.us.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"}'
const https = require('https')
  const data = JSON.stringify({"id":"string","uri":"string","name":"string","tags":["string"],"type":"string","ownerId":"string","spaceId":"string","version":42,"properties":{},"description":"string","technicalName":"string","technicalDescription":"string"})
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/data-stores',
    '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

{
  "id": "string",
  "uri": "string",
  "name": "string",
  "tags": [
    "string"
  ],
  "type": "string",
  "ownerId": "string",
  "spaceId": "string",
  "version": 42,
  "properties": {},
  "description": "string",
  "technicalName": "string",
  "technicalDescription": "string"
}

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

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

Facts

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

Request Body

Required
  • application/jsonobject
    Show application/json properties
    • idsarray of strings

      uniqueItems = true

Responses

204

Deleted empty data stores.

400

The request is in incorrect format.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
      • statusstring
    • traceIdstring

401

User does not have valid authentication credentials.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
      • statusstring
    • traceIdstring

403

User does not have access to the resource.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
      • statusstring
    • traceIdstring

404

Resource does not exist.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
      • statusstring
    • traceIdstring

409

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

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
      • statusstring
    • traceIdstring

500

Internal Server Error.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
      • statusstring
    • traceIdstring

503

Requested service is not available.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
      • statusstring
    • traceIdstring
DELETE /api/v1/data-stores 
curl "https://your-tenant.us.qlikcloud.com/api/v1/data-stores" \
-X DELETE \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{"ids":["string"]}'
const https = require('https')
  const data = JSON.stringify({"ids":["string"]})
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/data-stores',
    'method': 'DELETE',
    '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

{
  "ids": [
    "string"
  ]
}

Get data store by ID.

Facts

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

Query Parameters

  • projectionsarray of strings

    Comma-separated fields to return in the response.

Path Parameters

  • data-store-idstring
    Required

Responses

200

Successful Operation.

  • application/jsonobject
    Show application/json properties
    • idstring

      Only required when updating the resource. Must be null for new resources.

    • uristring

      minLength = 0, maxLength = 512

    • namestring

      minLength = 0, maxLength = 255

    • tagsarray of strings

      uniqueItems = true

    • typestring
      Required

      minLength = 1, maxLength = 64

    • ownerIdstring

      The value is automatically set by the application.

    • spaceIdstring
    • versioninteger

      Only required when updating the resource. Must be null for new resources.

      format = int64

    • tenantIdstring

      The value is automatically set by the application. User defined value is ignored.

    • createdBystring

      The value is automatically set by the application. User defined value is ignored.

    • propertiesobject

      A Map of name-value pairs.

      additional properties

    • createdTimestring

      The value is automatically set by the application. User defined value is ignored.

      format = "date-time"

    • descriptionstring

      minLength = 0, maxLength = 1024

    • technicalNamestring
      Required

      minLength = 1, maxLength = 255

    • lastModifiedBystring

      The value is automatically set by the application. User defined value is ignored.

    • lastModifiedTimestring

      The value is automatically set by the application. User defined value is ignored.

      format = "date-time"

    • technicalDescriptionstring

      minLength = 0, maxLength = 1024

400

The request is in incorrect format.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
      • statusstring
    • traceIdstring

401

User does not have valid authentication credentials.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
      • statusstring
    • traceIdstring

403

User does not have access to the resource.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
      • statusstring
    • traceIdstring

404

Resource does not exist.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
      • statusstring
    • traceIdstring

409

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

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
      • statusstring
    • traceIdstring

500

Internal Server Error.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
      • statusstring
    • traceIdstring

503

Requested service is not available.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
      • statusstring
    • traceIdstring
GET /api/v1/data-stores/{data-store-id} 
curl "https://your-tenant.us.qlikcloud.com/api/v1/data-stores/{data-store-id}" \
-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/data-stores/{data-store-id}',
    'method': 'GET',
    'headers': {
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)
This API is not included yet in qlik-cli

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

Patch data store.

Facts

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

Path Parameters

  • data-store-idstring
    Required

Request Body

Required
  • application/jsonarray of objects

    Array of JSON patch documents as defined by RFC 6902.

    Show application/json properties
    • opstring
      Required

      The operation to be performed.

      Can be one of: "add""remove""replace""move""copy""test"

    • fromstring

      A JSON Pointer path pointing to the location to move/copy from.

    • pathstring
      Required

      A JSON pointer to the property being affected.

    • valueobject

      The value to add, replace or test.

Responses

200

Patched data store successfully.

  • application/jsonobject
    Show application/json properties
    • idstring

      Only required when updating the resource. Must be null for new resources.

    • uristring

      minLength = 0, maxLength = 512

    • namestring

      minLength = 0, maxLength = 255

    • tagsarray of strings

      uniqueItems = true

    • typestring
      Required

      minLength = 1, maxLength = 64

    • ownerIdstring

      The value is automatically set by the application.

    • spaceIdstring
    • versioninteger

      Only required when updating the resource. Must be null for new resources.

      format = int64

    • tenantIdstring

      The value is automatically set by the application. User defined value is ignored.

    • createdBystring

      The value is automatically set by the application. User defined value is ignored.

    • propertiesobject

      A Map of name-value pairs.

      additional properties

    • createdTimestring

      The value is automatically set by the application. User defined value is ignored.

      format = "date-time"

    • descriptionstring

      minLength = 0, maxLength = 1024

    • technicalNamestring
      Required

      minLength = 1, maxLength = 255

    • lastModifiedBystring

      The value is automatically set by the application. User defined value is ignored.

    • lastModifiedTimestring

      The value is automatically set by the application. User defined value is ignored.

      format = "date-time"

    • technicalDescriptionstring

      minLength = 0, maxLength = 1024

204

Patched data store successfully.

  • application/jsonobject
    Show application/json properties
    • idstring

      Only required when updating the resource. Must be null for new resources.

    • uristring

      minLength = 0, maxLength = 512

    • namestring

      minLength = 0, maxLength = 255

    • tagsarray of strings

      uniqueItems = true

    • typestring
      Required

      minLength = 1, maxLength = 64

    • ownerIdstring

      The value is automatically set by the application.

    • spaceIdstring
    • versioninteger

      Only required when updating the resource. Must be null for new resources.

      format = int64

    • tenantIdstring

      The value is automatically set by the application. User defined value is ignored.

    • createdBystring

      The value is automatically set by the application. User defined value is ignored.

    • propertiesobject

      A Map of name-value pairs.

      additional properties

    • createdTimestring

      The value is automatically set by the application. User defined value is ignored.

      format = "date-time"

    • descriptionstring

      minLength = 0, maxLength = 1024

    • technicalNamestring
      Required

      minLength = 1, maxLength = 255

    • lastModifiedBystring

      The value is automatically set by the application. User defined value is ignored.

    • lastModifiedTimestring

      The value is automatically set by the application. User defined value is ignored.

      format = "date-time"

    • technicalDescriptionstring

      minLength = 0, maxLength = 1024

400

The request is in incorrect format.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
      • statusstring
    • traceIdstring

401

User does not have valid authentication credentials.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
      • statusstring
    • traceIdstring

403

User does not have access to the resource.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
      • statusstring
    • traceIdstring

404

Resource does not exist.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
      • statusstring
    • traceIdstring

409

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

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
      • statusstring
    • traceIdstring

500

Internal Server Error.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
      • statusstring
    • traceIdstring

503

Requested service is not available.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
      • statusstring
    • traceIdstring
PATCH /api/v1/data-stores/{data-store-id} 
curl "https://your-tenant.us.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":{}}]'
const https = require('https')
  const data = JSON.stringify([{"op":"add","from":"string","path":"string","value":{}}])
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/data-stores/{data-store-id}',
    'method': 'PATCH',
    '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

[
  {
    "op": "add",
    "from": "string",
    "path": "string",
    "value": {}
  }
]

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

Update data store.

Facts

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

Path Parameters

  • data-store-idstring
    Required

Request Body

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

      Only required when updating the resource. Must be null for new resources.

    • uristring

      minLength = 0, maxLength = 512

    • namestring

      minLength = 0, maxLength = 255

    • tagsarray of strings

      uniqueItems = true

    • typestring
      Required

      minLength = 1, maxLength = 64

    • ownerIdstring

      The value is automatically set by the application.

    • spaceIdstring
    • versioninteger

      Only required when updating the resource. Must be null for new resources.

      format = int64

    • propertiesobject

      A Map of name-value pairs.

      additional properties

    • descriptionstring

      minLength = 0, maxLength = 1024

    • technicalNamestring
      Required

      minLength = 1, maxLength = 255

    • technicalDescriptionstring

      minLength = 0, maxLength = 1024

Responses

200

Updated data store successfully.

  • application/jsonobject
    Show application/json properties
    • idstring

      Only required when updating the resource. Must be null for new resources.

    • uristring

      minLength = 0, maxLength = 512

    • namestring

      minLength = 0, maxLength = 255

    • tagsarray of strings

      uniqueItems = true

    • typestring
      Required

      minLength = 1, maxLength = 64

    • ownerIdstring

      The value is automatically set by the application.

    • spaceIdstring
    • versioninteger

      Only required when updating the resource. Must be null for new resources.

      format = int64

    • tenantIdstring

      The value is automatically set by the application. User defined value is ignored.

    • createdBystring

      The value is automatically set by the application. User defined value is ignored.

    • propertiesobject

      A Map of name-value pairs.

      additional properties

    • createdTimestring

      The value is automatically set by the application. User defined value is ignored.

      format = "date-time"

    • descriptionstring

      minLength = 0, maxLength = 1024

    • technicalNamestring
      Required

      minLength = 1, maxLength = 255

    • lastModifiedBystring

      The value is automatically set by the application. User defined value is ignored.

    • lastModifiedTimestring

      The value is automatically set by the application. User defined value is ignored.

      format = "date-time"

    • technicalDescriptionstring

      minLength = 0, maxLength = 1024

400

The request is in incorrect format.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
      • statusstring
    • traceIdstring

401

User does not have valid authentication credentials.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
      • statusstring
    • traceIdstring

403

User does not have access to the resource.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
      • statusstring
    • traceIdstring

404

Resource does not exist.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
      • statusstring
    • traceIdstring

409

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

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
      • statusstring
    • traceIdstring

500

Internal Server Error.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
      • statusstring
    • traceIdstring

503

Requested service is not available.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
      • statusstring
    • traceIdstring
PUT /api/v1/data-stores/{data-store-id} 
curl "https://your-tenant.us.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"}'
const https = require('https')
  const data = JSON.stringify({"id":"string","uri":"string","name":"string","tags":["string"],"type":"string","ownerId":"string","spaceId":"string","version":42,"properties":{},"description":"string","technicalName":"string","technicalDescription":"string"})
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/data-stores/{data-store-id}',
    '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

{
  "id": "string",
  "uri": "string",
  "name": "string",
  "tags": [
    "string"
  ],
  "type": "string",
  "ownerId": "string",
  "spaceId": "string",
  "version": 42,
  "properties": {},
  "description": "string",
  "technicalName": "string",
  "technicalDescription": "string"
}

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

Get all data assets belonging to the data store(s).

Facts

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

Query Parameters

  • limitinteger

    Page size limit.

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

  • pageinteger

    default = 0, format = int32, default = 0

  • projectionsarray of strings

    Comma-separated fields to return in the response.

  • sortarray of strings

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

Path Parameters

  • data-store-idsarray of strings
    Required

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

Responses

200

Successful Operation

  • application/jsonobject
    Show application/json properties
    • dataarray of objects
      Show data properties
      • idstring

        Only required when updating the resource. Must be null for new resources.

      • namestring

        minLength = 0, maxLength = 255

      • tagsarray of strings

        uniqueItems = true

      • appIdstring
      • appTypestring
        Required
      • ownerIdstring

        The value is automatically set by the application.

      • spaceIdstring
      • versioninteger

        Only required when updating the resource. Must be null for new resources.

        format = int64

      • tenantIdstring

        The value is automatically set by the application. User defined value is ignored.

      • createdBystring

        The value is automatically set by the application. User defined value is ignored.

      • propertiesobject

        A Map of name-value pairs.

        additional properties

      • createdTimestring

        The value is automatically set by the application. User defined value is ignored.

        format = "date-time"

      • descriptionstring

        minLength = 0, maxLength = 1024

      • dataFreshnessstring

        The date-time when the source data was last changed

        format = "date-time"

      • dataStoreInfoobject
        Show dataStoreInfo properties
        • idstring
          Required
        • namestring
        • typestring
      • technicalNamestring
        Required

        minLength = 1, maxLength = 255

      • lastModifiedBystring

        The value is automatically set by the application. User defined value is ignored.

      • lastModifiedTimestring

        The value is automatically set by the application. User defined value is ignored.

        format = "date-time"

      • technicalDescriptionstring

        minLength = 0, maxLength = 1024

    • pageinteger

      format = int32

    • limitinteger

      format = int32

    • linksobject
      Show links properties
      • lastobject
        Show last properties
        • hrefstring
      • nextobject
        Show next properties
        • hrefstring
      • prevobject
        Show prev properties
        • hrefstring
      • selfobject
        Show self properties
        • hrefstring
      • firstobject
        Show first properties
        • hrefstring
    • pagesinteger

      format = int32

    • totalinteger

      format = int64

400

The request is in incorrect format.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
      • statusstring
    • traceIdstring

401

User does not have valid authentication credentials.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
      • statusstring
    • traceIdstring

403

User does not have access to the resource.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
      • statusstring
    • traceIdstring

404

Resource does not exist.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
      • statusstring
    • traceIdstring

409

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

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
      • statusstring
    • traceIdstring

500

Internal Server Error.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
      • statusstring
    • traceIdstring

503

Requested service is not available.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
      • statusstring
    • traceIdstring
GET /api/v1/data-stores/{data-store-ids}/data-assets 
curl "https://your-tenant.us.qlikcloud.com/api/v1/data-stores/{data-store-ids}/data-assets" \
-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/data-stores/{data-store-ids}/data-assets',
    'method': 'GET',
    'headers': {
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)
This API is not included yet in qlik-cli

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
}

Delete data assets and child data-sets by data-store IDs.

Facts

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

Path Parameters

  • data-store-idsarray 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/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
      • statusstring
    • traceIdstring

401

User does not have valid authentication credentials.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
      • statusstring
    • traceIdstring

403

User does not have access to the resource.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
      • statusstring
    • traceIdstring

404

Resource does not exist.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
      • statusstring
    • traceIdstring

409

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

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
      • statusstring
    • traceIdstring

500

Internal Server Error.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
      • statusstring
    • traceIdstring

503

Requested service is not available.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
      • statusstring
    • traceIdstring
DELETE /api/v1/data-stores/{data-store-ids}/data-assets 
curl "https://your-tenant.us.qlikcloud.com/api/v1/data-stores/{data-store-ids}/data-assets" \
-X DELETE \
-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/data-stores/{data-store-ids}/data-assets',
    'method': 'DELETE',
    'headers': {
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)
This API is not included yet in qlik-cli

Get all data sets belonging to the data store(s) and data asset(s).

Facts

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

Query Parameters

  • limitinteger

    Page size limit.

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

  • pageinteger

    default = 0, format = int32, default = 0

  • projectionsarray of strings

    Comma-separated fields to return in the response.

  • sortarray of strings

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

Path Parameters

  • data-asset-idsarray of strings
    Required

    Comma-separated data asset IDs or * to include all data assets.

  • data-store-idsarray of strings
    Required

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

Responses

200

Successful Operation.

  • application/jsonobject
    Show application/json properties
    • dataarray of objects
      Show data properties
      • idstring

        Only required when updating the resource. Must be null for new resources.

      • qristring
        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>"

      • namestring

        minLength = 0, maxLength = 255

      • tagsarray of strings

        uniqueItems = true

      • typestring
      • schemaobject

        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
        • anomaliesarray of strings

          Anomalies associated with this schema. Example: $warning-unknown-headers

          uniqueItems = true

        • dataFieldsarray of objects
          Required
          Show dataFields properties
          • namestring
            Required

            minLength = 1, maxLength = 255

          • tagsarray of strings

            An array of system tags

            uniqueItems = true

          • aliasstring
          • indexinteger

            format = int32

          • orphanboolean
          • dataTypeobject
            Required
            Show dataType properties
            • typestring
              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"

            • propertiesobject

              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.

              additional properties

            • originalTypestring
          • nullableboolean
          • userTagsarray of objects

            An array of user-supplied tags

            uniqueItems = true

            Show userTags properties
            • idstring

              The id of the tag in Collections

            • namestring

              minLength = 1, maxLength = 128

          • encryptedboolean
          • sensitiveboolean
          • primaryKeyboolean
          • propertiesobject

            additional properties

          • descriptionstring
          • ordinalPositionInKeyinteger

            format = int32

        • schemaNamestring
        • loadOptionsobject

          Options for loading files. Example: "qLabel": "embedded labels"

          additional properties

        • effectiveDatestring

          format = "date-time"

        • overrideSchemaAnomaliesboolean
      • ownerIdstring

        The value is automatically set by the application.

      • spaceIdstring
      • versioninteger

        Only required when updating the resource. Must be null for new resources.

        format = int64

      • tenantIdstring

        The value is automatically set by the application. User defined value is ignored.

      • createdBystring

        The value is automatically set by the application. User defined value is ignored.

      • secureQristring
        Required
      • propertiesobject

        A Map of name-value pairs.

        additional properties

      • createdTimestring

        The value is automatically set by the application. User defined value is ignored.

        format = "date-time"

      • descriptionstring

        minLength = 0, maxLength = 1024

      • operationalobject
        Show operational properties
        • sizeinteger

          format = int64

        • statusstring
        • endDatestring

          format = "date-time"

        • locationstring
        • rowCountinteger

          format = int64

        • startDatestring

          format = "date-time"

        • logMessagestring
        • tableOwnerstring
        • lastLoadTimestring

          format = "date-time"

        • contentUpdatedboolean
        • lastUpdateTimestring

          format = "date-time"

        • tableConnectionInfoobject
          Show tableConnectionInfo properties
          • tableNamestring
          • selectionScriptstring
          • additionalPropertiesobject

            additional properties

      • dataAssetInfoobject
        Required
        Show dataAssetInfo properties
        • idstring
          Required
        • namestring
        • dataStoreInfoobject
          Show dataStoreInfo properties
          • idstring
            Required
          • namestring
          • typestring
      • technicalNamestring
        Required

        minLength = 1, maxLength = 255

      • lastModifiedBystring

        The value is automatically set by the application. User defined value is ignored.

      • appTypeOverridestring

        Optional override of DataAsset appType.

      • lastModifiedTimestring

        The value is automatically set by the application. User defined value is ignored.

        format = "date-time"

      • additionalSchemasarray 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
        • anomaliesarray of strings

          Anomalies associated with this schema. Example: $warning-unknown-headers

          uniqueItems = true

        • dataFieldsarray of objects
          Required
          Show dataFields properties
          • namestring
            Required

            minLength = 1, maxLength = 255

          • tagsarray of strings

            An array of system tags

            uniqueItems = true

          • aliasstring
          • indexinteger

            format = int32

          • orphanboolean
          • dataTypeobject
            Required
            Show dataType properties
            • typestring
              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"

            • propertiesobject

              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.

              additional properties

            • originalTypestring
          • nullableboolean
          • userTagsarray of objects

            An array of user-supplied tags

            uniqueItems = true

            Show userTags properties
            • idstring

              The id of the tag in Collections

            • namestring

              minLength = 1, maxLength = 128

          • encryptedboolean
          • sensitiveboolean
          • primaryKeyboolean
          • propertiesobject

            additional properties

          • descriptionstring
          • ordinalPositionInKeyinteger

            format = int32

        • schemaNamestring
        • loadOptionsobject

          Options for loading files. Example: "qLabel": "embedded labels"

          additional properties

        • effectiveDatestring

          format = "date-time"

        • overrideSchemaAnomaliesboolean
      • technicalDescriptionstring

        minLength = 0, maxLength = 1024

      • createdByConnectionIdstring

        The connectionId that created the Dataset. Optional.
    • pageinteger

      format = int32

    • limitinteger

      format = int32

    • linksobject
      Show links properties
      • lastobject
        Show last properties
        • hrefstring
      • nextobject
        Show next properties
        • hrefstring
      • prevobject
        Show prev properties
        • hrefstring
      • selfobject
        Show self properties
        • hrefstring
      • firstobject
        Show first properties
        • hrefstring
    • pagesinteger

      format = int32

    • totalinteger

      format = int64

400

The request is in incorrect format.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
      • statusstring
    • traceIdstring

401

User does not have valid authentication credentials.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
      • statusstring
    • traceIdstring

403

User does not have access to the resource.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
      • statusstring
    • traceIdstring

404

Resource does not exist.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
      • statusstring
    • traceIdstring

409

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

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
      • statusstring
    • traceIdstring

500

Internal Server Error.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
      • statusstring
    • traceIdstring

503

Requested service is not available.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
      • statusstring
    • traceIdstring
GET /api/v1/data-stores/{data-store-ids}/data-assets/{data-asset-ids}/data-sets 
curl "https://your-tenant.us.qlikcloud.com/api/v1/data-stores/{data-store-ids}/data-assets/{data-asset-ids}/data-sets" \
-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/data-stores/{data-store-ids}/data-assets/{data-asset-ids}/data-sets',
    'method': 'GET',
    'headers': {
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)
This API is not included yet in qlik-cli

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
}

Delete data sets by data-store IDs and data-asset IDs.

Facts

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

Path Parameters

  • data-asset-idsarray of strings
    Required

    Comma-separated data asset IDs or * to include all data assets.

  • data-store-idsarray 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/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
      • statusstring
    • traceIdstring

401

User does not have valid authentication credentials.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
      • statusstring
    • traceIdstring

403

User does not have access to the resource.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
      • statusstring
    • traceIdstring

404

Resource does not exist.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
      • statusstring
    • traceIdstring

409

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

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
      • statusstring
    • traceIdstring

500

Internal Server Error.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
      • statusstring
    • traceIdstring

503

Requested service is not available.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
      • statusstring
    • traceIdstring
DELETE /api/v1/data-stores/{data-store-ids}/data-assets/{data-asset-ids}/data-sets 
curl "https://your-tenant.us.qlikcloud.com/api/v1/data-stores/{data-store-ids}/data-assets/{data-asset-ids}/data-sets" \
-X DELETE \
-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/data-stores/{data-store-ids}/data-assets/{data-asset-ids}/data-sets',
    'method': 'DELETE',
    'headers': {
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)
This API is not included yet in qlik-cli