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.

Save new data asset.

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.

    • name string
    • tags array of strings
    • 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.

    • properties object

      A Map of name-value pairs.

      Show additional optional properties
      • object object

        A Map of name-value pairs.

    • description string
    • dataFreshness string

      The date-time when the source data was last changed

    • dataStoreInfo object
      Show dataStoreInfo properties
      • id string
        Required
    • technicalName string
      Required
    • technicalDescription string

Responses

201

Created new data asset successfully.

  • application/json object
    Show application/json properties
    • id string

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

    • name string
    • tags array of strings
    • 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.

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

    • description string
    • dataFreshness string

      The date-time when the source data was last changed

    • dataStoreInfo object
      Show dataStoreInfo properties
      • id string
        Required
      • name string
      • type string
    • technicalName string
      Required
    • 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.

    • technicalDescription string

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.

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

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

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

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

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

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

      • title string
      • detail string
      • status string
    • traceId string
POST /api/v1/data-assets
import { createQlikApi } from '@qlik/api'
const qlik = createQlikApi({
hostConfig: {
host: 'https://{tenant}.{region}.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,
})
qlik data-asset create \
--appType 'string' \
--dataStoreInfo-id 'string' \
--technicalName 'string'
curl "https://{tenant}.{region}.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)

Request Body

Required
  • application/json object
    Show application/json properties
    • ids array of strings

Responses

204

Deleted data asset with all child objects.

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.

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

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

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

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

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

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

      • title string
      • detail string
      • status string
    • traceId string
DELETE /api/v1/data-assets
import { createQlikApi } from '@qlik/api'
const qlik = createQlikApi({
hostConfig: {
host: 'https://{tenant}.{region}.qlikcloud.com',
apiKey: '<access-token>',
},
})
await qlik.dataAssets.deleteDataAssets({
ids: ['string'],
})
qlik data-asset delete-many
curl "https://{tenant}.{region}.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)

Query Parameters

  • projections array of strings

    Comma-separated fields to return in the response.

Path Parameters

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

    • name string
    • tags array of strings
    • 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.

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

    • description string
    • dataFreshness string

      The date-time when the source data was last changed

    • dataStoreInfo object
      Show dataStoreInfo properties
      • id string
        Required
      • name string
      • type string
    • technicalName string
      Required
    • 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.

    • technicalDescription string

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.

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

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

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

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

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

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

      • title string
      • detail string
      • status string
    • traceId string
GET /api/v1/data-assets/{data-asset-id}
import { createQlikApi } from '@qlik/api'
const qlik = createQlikApi({
hostConfig: {
host: 'https://{tenant}.{region}.qlikcloud.com',
apiKey: '<access-token>',
},
})
await qlik.dataAssets.getDataAsset('string', {})
qlik data-asset get 'string'
curl "https://{tenant}.{region}.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)

Path Parameters

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

  • application/json object
    Show application/json properties
    • id string

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

    • name string
    • tags array of strings
    • 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.

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

    • description string
    • dataFreshness string

      The date-time when the source data was last changed

    • dataStoreInfo object
      Show dataStoreInfo properties
      • id string
        Required
      • name string
      • type string
    • technicalName string
      Required
    • 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.

    • technicalDescription string

204

Patched data asset successfully.

  • application/json object
    Show application/json properties
    • id string

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

    • name string
    • tags array of strings
    • 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.

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

    • description string
    • dataFreshness string

      The date-time when the source data was last changed

    • dataStoreInfo object
      Show dataStoreInfo properties
      • id string
        Required
      • name string
      • type string
    • technicalName string
      Required
    • 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.

    • technicalDescription string

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.

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

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

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

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

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

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

      • title string
      • detail string
      • status string
    • traceId string
PATCH /api/v1/data-assets/{data-asset-id}
import { createQlikApi } from '@qlik/api'
const qlik = createQlikApi({
hostConfig: {
host: 'https://{tenant}.{region}.qlikcloud.com',
apiKey: '<access-token>',
},
})
await qlik.dataAssets.patchDataAsset('string', [
{
from: 'string',
op: 'add',
path: 'string',
value: {},
},
])
qlik data-asset patch 'string' \
--op 'add' \
--path 'string'
curl "https://{tenant}.{region}.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)

Path Parameters

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

    • name string
    • tags array of strings
    • 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.

    • properties object

      A Map of name-value pairs.

      Show additional optional properties
      • object object

        A Map of name-value pairs.

    • description string
    • dataFreshness string

      The date-time when the source data was last changed

    • dataStoreInfo object
      Show dataStoreInfo properties
      • id string
        Required
    • technicalName string
      Required
    • technicalDescription string

Responses

200

Updated data asset successfully.

  • application/json object
    Show application/json properties
    • id string

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

    • name string
    • tags array of strings
    • 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.

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

    • description string
    • dataFreshness string

      The date-time when the source data was last changed

    • dataStoreInfo object
      Show dataStoreInfo properties
      • id string
        Required
      • name string
      • type string
    • technicalName string
      Required
    • 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.

    • technicalDescription string

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.

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

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

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

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

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

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

      • title string
      • detail string
      • status string
    • traceId string
PUT /api/v1/data-assets/{data-asset-id}
import { createQlikApi } from '@qlik/api'
const qlik = createQlikApi({
hostConfig: {
host: 'https://{tenant}.{region}.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,
})
qlik data-asset update 'string' \
--appType 'string' \
--dataStoreInfo-id 'string' \
--technicalName 'string'
curl "https://{tenant}.{region}.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"
}