Data sets
Catalog Service provides persistence and REST APIs for Catalog CRUD and List operations.
Endpoints
Skip to sectionPOST | /v1/data-sets |
DELETE | /v1/data-sets |
GET | /v1/data-sets/{data-set-id} |
PATCH | /v1/data-sets/{data-set-id} |
PUT | /v1/data-sets/{data-set-id} |
GET | /v1/data-sets/{data-set-id}/profiles |
Save new data set
Facts POST /v1/data-sets
Rate limit | Tier 2 (100 requests per minute) |
Request Body POST /v1/data-sets
Data Set application/json | No description |
Responses POST /v1/data-sets
201 optional, application/json | Created new data set 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-sets
curl "https://your-tenant.us.qlikcloud.com/api/v1/data-sets" \
-X POST \
-H "Authorization: Bearer <API-key>" \
-H "Content-type: application/json" \
-d '{"id":"string","qri":"string","name":"string","tags":[],"type":"string","schema":{"anomalies":[],"dataFields":[{"name":"string","tags":[],"alias":"string","index":0,"orphan":true,"dataType":{"type":"DATE","properties":{},"originalType":"string"},"nullable":true,"userTags":[{"id":"string","name":"string"}],"encrypted":true,"sensitive":true,"primaryKey":true,"properties":{},"description":"string","ordinalPositionInKey":0}],"schemaName":"string","loadOptions":{},"effectiveDate":"2023-01-26T11:56:36.961Z","overrideSchemaAnomalies":true},"ownerId":"string","spaceId":"string","version":0,"tenantId":"string","createdBy":"string","secureQri":"string","properties":{},"createdTime":"2023-01-26T11:56:36.961Z","description":"string","operational":{"size":0,"status":"string","endDate":"2023-01-26T11:56:36.961Z","location":"string","rowCount":0,"startDate":"2023-01-26T11:56:36.961Z","logMessage":"string","tableOwner":"string","lastLoadTime":"2023-01-26T11:56:36.961Z","contentUpdated":true,"lastUpdateTime":"2023-01-26T11:56:36.961Z","tableConnectionInfo":{"tableName":"string","selectionScript":"string","additionalProperties":{}}},"dataAssetInfo":{"id":"string","name":"string","dataStoreInfo":{"id":"string","name":"string","type":"string"}},"technicalName":"string","lastModifiedBy":"string","classifications":{"subjectArea":"string","personalInformation":[{"fieldName":"string","tableName":"string","fieldAlias":"string"}],"sensitiveInformation":[{"fieldName":"string","tableName":"string","fieldAlias":"string"}]},"lastModifiedTime":"2023-01-26T11:56:36.961Z","additionalSchemas":[{"anomalies":[],"dataFields":[{"name":"string","tags":[],"alias":"string","index":0,"orphan":true,"dataType":{"type":"DATE","properties":{},"originalType":"string"},"nullable":true,"userTags":[{"id":"string","name":"string"}],"encrypted":true,"sensitive":true,"primaryKey":true,"properties":{},"description":"string","ordinalPositionInKey":0}],"schemaName":"string","loadOptions":{},"effectiveDate":"2023-01-26T11:56:36.961Z","overrideSchemaAnomalies":true}],"technicalDescription":"string"}'
Request POST /v1/data-sets
{
"id": "string",
"qri": "string",
"name": "string",
"tags": [],
"type": "string",
"schema": {
"anomalies": [],
"dataFields": [
{
"name": "string",
"tags": [],
"alias": "string",
"index": 0,
"orphan": true,
"dataType": {
"type": "DATE",
"properties": {},
"originalType": "string"
},
"nullable": true,
"userTags": [
{
"id": "string",
"name": "string"
}
],
"encrypted": true,
"sensitive": true,
"primaryKey": true,
"properties": {},
"description": "string",
"ordinalPositionInKey": 0
}
],
"schemaName": "string",
"loadOptions": {},
"effectiveDate": "2023-01-26T11:56:36.961Z",
"overrideSchemaAnomalies": true
},
"ownerId": "string",
"spaceId": "string",
"version": 0,
"tenantId": "string",
"createdBy": "string",
"secureQri": "string",
"properties": {},
"createdTime": "2023-01-26T11:56:36.961Z",
"description": "string",
"operational": {
"size": 0,
"status": "string",
"endDate": "2023-01-26T11:56:36.961Z",
"location": "string",
"rowCount": 0,
"startDate": "2023-01-26T11:56:36.961Z",
"logMessage": "string",
"tableOwner": "string",
"lastLoadTime": "2023-01-26T11:56:36.961Z",
"contentUpdated": true,
"lastUpdateTime": "2023-01-26T11:56:36.961Z",
"tableConnectionInfo": {
"tableName": "string",
"selectionScript": "string",
"additionalProperties": {}
}
},
"dataAssetInfo": {
"id": "string",
"name": "string",
"dataStoreInfo": {
"id": "string",
"name": "string",
"type": "string"
}
},
"technicalName": "string",
"lastModifiedBy": "string",
"classifications": {
"subjectArea": "string",
"personalInformation": [
{
"fieldName": "string",
"tableName": "string",
"fieldAlias": "string"
}
],
"sensitiveInformation": [
{
"fieldName": "string",
"tableName": "string",
"fieldAlias": "string"
}
]
},
"lastModifiedTime": "2023-01-26T11:56:36.961Z",
"additionalSchemas": [
{
"anomalies": [],
"dataFields": [
{
"name": "string",
"tags": [],
"alias": "string",
"index": 0,
"orphan": true,
"dataType": {
"type": "DATE",
"properties": {},
"originalType": "string"
},
"nullable": true,
"userTags": [
{
"id": "string",
"name": "string"
}
],
"encrypted": true,
"sensitive": true,
"primaryKey": true,
"properties": {},
"description": "string",
"ordinalPositionInKey": 0
}
],
"schemaName": "string",
"loadOptions": {},
"effectiveDate": "2023-01-26T11:56:36.961Z",
"overrideSchemaAnomalies": true
}
],
"technicalDescription": "string"
}
Response POST /v1/data-sets
{
"id": "string",
"qri": "string",
"name": "string",
"tags": [],
"type": "string",
"schema": {
"anomalies": [],
"dataFields": [
{
"name": "string",
"tags": [],
"alias": "string",
"index": 0,
"orphan": true,
"dataType": {
"type": "DATE",
"properties": {},
"originalType": "string"
},
"nullable": true,
"userTags": [
{
"id": "string",
"name": "string"
}
],
"encrypted": true,
"sensitive": true,
"primaryKey": true,
"properties": {},
"description": "string",
"ordinalPositionInKey": 0
}
],
"schemaName": "string",
"loadOptions": {},
"effectiveDate": "2023-01-26T11:56:36.961Z",
"overrideSchemaAnomalies": true
},
"ownerId": "string",
"spaceId": "string",
"version": 0,
"tenantId": "string",
"createdBy": "string",
"secureQri": "string",
"properties": {},
"createdTime": "2023-01-26T11:56:36.961Z",
"description": "string",
"operational": {
"size": 0,
"status": "string",
"endDate": "2023-01-26T11:56:36.961Z",
"location": "string",
"rowCount": 0,
"startDate": "2023-01-26T11:56:36.961Z",
"logMessage": "string",
"tableOwner": "string",
"lastLoadTime": "2023-01-26T11:56:36.961Z",
"contentUpdated": true,
"lastUpdateTime": "2023-01-26T11:56:36.961Z",
"tableConnectionInfo": {
"tableName": "string",
"selectionScript": "string",
"additionalProperties": {}
}
},
"dataAssetInfo": {
"id": "string",
"name": "string",
"dataStoreInfo": {
"id": "string",
"name": "string",
"type": "string"
}
},
"technicalName": "string",
"lastModifiedBy": "string",
"classifications": {
"subjectArea": "string",
"personalInformation": [
{
"fieldName": "string",
"tableName": "string",
"fieldAlias": "string"
}
],
"sensitiveInformation": [
{
"fieldName": "string",
"tableName": "string",
"fieldAlias": "string"
}
]
},
"lastModifiedTime": "2023-01-26T11:56:36.962Z",
"additionalSchemas": [
{
"anomalies": [],
"dataFields": [
{
"name": "string",
"tags": [],
"alias": "string",
"index": 0,
"orphan": true,
"dataType": {
"type": "DATE",
"properties": {},
"originalType": "string"
},
"nullable": true,
"userTags": [
{
"id": "string",
"name": "string"
}
],
"encrypted": true,
"sensitive": true,
"primaryKey": true,
"properties": {},
"description": "string",
"ordinalPositionInKey": 0
}
],
"schemaName": "string",
"loadOptions": {},
"effectiveDate": "2023-01-26T11:56:36.962Z",
"overrideSchemaAnomalies": true
}
],
"technicalDescription": "string"
}
Batch delete data sets.
Facts DELETE /v1/data-sets
Rate limit | Tier 2 (100 requests per minute) |
Request Body DELETE /v1/data-sets
optional, application/json | No description |
Responses DELETE /v1/data-sets
204 optional object | Deleted data sets. |
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-sets
curl "https://your-tenant.us.qlikcloud.com/api/v1/data-sets" \
-X DELETE \
-H "Authorization: Bearer <API-key>" \
-H "Content-type: application/json" \
-d '{"ids":[]}'
Request DELETE /v1/data-sets
{
"ids": []
}
Get data set by ID.
Facts GET /v1/data-sets/{data-set-id}
Rate limit | Tier 1 (1000 requests per minute) |
Path Parameters GET /v1/data-sets/{data-set-id}
data-set-id string | No description |
Query Parameters GET /v1/data-sets/{data-set-id}
projections optional Array<string> | Comma-separated fields to return in the response. |
Responses GET /v1/data-sets/{data-set-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-sets/{data-set-id}
curl "https://your-tenant.us.qlikcloud.com/api/v1/data-sets/{data-set-id}" \
-H "Authorization: Bearer <API-key>"
Response GET /v1/data-sets/{data-set-id}
{
"id": "string",
"qri": "string",
"name": "string",
"tags": [],
"type": "string",
"schema": {
"anomalies": [],
"dataFields": [
{
"name": "string",
"tags": [],
"alias": "string",
"index": 0,
"orphan": true,
"dataType": {
"type": "DATE",
"properties": {},
"originalType": "string"
},
"nullable": true,
"userTags": [
{
"id": "string",
"name": "string"
}
],
"encrypted": true,
"sensitive": true,
"primaryKey": true,
"properties": {},
"description": "string",
"ordinalPositionInKey": 0
}
],
"schemaName": "string",
"loadOptions": {},
"effectiveDate": "2023-01-26T11:56:36.962Z",
"overrideSchemaAnomalies": true
},
"ownerId": "string",
"spaceId": "string",
"version": 0,
"tenantId": "string",
"createdBy": "string",
"secureQri": "string",
"properties": {},
"createdTime": "2023-01-26T11:56:36.962Z",
"description": "string",
"operational": {
"size": 0,
"status": "string",
"endDate": "2023-01-26T11:56:36.962Z",
"location": "string",
"rowCount": 0,
"startDate": "2023-01-26T11:56:36.962Z",
"logMessage": "string",
"tableOwner": "string",
"lastLoadTime": "2023-01-26T11:56:36.962Z",
"contentUpdated": true,
"lastUpdateTime": "2023-01-26T11:56:36.962Z",
"tableConnectionInfo": {
"tableName": "string",
"selectionScript": "string",
"additionalProperties": {}
}
},
"dataAssetInfo": {
"id": "string",
"name": "string",
"dataStoreInfo": {
"id": "string",
"name": "string",
"type": "string"
}
},
"technicalName": "string",
"lastModifiedBy": "string",
"classifications": {
"subjectArea": "string",
"personalInformation": [
{
"fieldName": "string",
"tableName": "string",
"fieldAlias": "string"
}
],
"sensitiveInformation": [
{
"fieldName": "string",
"tableName": "string",
"fieldAlias": "string"
}
]
},
"lastModifiedTime": "2023-01-26T11:56:36.962Z",
"additionalSchemas": [
{
"anomalies": [],
"dataFields": [
{
"name": "string",
"tags": [],
"alias": "string",
"index": 0,
"orphan": true,
"dataType": {
"type": "DATE",
"properties": {},
"originalType": "string"
},
"nullable": true,
"userTags": [
{
"id": "string",
"name": "string"
}
],
"encrypted": true,
"sensitive": true,
"primaryKey": true,
"properties": {},
"description": "string",
"ordinalPositionInKey": 0
}
],
"schemaName": "string",
"loadOptions": {},
"effectiveDate": "2023-01-26T11:56:36.962Z",
"overrideSchemaAnomalies": true
}
],
"technicalDescription": "string"
}
Patch data set.
Facts PATCH /v1/data-sets/{data-set-id}
Rate limit | Tier 2 (100 requests per minute) |
Path Parameters PATCH /v1/data-sets/{data-set-id}
data-set-id string | No description |
Request Body PATCH /v1/data-sets/{data-set-id}
optional, application/json | No description |
Responses PATCH /v1/data-sets/{data-set-id}
200 optional, application/json | Patched data set successfully. |
204 optional, application/json | Patched data set 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-sets/{data-set-id}
curl "https://your-tenant.us.qlikcloud.com/api/v1/data-sets/{data-set-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-sets/{data-set-id}
{
"op": "add",
"from": "string",
"path": "string",
"value": {}
}
Response PATCH /v1/data-sets/{data-set-id}
{
"id": "string",
"qri": "string",
"name": "string",
"tags": [],
"type": "string",
"schema": {
"anomalies": [],
"dataFields": [
{
"name": "string",
"tags": [],
"alias": "string",
"index": 0,
"orphan": true,
"dataType": {
"type": "DATE",
"properties": {},
"originalType": "string"
},
"nullable": true,
"userTags": [
{
"id": "string",
"name": "string"
}
],
"encrypted": true,
"sensitive": true,
"primaryKey": true,
"properties": {},
"description": "string",
"ordinalPositionInKey": 0
}
],
"schemaName": "string",
"loadOptions": {},
"effectiveDate": "2023-01-26T11:56:36.962Z",
"overrideSchemaAnomalies": true
},
"ownerId": "string",
"spaceId": "string",
"version": 0,
"tenantId": "string",
"createdBy": "string",
"secureQri": "string",
"properties": {},
"createdTime": "2023-01-26T11:56:36.962Z",
"description": "string",
"operational": {
"size": 0,
"status": "string",
"endDate": "2023-01-26T11:56:36.962Z",
"location": "string",
"rowCount": 0,
"startDate": "2023-01-26T11:56:36.962Z",
"logMessage": "string",
"tableOwner": "string",
"lastLoadTime": "2023-01-26T11:56:36.962Z",
"contentUpdated": true,
"lastUpdateTime": "2023-01-26T11:56:36.962Z",
"tableConnectionInfo": {
"tableName": "string",
"selectionScript": "string",
"additionalProperties": {}
}
},
"dataAssetInfo": {
"id": "string",
"name": "string",
"dataStoreInfo": {
"id": "string",
"name": "string",
"type": "string"
}
},
"technicalName": "string",
"lastModifiedBy": "string",
"classifications": {
"subjectArea": "string",
"personalInformation": [
{
"fieldName": "string",
"tableName": "string",
"fieldAlias": "string"
}
],
"sensitiveInformation": [
{
"fieldName": "string",
"tableName": "string",
"fieldAlias": "string"
}
]
},
"lastModifiedTime": "2023-01-26T11:56:36.962Z",
"additionalSchemas": [
{
"anomalies": [],
"dataFields": [
{
"name": "string",
"tags": [],
"alias": "string",
"index": 0,
"orphan": true,
"dataType": {
"type": "DATE",
"properties": {},
"originalType": "string"
},
"nullable": true,
"userTags": [
{
"id": "string",
"name": "string"
}
],
"encrypted": true,
"sensitive": true,
"primaryKey": true,
"properties": {},
"description": "string",
"ordinalPositionInKey": 0
}
],
"schemaName": "string",
"loadOptions": {},
"effectiveDate": "2023-01-26T11:56:36.962Z",
"overrideSchemaAnomalies": true
}
],
"technicalDescription": "string"
}
Update data set.
Facts PUT /v1/data-sets/{data-set-id}
Rate limit | Tier 2 (100 requests per minute) |
Path Parameters PUT /v1/data-sets/{data-set-id}
data-set-id string | No description |
Query Parameters PUT /v1/data-sets/{data-set-id}
isUpdateByProfile optional boolean | No description |
Request Body PUT /v1/data-sets/{data-set-id}
Data Set application/json | No description |
Responses PUT /v1/data-sets/{data-set-id}
200 optional, application/json | Updated data set 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-sets/{data-set-id}
curl "https://your-tenant.us.qlikcloud.com/api/v1/data-sets/{data-set-id}" \
-X PUT \
-H "Authorization: Bearer <API-key>" \
-H "Content-type: application/json" \
-d '{"id":"string","qri":"string","name":"string","tags":[],"type":"string","schema":{"anomalies":[],"dataFields":[{"name":"string","tags":[],"alias":"string","index":0,"orphan":true,"dataType":{"type":"DATE","properties":{},"originalType":"string"},"nullable":true,"userTags":[{"id":"string","name":"string"}],"encrypted":true,"sensitive":true,"primaryKey":true,"properties":{},"description":"string","ordinalPositionInKey":0}],"schemaName":"string","loadOptions":{},"effectiveDate":"2023-01-26T11:56:36.962Z","overrideSchemaAnomalies":true},"ownerId":"string","spaceId":"string","version":0,"tenantId":"string","createdBy":"string","secureQri":"string","properties":{},"createdTime":"2023-01-26T11:56:36.962Z","description":"string","operational":{"size":0,"status":"string","endDate":"2023-01-26T11:56:36.962Z","location":"string","rowCount":0,"startDate":"2023-01-26T11:56:36.962Z","logMessage":"string","tableOwner":"string","lastLoadTime":"2023-01-26T11:56:36.962Z","contentUpdated":true,"lastUpdateTime":"2023-01-26T11:56:36.962Z","tableConnectionInfo":{"tableName":"string","selectionScript":"string","additionalProperties":{}}},"dataAssetInfo":{"id":"string","name":"string","dataStoreInfo":{"id":"string","name":"string","type":"string"}},"technicalName":"string","lastModifiedBy":"string","classifications":{"subjectArea":"string","personalInformation":[{"fieldName":"string","tableName":"string","fieldAlias":"string"}],"sensitiveInformation":[{"fieldName":"string","tableName":"string","fieldAlias":"string"}]},"lastModifiedTime":"2023-01-26T11:56:36.963Z","additionalSchemas":[{"anomalies":[],"dataFields":[{"name":"string","tags":[],"alias":"string","index":0,"orphan":true,"dataType":{"type":"DATE","properties":{},"originalType":"string"},"nullable":true,"userTags":[{"id":"string","name":"string"}],"encrypted":true,"sensitive":true,"primaryKey":true,"properties":{},"description":"string","ordinalPositionInKey":0}],"schemaName":"string","loadOptions":{},"effectiveDate":"2023-01-26T11:56:36.963Z","overrideSchemaAnomalies":true}],"technicalDescription":"string"}'
Request PUT /v1/data-sets/{data-set-id}
{
"id": "string",
"qri": "string",
"name": "string",
"tags": [],
"type": "string",
"schema": {
"anomalies": [],
"dataFields": [
{
"name": "string",
"tags": [],
"alias": "string",
"index": 0,
"orphan": true,
"dataType": {
"type": "DATE",
"properties": {},
"originalType": "string"
},
"nullable": true,
"userTags": [
{
"id": "string",
"name": "string"
}
],
"encrypted": true,
"sensitive": true,
"primaryKey": true,
"properties": {},
"description": "string",
"ordinalPositionInKey": 0
}
],
"schemaName": "string",
"loadOptions": {},
"effectiveDate": "2023-01-26T11:56:36.962Z",
"overrideSchemaAnomalies": true
},
"ownerId": "string",
"spaceId": "string",
"version": 0,
"tenantId": "string",
"createdBy": "string",
"secureQri": "string",
"properties": {},
"createdTime": "2023-01-26T11:56:36.962Z",
"description": "string",
"operational": {
"size": 0,
"status": "string",
"endDate": "2023-01-26T11:56:36.962Z",
"location": "string",
"rowCount": 0,
"startDate": "2023-01-26T11:56:36.962Z",
"logMessage": "string",
"tableOwner": "string",
"lastLoadTime": "2023-01-26T11:56:36.962Z",
"contentUpdated": true,
"lastUpdateTime": "2023-01-26T11:56:36.962Z",
"tableConnectionInfo": {
"tableName": "string",
"selectionScript": "string",
"additionalProperties": {}
}
},
"dataAssetInfo": {
"id": "string",
"name": "string",
"dataStoreInfo": {
"id": "string",
"name": "string",
"type": "string"
}
},
"technicalName": "string",
"lastModifiedBy": "string",
"classifications": {
"subjectArea": "string",
"personalInformation": [
{
"fieldName": "string",
"tableName": "string",
"fieldAlias": "string"
}
],
"sensitiveInformation": [
{
"fieldName": "string",
"tableName": "string",
"fieldAlias": "string"
}
]
},
"lastModifiedTime": "2023-01-26T11:56:36.963Z",
"additionalSchemas": [
{
"anomalies": [],
"dataFields": [
{
"name": "string",
"tags": [],
"alias": "string",
"index": 0,
"orphan": true,
"dataType": {
"type": "DATE",
"properties": {},
"originalType": "string"
},
"nullable": true,
"userTags": [
{
"id": "string",
"name": "string"
}
],
"encrypted": true,
"sensitive": true,
"primaryKey": true,
"properties": {},
"description": "string",
"ordinalPositionInKey": 0
}
],
"schemaName": "string",
"loadOptions": {},
"effectiveDate": "2023-01-26T11:56:36.963Z",
"overrideSchemaAnomalies": true
}
],
"technicalDescription": "string"
}
Response PUT /v1/data-sets/{data-set-id}
{
"id": "string",
"qri": "string",
"name": "string",
"tags": [],
"type": "string",
"schema": {
"anomalies": [],
"dataFields": [
{
"name": "string",
"tags": [],
"alias": "string",
"index": 0,
"orphan": true,
"dataType": {
"type": "DATE",
"properties": {},
"originalType": "string"
},
"nullable": true,
"userTags": [
{
"id": "string",
"name": "string"
}
],
"encrypted": true,
"sensitive": true,
"primaryKey": true,
"properties": {},
"description": "string",
"ordinalPositionInKey": 0
}
],
"schemaName": "string",
"loadOptions": {},
"effectiveDate": "2023-01-26T11:56:36.963Z",
"overrideSchemaAnomalies": true
},
"ownerId": "string",
"spaceId": "string",
"version": 0,
"tenantId": "string",
"createdBy": "string",
"secureQri": "string",
"properties": {},
"createdTime": "2023-01-26T11:56:36.963Z",
"description": "string",
"operational": {
"size": 0,
"status": "string",
"endDate": "2023-01-26T11:56:36.963Z",
"location": "string",
"rowCount": 0,
"startDate": "2023-01-26T11:56:36.963Z",
"logMessage": "string",
"tableOwner": "string",
"lastLoadTime": "2023-01-26T11:56:36.963Z",
"contentUpdated": true,
"lastUpdateTime": "2023-01-26T11:56:36.963Z",
"tableConnectionInfo": {
"tableName": "string",
"selectionScript": "string",
"additionalProperties": {}
}
},
"dataAssetInfo": {
"id": "string",
"name": "string",
"dataStoreInfo": {
"id": "string",
"name": "string",
"type": "string"
}
},
"technicalName": "string",
"lastModifiedBy": "string",
"classifications": {
"subjectArea": "string",
"personalInformation": [
{
"fieldName": "string",
"tableName": "string",
"fieldAlias": "string"
}
],
"sensitiveInformation": [
{
"fieldName": "string",
"tableName": "string",
"fieldAlias": "string"
}
]
},
"lastModifiedTime": "2023-01-26T11:56:36.963Z",
"additionalSchemas": [
{
"anomalies": [],
"dataFields": [
{
"name": "string",
"tags": [],
"alias": "string",
"index": 0,
"orphan": true,
"dataType": {
"type": "DATE",
"properties": {},
"originalType": "string"
},
"nullable": true,
"userTags": [
{
"id": "string",
"name": "string"
}
],
"encrypted": true,
"sensitive": true,
"primaryKey": true,
"properties": {},
"description": "string",
"ordinalPositionInKey": 0
}
],
"schemaName": "string",
"loadOptions": {},
"effectiveDate": "2023-01-26T11:56:36.963Z",
"overrideSchemaAnomalies": true
}
],
"technicalDescription": "string"
}
Get profile for the given dataset and connection Id pair, if the profile already exists in the system. Profile returned can be either latest or Stale one based on when it was computed.
Facts GET /v1/data-sets/{data-set-id}/profiles
Rate limit | Tier 1 (1000 requests per minute) |
Path Parameters GET /v1/data-sets/{data-set-id}/profiles
data-set-id string | No description |
Query Parameters GET /v1/data-sets/{data-set-id}/profiles
dataConnectionIds optional Array<string> | Comma-separated data connection IDs. |
limit optional, default=20, maximum=100 integer<int32> | Page size limit. |
page optional integer<int32> | No description |
projections optional Array<string> | Comma-separated fields to return in the response. |
sort optional Array<string> | No description |
Responses GET /v1/data-sets/{data-set-id}/profiles
200 optional, application/json | Return profiles of data set. |
202 optional, application/json | The profile is currently running. |
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-sets/{data-set-id}/profiles
curl "https://your-tenant.us.qlikcloud.com/api/v1/data-sets/{data-set-id}/profiles" \
-H "Authorization: Bearer <API-key>"
Response GET /v1/data-sets/{data-set-id}/profiles
{
"data": [
{
"meta": {
"status": "QUEUED",
"messages": [],
"dataSetId": "string",
"connectionId": "string",
"lastLoadTime": "2023-01-26T11:56:36.963Z",
"computationEndTime": "2023-01-26T11:56:36.963Z",
"computationStartTime": "2023-01-26T11:56:36.963Z"
},
"samples": [
{
"name": "string",
"records": [
{
"values": []
}
],
"fieldNames": []
}
],
"profiles": [
{
"name": "string",
"sizeInBytes": 0,
"numberOfRows": 0,
"fieldProfiles": [
{
"name": "string",
"tags": [],
"index": 0,
"median": 0,
"average": 0,
"dataType": "DATE",
"kurtosis": 0,
"skewness": 0,
"fractiles": [],
"sampleValues": [],
"technicalName": "string",
"classification": {
"pii": true,
"tags": [
{
"tag": "string",
"score": 0
}
],
"sensitive": true,
"obfuscation": "string"
},
"nullValueCount": 0,
"textValueCount": 0,
"zeroValueCount": 0,
"maxNumericValue": 0,
"maxStringLength": 0,
"minNumericValue": 0,
"minStringLength": 0,
"sumStringLength": 0,
"emptyStringCount": 0,
"sumNumericValues": 0,
"numericValueCount": 0,
"standardDeviation": 0,
"distinctValueCount": 0,
"mostFrequentValues": [
{
"value": "string",
"frequency": 0
}
],
"negativeValueCount": 0,
"positiveValueCount": 0,
"averageStringLength": 0,
"frequencyDistribution": [
{
"binEdge": 0,
"frequency": 0
}
],
"lastSortedStringValue": "string",
"firstSortedStringValue": "string",
"sumSquaredNumericValues": 0
}
]
}
]
}
],
"page": 0,
"limit": 0,
"links": {
"last": {
"href": "string"
},
"next": {
"href": "string"
},
"prev": {
"href": "string"
},
"self": {
"href": "string"
},
"first": {
"href": "string"
}
},
"pages": 0,
"total": 0
}
AggregateClassificationFieldInfo
objectProperties
fieldName optional string | No description |
tableName optional string | No description |
fieldAlias optional string | No description |
BatchIdDto
objectProperties
ids optional Array<string> | No description |
BinnedFrequency
objectProperties
binEdge optional number<double> | No description |
frequency optional integer<int64> | No description |
Classification
objectProperties
pii optional boolean | No description |
tags optional | No description |
sensitive optional boolean | No description |
obfuscation optional string | No description |
Classifications
objectClassifications
Properties
subjectArea optional string | No description |
personalInformation optional | No description |
sensitiveInformation optional | No description |
DataAssetInfo
objectProperties
id string | No description |
name optional string | No description |
dataStoreInfo optional | No description |
DataField
objectProperties
name string | No description |
tags optional Array<string> | An array of system tags |
alias optional string | No description |
index optional integer<int32> | No description |
orphan optional boolean | No description |
dataType optional | No description |
nullable optional boolean | No description |
userTags optional | An array of user-supplied tags |
encrypted optional boolean | No description |
sensitive optional boolean | No description |
primaryKey optional boolean | No description |
properties optional object | No description |
description optional string | No description |
ordinalPositionInKey optional integer<int32> | No description |
DataSet
objectData Set
Properties
id optional string | Only required when updating the resource. Must be null for new resources. |
qri string<qdf:<store-type>:<tenant-guid>:<<uid@/sid@>user/space guid>:<path-to-file>> | NOTE: this will be deprecated after migration to secureQri. Required user defined field. All the parts in the format must be separated by ':'. The first part denotes the resourceType, followed by dataStoreType and tenant guid. The spaceGuid or userGuid is to be populated based on if the dataset is in shared or private space and finally the full file name. This field is auto populated for the dataSet generated for qix-datafiles. |
name optional string | No description |
tags optional Array<string> | No description |
type optional string | No description |
Schema optional | Optional field to specify additional schemas for files where multiple tables or sheets are available. User must define primary schema in 'schema' attribute and rest of the sheets/ tables can be defined using this field. This field is not populated for the dataSets with single schema |
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. |
secureQri string | No description |
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 |
Operational optional | Operational |
dataAssetInfo optional | No description |
technicalName string | No description |
lastModifiedBy optional string | The value is automatically set by the application. User defined value is ignored. |
Classifications optional | Classifications |
lastModifiedTime optional string<date-time> | The value is automatically set by the application. User defined value is ignored. |
additionalSchemas optional | Optional field to specify additional schemas for files where multiple tables or sheets are available. User must define primary schema in 'schema' attribute and rest of the sheets/ tables can be defined using this field. This field is not populated for the dataSets with single schema |
technicalDescription optional string | No description |
DataSetProfile
objectData Set Profile
Properties
Profile Metadata optional | Profile Metadata |
samples optional | No description |
profiles optional | No description |
DataStoreInfo
objectProperties
id string | No description |
name optional string | No description |
type optional string | No description |
Error
objectProperties
code optional string | No description |
title optional string | No description |
detail optional string | No description |
status optional string | No description |
ErrorResponse
objectProperties
errors optional | No description |
traceId optional string | No description |
FieldDataType
objectProperties
type string | Each datatype may vary in terms of required properties. Example: Datatype DECIMAL requires two mandatory properties to be defined - precision and scale, each one accepts integer value. All other datatypes does not have any required properties. Enum: DATE TIME DATETIME TIMESTAMP STRING DOUBLE DECIMAL INTEGER BOOLEAN BINARY CUSTOM |
properties optional object | The properties map key is string and the value is of type object. Please note, Datatype DECIMAL requires two mandatory properties to be defined; these properties must be named: precision and scale, each of these property accepts integer value. All other datatypes does not require any manadatory properties to be defined. |
originalType optional string | No description |
FieldProfile
objectField Profile
Properties
name optional string | No description |
tags optional Array<string> | No description |
index optional integer<int32> | No description |
median optional number<double> | No description |
average optional number<double> | No description |
dataType optional string | No description Enum: DATE TIME DATETIME TIMESTAMP STRING DOUBLE DECIMAL INTEGER BOOLEAN BINARY CUSTOM |
kurtosis optional number<double> | No description |
skewness optional number<double> | No description |
fractiles optional Array<number<double>> | No description |
sampleValues optional Array<string> | No description |
technicalName optional string | No description |
classification optional | No description |
nullValueCount optional integer<int64> | No description |
textValueCount optional integer<int64> | No description |
zeroValueCount optional integer<int64> | No description |
maxNumericValue optional number<double> | No description |
maxStringLength optional integer<int64> | No description |
minNumericValue optional number<double> | No description |
minStringLength optional integer<int64> | No description |
sumStringLength optional integer<int64> | No description |
emptyStringCount optional integer<int64> | No description |
sumNumericValues optional number<double> | No description |
numericValueCount optional integer<int64> | No description |
standardDeviation optional number<double> | No description |
distinctValueCount optional integer<int64> | No description |
mostFrequentValues optional | No description |
negativeValueCount optional integer<int64> | No description |
positiveValueCount optional integer<int64> | No description |
averageStringLength optional number<double> | No description |
frequencyDistribution optional | No description |
lastSortedStringValue optional string | No description |
firstSortedStringValue optional string | No description |
sumSquaredNumericValues optional number<double> | No description |
Frequency
objectProperties
value optional string | No description |
frequency optional integer<int64> | No description |
JsonPatch
objectProperties
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. |
Link
objectProperties
href optional string | No description |
Links
objectProperties
last optional | No description |
next optional | No description |
prev optional | No description |
self optional | No description |
first optional | No description |
Operational
objectOperational
Properties
size optional integer<int64> | No description |
status optional string | No description |
endDate optional string<date-time> | No description |
location optional string | No description |
rowCount optional integer<int64> | No description |
startDate optional string<date-time> | No description |
logMessage optional string | No description |
tableOwner optional string | No description |
lastLoadTime optional string<date-time> | No description |
contentUpdated optional boolean | No description |
lastUpdateTime optional string<date-time> | No description |
tableConnectionInfo optional | No description |
PageDataSetProfile
objectProperties
data optional | No description |
page optional integer<int32> | No description |
limit optional integer<int32> | No description |
links optional | No description |
pages optional integer<int32> | No description |
total optional integer<int64> | No description |
ProfileMetadata
objectProfile Metadata
Properties
status optional string | No description Enum: QUEUED RUNNING FINISHED FAILED INCOMPLETE CANCELLED STALE PARTIAL DEFERRED |
messages optional Array<string> | No description |
dataSetId optional string | No description |
connectionId optional string | No description |
lastLoadTime optional string<date-time> | No description |
computationEndTime optional string<date-time> | No description |
computationStartTime optional string<date-time> | No description |
Schema
objectOptional field to specify additional schemas for files where multiple tables or sheets are available. User must define primary schema in 'schema' attribute and rest of the sheets/ tables can be defined using this field. This field is not populated for the dataSets with single schema
Properties
anomalies optional Array<string> | No description |
dataFields | No description |
schemaName optional string | No description |
loadOptions optional object | No description |
effectiveDate optional string<date-time> | No description |
overrideSchemaAnomalies optional boolean | No description |
TableConnectionInfo
objectProperties
tableName optional string | No description |
selectionScript optional string | No description |
additionalProperties optional object | No description |
TableProfile
objectTable Profile
Properties
name optional string | No description |
sizeInBytes optional integer<int64> | No description |
numberOfRows optional integer<int64> | No description |
fieldProfiles optional | No description |
TableRecord
objectProperties
values optional Array<string> | No description |
TableSample
objectTable Sample
Properties
name optional string | No description |
records optional | No description |
fieldNames optional Array<string> | No description |
Tag
objectProperties
tag optional string | No description |
score optional number<double> | No description |
UserTag
objectAn array of user-supplied tags
Properties
id optional string | The id of the tag in Collections |
name optional string | No description |