Data assets

Catalog Service provides persistence and REST APIs for Catalog CRUD and List operations.

Endpoints

POST

/v1/data-assets
DELETE

/v1/data-assets
GET

/v1/data-assets/{data-asset-id}
PATCH

/v1/data-assets/{data-asset-id}
PUT

/v1/data-assets/{data-asset-id}

Facts

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

Request Body

Required

application/json

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
  Required
- 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
- dataStoreInfoobject
  
  Show dataStoreInfo properties
  
  idstring
  Required
  
  namestring
  
  typestring
- technicalNamestring
  Required
  
  minLength = 1, maxLength = 255
- technicalDescriptionstring
  
  minLength = 0, maxLength = 1024

Responses

201

application/json

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

application/json

The request is in incorrect format.

application/jsonobject
Show application/json properties
- errorsarray of objects
- traceIdstring

401

application/json

User does not have valid authentication credentials.

application/jsonobject
Show application/json properties
- errorsarray of objects
- traceIdstring

403

application/json

User does not have access to the resource.

application/jsonobject
Show application/json properties
- errorsarray of objects
- traceIdstring

404

application/json

Resource does not exist.

application/jsonobject
Show application/json properties
- errorsarray of objects
- traceIdstring

409

application/json

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

application/jsonobject
Show application/json properties
- errorsarray of objects
- traceIdstring

500

application/json

Internal Server Error.

application/jsonobject
Show application/json properties
- errorsarray of objects
- traceIdstring

503

application/json

Requested service is not available.

application/jsonobject
Show application/json properties
- errorsarray of objects
- traceIdstring

POST /v1/data-assets

curl "https://your-tenant.us.qlikcloud.com/api/v1/data-assets" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer <API-key>" \
-d '{"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","dataStoreInfo":{"id":"string","name":"string","type":"string"},"technicalName":"string","lastModifiedBy":"string","lastModifiedTime":"2018-10-30T07:06:22Z","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,"tenantId":"string","createdBy":"string","properties":{},"createdTime":"2018-10-30T07:06:22Z","description":"string","dataStoreInfo":{"id":"string","name":"string","type":"string"},"technicalName":"string","lastModifiedBy":"string","lastModifiedTime":"2018-10-30T07:06:22Z","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 <API-key>'
    }
  }
  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,
  "tenantId": "string",
  "createdBy": "string",
  "properties": {},
  "createdTime": "2018-10-30T07:06:22Z",
  "description": "string",
  "dataStoreInfo": {
    "id": "string",
    "name": "string",
    "type": "string"
  },
  "technicalName": "string",
  "lastModifiedBy": "string",
  "lastModifiedTime": "2018-10-30T07:06:22Z",
  "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",
  "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	externalbuild

Request Body

Required

application/json

application/jsonobject
Show application/json properties
- idsarray of strings
  
  uniqueItems = true

Responses

204

Deleted data asset with all child objects.

400

application/json

The request is in incorrect format.

application/jsonobject
Show application/json properties
- errorsarray of objects
- traceIdstring

401

application/json

User does not have valid authentication credentials.

application/jsonobject
Show application/json properties
- errorsarray of objects
- traceIdstring

403

application/json

User does not have access to the resource.

application/jsonobject
Show application/json properties
- errorsarray of objects
- traceIdstring

404

application/json

Resource does not exist.

application/jsonobject
Show application/json properties
- errorsarray of objects
- traceIdstring

409

application/json

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

application/jsonobject
Show application/json properties
- errorsarray of objects
- traceIdstring

500

application/json

Internal Server Error.

application/jsonobject
Show application/json properties
- errorsarray of objects
- traceIdstring

503

application/json

Requested service is not available.

application/jsonobject
Show application/json properties
- errorsarray of objects
- traceIdstring

DELETE /v1/data-assets

curl "https://your-tenant.us.qlikcloud.com/api/v1/data-assets" \
-X DELETE \
-H "Content-type: application/json" \
-H "Authorization: Bearer <API-key>" \
-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 <API-key>'
    }
  }
  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	externalbuild

Query Parameters

projectionsarray of strings

Comma-separated fields to return in the response.

Path Parameters

data-asset-idstring
Required

Responses

200

application/json

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

application/json

The request is in incorrect format.

application/jsonobject
Show application/json properties
- errorsarray of objects
- traceIdstring

401

application/json

User does not have valid authentication credentials.

application/jsonobject
Show application/json properties
- errorsarray of objects
- traceIdstring

403

application/json

User does not have access to the resource.

application/jsonobject
Show application/json properties
- errorsarray of objects
- traceIdstring

404

application/json

Resource does not exist.

application/jsonobject
Show application/json properties
- errorsarray of objects
- traceIdstring

409

application/json

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

application/jsonobject
Show application/json properties
- errorsarray of objects
- traceIdstring

500

application/json

Internal Server Error.

application/jsonobject
Show application/json properties
- errorsarray of objects
- traceIdstring

503

application/json

Requested service is not available.

application/jsonobject
Show application/json properties
- errorsarray of objects
- traceIdstring

