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.
Endpoints
Facts
Rate limit | Tier 2 (100 requests per minute) |
Categories | build |
Request Body
Requiredapplication/json
- application/jsonobject
application/json properties
- idstring
Only required when updating the resource. Must be null for new resources.
- namestring
- tagsarray of strings
- appIdstring
- appTypestringRequired
- ownerIdstring
The value is automatically set by the application.
- spaceIdstring
- versioninteger
Only required when updating the resource. Must be null for new resources.
- propertiesobject
A Map of name-value pairs.
- descriptionstring
- dataFreshnessstring
The date-time when the source data was last changed
- dataStoreInfoobject
dataStoreInfo properties
- idstringRequired
-
- technicalNamestringRequired
- technicalDescriptionstring
-
Responses
201
application/json
Created new data asset successfully.
- application/jsonobject
application/json properties
- idstring
Only required when updating the resource. Must be null for new resources.
- namestring
- tagsarray of strings
- appIdstring
- appTypestringRequired
- ownerIdstring
The value is automatically set by the application.
- spaceIdstring
- versioninteger
Only required when updating the resource. Must be null for new resources.
- 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.
- createdTimestring
The value is automatically set by the application. User defined value is ignored.
- descriptionstring
- dataFreshnessstring
The date-time when the source data was last changed
- dataStoreInfoobject
dataStoreInfo properties
- idstringRequired
- namestring
- typestring
-
- technicalNamestringRequired
- 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.
- technicalDescriptionstring
-
400
application/json
The request is in incorrect format.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
- titlestring
- detailstring
- statusstring
-
- traceIdstring
-
401
application/json
User does not have valid authentication credentials.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
- titlestring
- detailstring
- statusstring
-
- traceIdstring
-
403
application/json
User does not have access to the resource.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
- titlestring
- detailstring
- statusstring
-
- traceIdstring
-
404
application/json
Resource does not exist.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
- titlestring
- detailstring
- statusstring
-
- traceIdstring
-
409
application/json
The input request conflicts with the current state of the resource.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
- titlestring
- detailstring
- statusstring
-
- traceIdstring
-
500
application/json
Internal Server Error.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
- titlestring
- detailstring
- statusstring
-
- traceIdstring
-
503
application/json
Requested service is not available.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
- titlestring
- detailstring
- statusstring
-
- traceIdstring
-
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"}'
const https = require('https') const data = JSON.stringify({"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"}) const options = { 'hostname': 'https://your-tenant.us.qlikcloud.com', 'port': 443, 'path': '/api/v1/data-assets', '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", "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"}
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"}
Facts
Rate limit | Tier 2 (100 requests per minute) |
Categories | build |
Request Body
Requiredapplication/json
- application/jsonobject
application/json properties
- idsarray of strings
-
Responses
204
Deleted data asset with all child objects.
400
application/json
The request is in incorrect format.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
- titlestring
- detailstring
- statusstring
-
- traceIdstring
-
401
application/json
User does not have valid authentication credentials.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
- titlestring
- detailstring
- statusstring
-
- traceIdstring
-
403
application/json
User does not have access to the resource.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
- titlestring
- detailstring
- statusstring
-
- traceIdstring
-
404
application/json
Resource does not exist.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
- titlestring
- detailstring
- statusstring
-
- traceIdstring
-
409
application/json
The input request conflicts with the current state of the resource.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
- titlestring
- detailstring
- statusstring
-
- traceIdstring
-
500
application/json
Internal Server Error.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
- titlestring
- detailstring
- statusstring
-
- traceIdstring
-
503
application/json
Requested service is not available.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
- titlestring
- detailstring
- statusstring
-
- traceIdstring
-
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"]}'
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-assets', '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" ]}
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-idstringRequired
Responses
200
application/json
Successful Operation.
- application/jsonobject
application/json properties
- idstring
Only required when updating the resource. Must be null for new resources.
- namestring
- tagsarray of strings
- appIdstring
- appTypestringRequired
- ownerIdstring
The value is automatically set by the application.
- spaceIdstring
- versioninteger
Only required when updating the resource. Must be null for new resources.
- 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.
- createdTimestring
The value is automatically set by the application. User defined value is ignored.
- descriptionstring
- dataFreshnessstring
The date-time when the source data was last changed
- dataStoreInfoobject
dataStoreInfo properties
- idstringRequired
- namestring
- typestring
-
- technicalNamestringRequired
- 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.
- technicalDescriptionstring
-
400
application/json
The request is in incorrect format.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
- titlestring
- detailstring
- statusstring
-
- traceIdstring
-
401
application/json
User does not have valid authentication credentials.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
- titlestring
- detailstring
- statusstring
-
- traceIdstring
-
403
application/json
User does not have access to the resource.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
- titlestring
- detailstring
- statusstring
-
- traceIdstring
-
404
application/json
Resource does not exist.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
- titlestring
- detailstring
- statusstring
-
- traceIdstring
-
409
application/json
The input request conflicts with the current state of the resource.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
- titlestring
- detailstring
- statusstring
-
- traceIdstring
-
500
application/json
Internal Server Error.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
- titlestring
- detailstring
- statusstring
-
- traceIdstring
-
503
application/json
Requested service is not available.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
- titlestring
- detailstring
- statusstring
-
- traceIdstring
-
curl "https://your-tenant.us.qlikcloud.com/api/v1/data-assets/{data-asset-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-assets/{data-asset-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", "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"}
Facts
Rate limit | Tier 2 (100 requests per minute) |
Categories | build |
Path Parameters
- data-asset-idstringRequired
Request Body
Requiredapplication/json
Array of JSON patch documents as defined by RFC 6902.
- application/jsonarray of objects
Array of JSON patch documents as defined by RFC 6902.
application/json properties
- opstringRequired
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.
- pathstringRequired
A JSON pointer to the property being affected.
- valueobject
The value to add, replace or test.
-
Responses
200
application/json
Patched data asset successfully.
- application/jsonobject
application/json properties
- idstring
Only required when updating the resource. Must be null for new resources.
- namestring
- tagsarray of strings
- appIdstring
- appTypestringRequired
- ownerIdstring
The value is automatically set by the application.
- spaceIdstring
- versioninteger
Only required when updating the resource. Must be null for new resources.
- 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.
- createdTimestring
The value is automatically set by the application. User defined value is ignored.
- descriptionstring
- dataFreshnessstring
The date-time when the source data was last changed
- dataStoreInfoobject
dataStoreInfo properties
- idstringRequired
- namestring
- typestring
-
- technicalNamestringRequired
- 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.
- technicalDescriptionstring
-
204
application/json
Patched data asset successfully.
- application/jsonobject
application/json properties
- idstring
Only required when updating the resource. Must be null for new resources.
- namestring
- tagsarray of strings
- appIdstring
- appTypestringRequired
- ownerIdstring
The value is automatically set by the application.
- spaceIdstring
- versioninteger
Only required when updating the resource. Must be null for new resources.
- 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.
- createdTimestring
The value is automatically set by the application. User defined value is ignored.
- descriptionstring
- dataFreshnessstring
The date-time when the source data was last changed
- dataStoreInfoobject
dataStoreInfo properties
- idstringRequired
- namestring
- typestring
-
- technicalNamestringRequired
- 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.
- technicalDescriptionstring
-
400
application/json
The request is in incorrect format.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
- titlestring
- detailstring
- statusstring
-
- traceIdstring
-
401
application/json
User does not have valid authentication credentials.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
- titlestring
- detailstring
- statusstring
-
- traceIdstring
-
403
application/json
User does not have access to the resource.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
- titlestring
- detailstring
- statusstring
-
- traceIdstring
-
404
application/json
Resource does not exist.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
- titlestring
- detailstring
- statusstring
-
- traceIdstring
-
409
application/json
The input request conflicts with the current state of the resource.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
- titlestring
- detailstring
- statusstring
-
- traceIdstring
-
500
application/json
Internal Server Error.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
- titlestring
- detailstring
- statusstring
-
- traceIdstring
-
503
application/json
Requested service is not available.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
- titlestring
- detailstring
- statusstring
-
- traceIdstring
-
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":{}}]'
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-assets/{data-asset-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", "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"}
Facts
Rate limit | Tier 2 (100 requests per minute) |
Categories | build |
Path Parameters
- data-asset-idstringRequired
Request Body
Requiredapplication/json
- application/jsonobject
application/json properties
- idstring
Only required when updating the resource. Must be null for new resources.
- namestring
- tagsarray of strings
- appIdstring
- appTypestringRequired
- ownerIdstring
The value is automatically set by the application.
- spaceIdstring
- versioninteger
Only required when updating the resource. Must be null for new resources.
- propertiesobject
A Map of name-value pairs.
- descriptionstring
- dataFreshnessstring
The date-time when the source data was last changed
- dataStoreInfoobject
dataStoreInfo properties
- idstringRequired
-
- technicalNamestringRequired
- technicalDescriptionstring
-
Responses
200
application/json
Updated data asset successfully.
- application/jsonobject
application/json properties
- idstring
Only required when updating the resource. Must be null for new resources.
- namestring
- tagsarray of strings
- appIdstring
- appTypestringRequired
- ownerIdstring
The value is automatically set by the application.
- spaceIdstring
- versioninteger
Only required when updating the resource. Must be null for new resources.
- 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.
- createdTimestring
The value is automatically set by the application. User defined value is ignored.
- descriptionstring
- dataFreshnessstring
The date-time when the source data was last changed
- dataStoreInfoobject
dataStoreInfo properties
- idstringRequired
- namestring
- typestring
-
- technicalNamestringRequired
- 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.
- technicalDescriptionstring
-
400
application/json
The request is in incorrect format.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
- titlestring
- detailstring
- statusstring
-
- traceIdstring
-
401
application/json
User does not have valid authentication credentials.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
- titlestring
- detailstring
- statusstring
-
- traceIdstring
-
403
application/json
User does not have access to the resource.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
- titlestring
- detailstring
- statusstring
-
- traceIdstring
-
404
application/json
Resource does not exist.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
- titlestring
- detailstring
- statusstring
-
- traceIdstring
-
409
application/json
The input request conflicts with the current state of the resource.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
- titlestring
- detailstring
- statusstring
-
- traceIdstring
-
500
application/json
Internal Server Error.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
- titlestring
- detailstring
- statusstring
-
- traceIdstring
-
503
application/json
Requested service is not available.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
- titlestring
- detailstring
- statusstring
-
- traceIdstring
-
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"}'
const https = require('https') const data = JSON.stringify({"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"}) const options = { 'hostname': 'https://your-tenant.us.qlikcloud.com', 'port': 443, 'path': '/api/v1/data-assets/{data-asset-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", "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"}
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"}