Data assets

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

Endpoints

Skip to section
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}

Save new data asset.

build

Facts POST /v1/data-assets

Rate limit
Tier 2 (100 requests per minute)

Request Body POST /v1/data-assets

Data Asset
application/json

No description

Responses POST /v1/data-assets

201
optional, application/json

Created new data asset successfully.

400
optional, application/json

The request is in incorrect format.

401
optional, application/json

User does not have valid authentication credentials.

403
optional, application/json

User does not have access to the resource.

404
optional, application/json

Resource does not exist.

409
optional, application/json

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

500
optional, application/json

Internal Server Error.

503
optional, application/json

Requested service is not available.

POST/v1/data-assets

curl "https://your-tenant.us.qlikcloud.com/api/v1/data-assets" \
 -X POST \
 -H "Authorization: Bearer <API-key>" \
 -H "Content-type: application/json" \
 -d '{"id":"string","name":"string","tags":[],"appId":"string","appType":"string","ownerId":"string","spaceId":"string","version":0,"tenantId":"string","createdBy":"string","properties":{},"createdTime":"2023-01-26T11:56:37.322Z","description":"string","dataStoreInfo":{"id":"string","name":"string","type":"string"},"technicalName":"string","lastModifiedBy":"string","lastModifiedTime":"2023-01-26T11:56:37.322Z","technicalDescription":"string"}'

Request POST /v1/data-assets

{
  "id": "string",
  "name": "string",
  "tags": [],
  "appId": "string",
  "appType": "string",
  "ownerId": "string",
  "spaceId": "string",
  "version": 0,
  "tenantId": "string",
  "createdBy": "string",
  "properties": {},
  "createdTime": "2023-01-26T11:56:37.322Z",
  "description": "string",
  "dataStoreInfo": {
    "id": "string",
    "name": "string",
    "type": "string"
  },
  "technicalName": "string",
  "lastModifiedBy": "string",
  "lastModifiedTime": "2023-01-26T11:56:37.322Z",
  "technicalDescription": "string"
}

Response POST /v1/data-assets

{
  "id": "string",
  "name": "string",
  "tags": [],
  "appId": "string",
  "appType": "string",
  "ownerId": "string",
  "spaceId": "string",
  "version": 0,
  "tenantId": "string",
  "createdBy": "string",
  "properties": {},
  "createdTime": "2023-01-26T11:56:37.322Z",
  "description": "string",
  "dataStoreInfo": {
    "id": "string",
    "name": "string",
    "type": "string"
  },
  "technicalName": "string",
  "lastModifiedBy": "string",
  "lastModifiedTime": "2023-01-26T11:56:37.322Z",
  "technicalDescription": "string"
}

Batch delete data assets by IDs.

Facts DELETE /v1/data-assets

Rate limit
Tier 2 (100 requests per minute)

Request Body DELETE /v1/data-assets

optional, application/json

No description

Responses DELETE /v1/data-assets

204
optional
object

Deleted data asset with all child objects.

400
optional, application/json

The request is in incorrect format.

401
optional, application/json

User does not have valid authentication credentials.

403
optional, application/json

User does not have access to the resource.

404
optional, application/json

Resource does not exist.

409
optional, application/json

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

500
optional, application/json

Internal Server Error.

503
optional, application/json

Requested service is not available.

DELETE/v1/data-assets

curl "https://your-tenant.us.qlikcloud.com/api/v1/data-assets" \
 -X DELETE \
 -H "Authorization: Bearer <API-key>" \
 -H "Content-type: application/json" \
 -d '{"ids":[]}'

Request DELETE /v1/data-assets

{
  "ids": []
}

Get data asset by ID.

build

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

Rate limit
Tier 1 (1000 requests per minute)

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

data-asset-id
string

No description

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

projections
optional
Array<string>

Comma-separated fields to return in the response.

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

200
optional, application/json

Successful Operation.

400
optional, application/json

The request is in incorrect format.

401
optional, application/json

User does not have valid authentication credentials.

403
optional, application/json

User does not have access to the resource.

404
optional, application/json

Resource does not exist.

409
optional, application/json

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

500
optional, application/json

Internal Server Error.

503
optional, application/json

Requested service is not available.

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

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

{
  "id": "string",
  "name": "string",
  "tags": [],
  "appId": "string",
  "appType": "string",
  "ownerId": "string",
  "spaceId": "string",
  "version": 0,
  "tenantId": "string",
  "createdBy": "string",
  "properties": {},
  "createdTime": "2023-01-26T11:56:37.322Z",
  "description": "string",
  "dataStoreInfo": {
    "id": "string",
    "name": "string",
    "type": "string"
  },
  "technicalName": "string",
  "lastModifiedBy": "string",
  "lastModifiedTime": "2023-01-26T11:56:37.322Z",
  "technicalDescription": "string"
}

Patch data asset.

build

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

Rate limit
Tier 2 (100 requests per minute)

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

data-asset-id
string

No description

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

optional, application/json

No description

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

200
optional, application/json

Patched data asset successfully.

204
optional, application/json

Patched data asset successfully.