GET /v1/data-assets/{data-asset-id}

curl "https://your-tenant.us.qlikcloud.com/api/v1/data-assets/{data-asset-id}" \
-H "Authorization: Bearer <API-key>"

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 <API-key>'
    }
  }
  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",
  "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	externalbuild

Path Parameters

data-asset-idstring
Required

Request Body

Required

application/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.
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

application/json

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

application/json

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

application/json

The request is in incorrect format.

application/jsonobject
Show application/json properties
- errorsarray of objects
- traceIdstring

401

application/json

User does not have valid authentication credentials.

application/jsonobject
Show application/json properties
- errorsarray of objects
- traceIdstring

403

application/json

User does not have access to the resource.

application/jsonobject
Show application/json properties
- errorsarray of objects
- traceIdstring

404

application/json

Resource does not exist.

application/jsonobject
Show application/json properties
- errorsarray of objects
- traceIdstring

409

application/json

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

application/jsonobject
Show application/json properties
- errorsarray of objects
- traceIdstring

500

application/json

Internal Server Error.

application/jsonobject
Show application/json properties
- errorsarray of objects
- traceIdstring

503

application/json

Requested service is not available.

application/jsonobject
Show application/json properties
- errorsarray of objects
- traceIdstring

PATCH /v1/data-assets/{data-asset-id}

curl "https://your-tenant.us.qlikcloud.com/api/v1/data-assets/{data-asset-id}" \
-X PATCH \
-H "Content-type: application/json" \
-H "Authorization: Bearer <API-key>" \
-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 <API-key>'
    }
  }
  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",
  "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	externalbuild

Path Parameters

data-asset-idstring
Required

Request Body

Required

application/json

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
  Required
- 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
- dataStoreInfoobject
  
  Show dataStoreInfo properties
  
  idstring
  Required
  
  namestring
  
  typestring
- technicalNamestring
  Required
  
  minLength = 1, maxLength = 255
- technicalDescriptionstring
  
  minLength = 0, maxLength = 1024

Responses

200

application/json

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

application/json

The request is in incorrect format.

application/jsonobject
Show application/json properties
- errorsarray of objects
- traceIdstring

401

application/json

User does not have valid authentication credentials.

application/jsonobject
Show application/json properties
- errorsarray of objects
- traceIdstring

403

application/json

User does not have access to the resource.

application/jsonobject
Show application/json properties
- errorsarray of objects
- traceIdstring

404

application/json

Resource does not exist.

application/jsonobject
Show application/json properties
- errorsarray of objects
- traceIdstring

409

application/json

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

application/jsonobject
Show application/json properties
- errorsarray of objects
- traceIdstring

500

application/json

Internal Server Error.

application/jsonobject
Show application/json properties
- errorsarray of objects
- traceIdstring

503

application/json

Requested service is not available.

application/jsonobject
Show application/json properties
- errorsarray of objects
- traceIdstring

PUT /v1/data-assets/{data-asset-id}

curl "https://your-tenant.us.qlikcloud.com/api/v1/data-assets/{data-asset-id}" \
-X PUT \
-H "Content-type: application/json" \
-H "Authorization: Bearer <API-key>" \
-d '{"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","dataStoreInfo":{"id":"string","name":"string","type":"string"},"technicalName":"string","lastModifiedBy":"string","lastModifiedTime":"2018-10-30T07:06:22Z","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,"tenantId":"string","createdBy":"string","properties":{},"createdTime":"2018-10-30T07:06:22Z","description":"string","dataStoreInfo":{"id":"string","name":"string","type":"string"},"technicalName":"string","lastModifiedBy":"string","lastModifiedTime":"2018-10-30T07:06:22Z","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 <API-key>'
    }
  }
  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,
  "tenantId": "string",
  "createdBy": "string",
  "properties": {},
  "createdTime": "2018-10-30T07:06:22Z",
  "description": "string",
  "dataStoreInfo": {
    "id": "string",
    "name": "string",
    "type": "string"
  },
  "technicalName": "string",
  "lastModifiedBy": "string",
  "lastModifiedTime": "2018-10-30T07:06:22Z",
  "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",
  "dataStoreInfo": {
    "id": "string",
    "name": "string",
    "type": "string"
  },
  "technicalName": "string",
  "lastModifiedBy": "string",
  "lastModifiedTime": "2018-10-30T07:06:22Z",
  "technicalDescription": "string"
}

Data assets

Endpoints

Save new data asset.

Facts

Request Body

Responses

201

400

401

403

404

409

500

503

Request

Response

Batch delete data assets by IDs.

Facts

Request Body

Responses

204

400

401

403

404

409

500

503

Request

Get data asset by ID.

Facts

Query Parameters

Path Parameters

Responses

200

400

401

403

404

409

500

503

Response

Patch data asset.

Facts

Path Parameters

Request Body

Responses

200

204

400

401

403

404

409

500

503

Request

Response

Update data asset.

Facts

Path Parameters

Request Body

Responses

200

400

401

403

404

409

500

503

Request

Response