Data assets

Data assets are part of the catalog in Qlik Cloud. A data asset is a member of a data store, and may contain multiple data sets.

Download specification

Save new data asset.

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.

    • 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

    • propertiesobject

      A Map of name-value pairs.

      additional properties

    • 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
    • technicalNamestring
      Required

      minLength = 1, maxLength = 255

    • technicalDescriptionstring

      minLength = 0, maxLength = 1024

Responses

201

Created new data asset successfully.

  • application/jsonobject
    Show application/json 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

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-assets 
import { createQlikApi } from '@qlik/api'


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


await qlik.dataAssets.createDataAsset({
  appId: 'string',
  appType: 'string',
  dataFreshness: '2018-10-30T07:06:22Z',
  dataStoreInfo: { id: 'string' },
  description: 'string',
  id: 'string',
  name: 'string',
  ownerId: 'string',
  properties: {},
  spaceId: 'string',
  tags: ['string'],
  technicalDescription: 'string',
  technicalName: 'string',
  version: 42,
})
This API is not included yet in qlik-cli
curl "https://your-tenant.us.qlikcloud.com/api/v1/data-assets" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{"id":"string","name":"string","tags":["string"],"appId":"string","appType":"string","ownerId":"string","spaceId":"string","version":42,"properties":{},"description":"string","dataFreshness":"2018-10-30T07:06:22Z","dataStoreInfo":{"id":"string"},"technicalName":"string","technicalDescription":"string"}'

Example Response

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

Batch delete data assets by IDs.

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 data asset with all child objects.

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-assets 
import { createQlikApi } from '@qlik/api'


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


await qlik.dataAssets.deleteDataAssets({
  ids: ['string'],
})
This API is not included yet in qlik-cli
curl "https://your-tenant.us.qlikcloud.com/api/v1/data-assets" \
-X DELETE \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{"ids":["string"]}'

Get data asset 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-asset-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.

    • 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

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-assets/{data-asset-id} 
import { createQlikApi } from '@qlik/api'


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


await qlik.dataAssets.getDataAsset('string', {})
This API is not included yet in qlik-cli
curl "https://your-tenant.us.qlikcloud.com/api/v1/data-assets/{data-asset-id}" \
-H "Authorization: Bearer <access_token>"

Example Response

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

Patch data asset.

Facts

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

Path Parameters

  • data-asset-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 asset successfully.

  • application/jsonobject
    Show application/json 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

204

Patched data asset successfully.

  • application/jsonobject
    Show application/json 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

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-assets/{data-asset-id} 
import { createQlikApi } from '@qlik/api'


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


await qlik.dataAssets.patchDataAsset('string', [
  {
    from: 'string',
    op: 'add',
    path: 'string',
    value: {},
  },
])
This API is not included yet in qlik-cli
curl "https://your-tenant.us.qlikcloud.com/api/v1/data-assets/{data-asset-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",
  "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"
}

Update data asset.

Facts

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

Path Parameters

  • data-asset-idstring
    Required

Request Body

Required
  • application/jsonobject
    Show application/json 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

    • propertiesobject

      A Map of name-value pairs.

      additional properties

    • 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
    • technicalNamestring
      Required

      minLength = 1, maxLength = 255

    • technicalDescriptionstring

      minLength = 0, maxLength = 1024

Responses

200

Updated data asset successfully.

  • application/jsonobject
    Show application/json 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

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-assets/{data-asset-id} 
import { createQlikApi } from '@qlik/api'


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


await qlik.dataAssets.updateDataAsset('string', {
  appId: 'string',
  appType: 'string',
  dataFreshness: '2018-10-30T07:06:22Z',
  dataStoreInfo: { id: 'string' },
  description: 'string',
  id: 'string',
  name: 'string',
  ownerId: 'string',
  properties: {},
  spaceId: 'string',
  tags: ['string'],
  technicalDescription: 'string',
  technicalName: 'string',
  version: 42,
})
This API is not included yet in qlik-cli
curl "https://your-tenant.us.qlikcloud.com/api/v1/data-assets/{data-asset-id}" \
-X PUT \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{"id":"string","name":"string","tags":["string"],"appId":"string","appType":"string","ownerId":"string","spaceId":"string","version":42,"properties":{},"description":"string","dataFreshness":"2018-10-30T07:06:22Z","dataStoreInfo":{"id":"string"},"technicalName":"string","technicalDescription":"string"}'

Example Response

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