400
optional, application/json

The request is in incorrect format.

401
optional, application/json

User does not have valid authentication credentials.

403
optional, application/json

User does not have access to the resource.

404
optional, application/json

Resource does not exist.

409
optional, application/json

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

500
optional, application/json

Internal Server Error.

503
optional, application/json

Requested service is not available.

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

curl "https://your-tenant.us.qlikcloud.com/api/v1/data-assets/{data-asset-id}" \
 -X PATCH \
 -H "Authorization: Bearer <API-key>" \
 -H "Content-type: application/json" \
 -d '{"op":"add","from":"string","path":"string","value":{}}'

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

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

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

{
  "id": "string",
  "name": "string",
  "tags": [],
  "appId": "string",
  "appType": "string",
  "ownerId": "string",
  "spaceId": "string",
  "version": 0,
  "tenantId": "string",
  "createdBy": "string",
  "properties": {},
  "createdTime": "2023-01-26T11:56:37.322Z",
  "description": "string",
  "dataStoreInfo": {
    "id": "string",
    "name": "string",
    "type": "string"
  },
  "technicalName": "string",
  "lastModifiedBy": "string",
  "lastModifiedTime": "2023-01-26T11:56:37.322Z",
  "technicalDescription": "string"
}

Update data asset.

build

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

Rate limit
Tier 2 (100 requests per minute)

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

data-asset-id
string

No description

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

Data Asset
application/json

No description

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

200
optional, application/json

Updated data asset successfully.

400
optional, application/json

The request is in incorrect format.

401
optional, application/json

User does not have valid authentication credentials.

403
optional, application/json

User does not have access to the resource.

404
optional, application/json

Resource does not exist.

409
optional, application/json

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

500
optional, application/json

Internal Server Error.

503
optional, application/json

Requested service is not available.

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

curl "https://your-tenant.us.qlikcloud.com/api/v1/data-assets/{data-asset-id}" \
 -X PUT \
 -H "Authorization: Bearer <API-key>" \
 -H "Content-type: application/json" \
 -d '{"id":"string","name":"string","tags":[],"appId":"string","appType":"string","ownerId":"string","spaceId":"string","version":0,"tenantId":"string","createdBy":"string","properties":{},"createdTime":"2023-01-26T11:56:37.322Z","description":"string","dataStoreInfo":{"id":"string","name":"string","type":"string"},"technicalName":"string","lastModifiedBy":"string","lastModifiedTime":"2023-01-26T11:56:37.322Z","technicalDescription":"string"}'

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

{
  "id": "string",
  "name": "string",
  "tags": [],
  "appId": "string",
  "appType": "string",
  "ownerId": "string",
  "spaceId": "string",
  "version": 0,
  "tenantId": "string",
  "createdBy": "string",
  "properties": {},
  "createdTime": "2023-01-26T11:56:37.322Z",
  "description": "string",
  "dataStoreInfo": {
    "id": "string",
    "name": "string",
    "type": "string"
  },
  "technicalName": "string",
  "lastModifiedBy": "string",
  "lastModifiedTime": "2023-01-26T11:56:37.322Z",
  "technicalDescription": "string"
}

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

{
  "id": "string",
  "name": "string",
  "tags": [],
  "appId": "string",
  "appType": "string",
  "ownerId": "string",
  "spaceId": "string",
  "version": 0,
  "tenantId": "string",
  "createdBy": "string",
  "properties": {},
  "createdTime": "2023-01-26T11:56:37.322Z",
  "description": "string",
  "dataStoreInfo": {
    "id": "string",
    "name": "string",
    "type": "string"
  },
  "technicalName": "string",
  "lastModifiedBy": "string",
  "lastModifiedTime": "2023-01-26T11:56:37.322Z",
  "technicalDescription": "string"
}

BatchIdDto

object

Properties

ids
optional
Array<string>

No description

DataAsset

object

Data Asset

Properties

id
optional
string

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

name
optional
string

No description

tags
optional
Array<string>

No description

appId
string

No description

appType
string

No description

ownerId
optional
string

The value is automatically set by the application.

spaceId
optional
string

No description

version
optional
integer<int64>

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

tenantId
optional
string

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

createdBy
optional
string

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

properties
optional
object

A Map of name-value pairs.

createdTime
optional
string<date-time>

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

description
optional
string

No description

dataStoreInfo

No description

technicalName
string

No description

lastModifiedBy
optional
string

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

lastModifiedTime
optional
string<date-time>

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

technicalDescription
optional
string

No description

DataStoreInfo

object

Properties

id
string

No description

name
optional
string

No description

type
optional
string

No description

Error

object

Properties

code
optional
string

No description

title
optional
string

No description

detail
optional
string

No description

status
optional
string

No description

ErrorResponse

object

Properties

errors
optional

No description

traceId
optional
string

No description

JsonPatch

object

Properties

op
string

The operation to be performed.

Enum:

add

remove

replace

move

copy

test

from
optional
string

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

path
string

A JSON pointer to the property being affected.

value
optional
object

The value to add, replace or test.

v0.574.0
Was this page helpful?