Skip to content

Data sets

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

Endpoints

Skip to section
POST/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

build

Facts POST /v1/data-sets

Rate limit
required
Tier 2 (100 requests per minute)

Request Body POST /v1/data-sets

Data Set
application/json

No description

Responses POST /v1/data-sets

201
application/json

Created new data set successfully.

400
application/json

The request is in incorrect format.

401
application/json

User does not have valid authentication credentials.

403
application/json

User does not have access to the resource.

404
application/json

Resource does not exist.

409
application/json

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

500
application/json

Internal Server Error.

503
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-09-19T16:48:55.576Z","overrideSchemaAnomalies":true},"ownerId":"string","spaceId":"string","version":0,"tenantId":"string","createdBy":"string","secureQri":"string","properties":{},"createdTime":"2023-09-19T16:48:55.576Z","description":"string","operational":{"size":0,"status":"string","endDate":"2023-09-19T16:48:55.576Z","location":"string","rowCount":0,"startDate":"2023-09-19T16:48:55.576Z","logMessage":"string","tableOwner":"string","lastLoadTime":"2023-09-19T16:48:55.576Z","contentUpdated":true,"lastUpdateTime":"2023-09-19T16:48:55.576Z","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-09-19T16:48:55.576Z","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-09-19T16:48:55.576Z","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-09-19T16:48:55.576Z",
    "overrideSchemaAnomalies": true
  },
  "ownerId": "string",
  "spaceId": "string",
  "version": 0,
  "tenantId": "string",
  "createdBy": "string",
  "secureQri": "string",
  "properties": {},
  "createdTime": "2023-09-19T16:48:55.576Z",
  "description": "string",
  "operational": {
    "size": 0,
    "status": "string",
    "endDate": "2023-09-19T16:48:55.576Z",
    "location": "string",
    "rowCount": 0,
    "startDate": "2023-09-19T16:48:55.576Z",
    "logMessage": "string",
    "tableOwner": "string",
    "lastLoadTime": "2023-09-19T16:48:55.576Z",
    "contentUpdated": true,
    "lastUpdateTime": "2023-09-19T16:48:55.576Z",
    "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-09-19T16:48:55.576Z",
  "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-09-19T16:48:55.576Z",
      "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-09-19T16:48:55.576Z",
    "overrideSchemaAnomalies": true
  },
  "ownerId": "string",
  "spaceId": "string",
  "version": 0,
  "tenantId": "string",
  "createdBy": "string",
  "secureQri": "string",
  "properties": {},
  "createdTime": "2023-09-19T16:48:55.576Z",
  "description": "string",
  "operational": {
    "size": 0,
    "status": "string",
    "endDate": "2023-09-19T16:48:55.576Z",
    "location": "string",
    "rowCount": 0,
    "startDate": "2023-09-19T16:48:55.576Z",
    "logMessage": "string",
    "tableOwner": "string",
    "lastLoadTime": "2023-09-19T16:48:55.576Z",
    "contentUpdated": true,
    "lastUpdateTime": "2023-09-19T16:48:55.576Z",
    "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-09-19T16:48:55.577Z",
  "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-09-19T16:48:55.577Z",
      "overrideSchemaAnomalies": true
    }
  ],
  "technicalDescription": "string"
}

Batch delete data sets.

build

Facts DELETE /v1/data-sets

Rate limit
required
Tier 2 (100 requests per minute)

Request Body DELETE /v1/data-sets

application/json

No description

Responses DELETE /v1/data-sets

204
object

Deleted data sets.

400
application/json

The request is in incorrect format.

401
application/json

User does not have valid authentication credentials.

403
application/json

User does not have access to the resource.

404
application/json

Resource does not exist.

409
application/json

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

500
application/json

Internal Server Error.

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

build

Facts GET /v1/data-sets/{data-set-id}

Rate limit
required
Tier 1 (1000 requests per minute)

Path Parameters GET /v1/data-sets/{data-set-id}

data-set-id
required
string

No description

Query Parameters GET /v1/data-sets/{data-set-id}

projections
Array<string>

Comma-separated fields to return in the response.

Responses GET /v1/data-sets/{data-set-id}

200
application/json

Successful Operation.

400
application/json

The request is in incorrect format.

401
application/json

User does not have valid authentication credentials.

403
application/json

User does not have access to the resource.

404
application/json

Resource does not exist.

409
application/json

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

500
application/json

Internal Server Error.

503
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-09-19T16:48:55.577Z",
    "overrideSchemaAnomalies": true
  },
  "ownerId": "string",
  "spaceId": "string",
  "version": 0,
  "tenantId": "string",
  "createdBy": "string",
  "secureQri": "string",
  "properties": {},
  "createdTime": "2023-09-19T16:48:55.577Z",
  "description": "string",
  "operational": {
    "size": 0,
    "status": "string",
    "endDate": "2023-09-19T16:48:55.577Z",
    "location": "string",
    "rowCount": 0,
    "startDate": "2023-09-19T16:48:55.577Z",
    "logMessage": "string",
    "tableOwner": "string",
    "lastLoadTime": "2023-09-19T16:48:55.577Z",
    "contentUpdated": true,
    "lastUpdateTime": "2023-09-19T16:48:55.577Z",
    "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-09-19T16:48:55.577Z",
  "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-09-19T16:48:55.577Z",
      "overrideSchemaAnomalies": true
    }
  ],
  "technicalDescription": "string"
}

Patch data set.

build

Facts PATCH /v1/data-sets/{data-set-id}

Rate limit
required
Tier 2 (100 requests per minute)

Path Parameters PATCH /v1/data-sets/{data-set-id}

data-set-id
required
string

No description

Request Body PATCH /v1/data-sets/{data-set-id}

application/json

No description

Responses PATCH /v1/data-sets/{data-set-id}

200
application/json

Patched data set successfully.

204
application/json

Patched data set successfully.

400
application/json

The request is in incorrect format.

401
application/json

User does not have valid authentication credentials.

403
application/json

User does not have access to the resource.

404
application/json

Resource does not exist.

409
application/json

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

500
application/json

Internal Server Error.

503
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-09-19T16:48:55.578Z",
    "overrideSchemaAnomalies": true
  },
  "ownerId": "string",
  "spaceId": "string",
  "version": 0,
  "tenantId": "string",
  "createdBy": "string",
  "secureQri": "string",
  "properties": {},
  "createdTime": "2023-09-19T16:48:55.578Z",
  "description": "string",
  "operational": {
    "size": 0,
    "status": "string",
    "endDate": "2023-09-19T16:48:55.578Z",
    "location": "string",
    "rowCount": 0,
    "startDate": "2023-09-19T16:48:55.578Z",
    "logMessage": "string",
    "tableOwner": "string",
    "lastLoadTime": "2023-09-19T16:48:55.578Z",
    "contentUpdated": true,
    "lastUpdateTime": "2023-09-19T16:48:55.578Z",
    "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-09-19T16:48:55.578Z",
  "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-09-19T16:48:55.578Z",
      "overrideSchemaAnomalies": true
    }
  ],
  "technicalDescription": "string"
}

Update data set.

build

Facts PUT /v1/data-sets/{data-set-id}

Rate limit
required
Tier 2 (100 requests per minute)

Path Parameters PUT /v1/data-sets/{data-set-id}

data-set-id
required
string

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

Updated data set successfully.

400
application/json

The request is in incorrect format.

401
application/json

User does not have valid authentication credentials.

403
application/json

User does not have access to the resource.

404
application/json

Resource does not exist.

409
application/json

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

500
application/json

Internal Server Error.

503
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-09-19T16:48:55.578Z","overrideSchemaAnomalies":true},"ownerId":"string","spaceId":"string","version":0,"tenantId":"string","createdBy":"string","secureQri":"string","properties":{},"createdTime":"2023-09-19T16:48:55.578Z","description":"string","operational":{"size":0,"status":"string","endDate":"2023-09-19T16:48:55.578Z","location":"string","rowCount":0,"startDate":"2023-09-19T16:48:55.578Z","logMessage":"string","tableOwner":"string","lastLoadTime":"2023-09-19T16:48:55.578Z","contentUpdated":true,"lastUpdateTime":"2023-09-19T16:48:55.578Z","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-09-19T16:48:55.578Z","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-09-19T16:48:55.578Z","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-09-19T16:48:55.578Z",
    "overrideSchemaAnomalies": true
  },
  "ownerId": "string",
  "spaceId": "string",
  "version": 0,
  "tenantId": "string",
  "createdBy": "string",
  "secureQri": "string",
  "properties": {},
  "createdTime": "2023-09-19T16:48:55.578Z",
  "description": "string",
  "operational": {
    "size": 0,
    "status": "string",
    "endDate": "2023-09-19T16:48:55.578Z",
    "location": "string",
    "rowCount": 0,
    "startDate": "2023-09-19T16:48:55.578Z",
    "logMessage": "string",
    "tableOwner": "string",
    "lastLoadTime": "2023-09-19T16:48:55.578Z",
    "contentUpdated": true,
    "lastUpdateTime": "2023-09-19T16:48:55.578Z",
    "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-09-19T16:48:55.578Z",
  "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-09-19T16:48:55.578Z",
      "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-09-19T16:48:55.578Z",
    "overrideSchemaAnomalies": true
  },
  "ownerId": "string",
  "spaceId": "string",
  "version": 0,
  "tenantId": "string",
  "createdBy": "string",
  "secureQri": "string",
  "properties": {},
  "createdTime": "2023-09-19T16:48:55.578Z",
  "description": "string",
  "operational": {
    "size": 0,
    "status": "string",
    "endDate": "2023-09-19T16:48:55.578Z",
    "location": "string",
    "rowCount": 0,
    "startDate": "2023-09-19T16:48:55.578Z",
    "logMessage": "string",
    "tableOwner": "string",
    "lastLoadTime": "2023-09-19T16:48:55.578Z",
    "contentUpdated": true,
    "lastUpdateTime": "2023-09-19T16:48:55.578Z",
    "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-09-19T16:48:55.578Z",
  "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-09-19T16:48:55.578Z",
      "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.

build

Facts GET /v1/data-sets/{data-set-id}/profiles

Rate limit
required
Tier 1 (1000 requests per minute)

Path Parameters GET /v1/data-sets/{data-set-id}/profiles

data-set-id
required
string

No description

Query Parameters GET /v1/data-sets/{data-set-id}/profiles

dataConnectionIds
Array<string>

Comma-separated data connection IDs.

limit
default=20, maximum=100
integer<int32>

Page size limit.

page
integer<int32>

No description

projections
Array<string>

Comma-separated fields to return in the response.

sort
Array<string>

No description

Responses GET /v1/data-sets/{data-set-id}/profiles

200
application/json

Return profiles of data set.

202
application/json

The profile is currently running.

400
application/json

The request is in incorrect format.

401
application/json

User does not have valid authentication credentials.

403
application/json

User does not have access to the resource.

404
application/json

Resource does not exist.

409
application/json

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

500
application/json

Internal Server Error.

503
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-09-19T16:48:55.579Z",
        "computationEndTime": "2023-09-19T16:48:55.579Z",
        "computationStartTime": "2023-09-19T16:48:55.579Z"
      },
      "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

object

Properties

fieldName
string

No description

tableName
string

No description

fieldAlias
string

No description

BatchIdDto

object

Properties

ids
Array<string>

No description

BinnedFrequency

object

Properties

binEdge
number<double>

No description

frequency
integer<int64>

No description

Classification

object

Properties

pii
boolean

No description

tags

No description

sensitive
boolean

No description

obfuscation
string

No description

Classifications

object

Classifications

Properties

subjectArea
string

No description

personalInformation

No description

sensitiveInformation

No description

DataAssetInfo

object

Properties

id
required
string

No description

name
string

No description

dataStoreInfo

No description

DataField

object

Properties

name
required
string

No description

tags
Array<string>

An array of system tags

alias
string

No description

index
integer<int32>

No description

orphan
boolean

No description

dataType

No description

nullable
boolean

No description

userTags

An array of user-supplied tags

encrypted
boolean

No description

sensitive
boolean

No description

primaryKey
boolean

No description

properties
object

No description

description
string

No description

ordinalPositionInKey
integer<int32>

No description

DataSet

object

Data Set

Properties

id
string

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

qri
required
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
string

No description

tags
Array<string>

No description

type
string

No description

Schema

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
string

The value is automatically set by the application.

spaceId
string

No description

version
integer<int64>

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

tenantId
string

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

createdBy
string

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

secureQri
required
string

No description

properties
object

A Map of name-value pairs.

createdTime
string<date-time>

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

description
string

No description

Operational

Operational

dataAssetInfo

No description

technicalName
required
string

No description

lastModifiedBy
string

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

Classifications

Classifications

lastModifiedTime
string<date-time>

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

additionalSchemas

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
string

No description

DataSetProfile

object

Data Set Profile

Properties

Profile Metadata

Profile Metadata

samples

No description

profiles

No description

DataStoreInfo

object

Properties

id
required
string

No description

name
string

No description

type
string

No description

Error

object

Properties

code
string

No description

title
string

No description

detail
string

No description

status
string

No description

ErrorResponse

object

Properties

errors

No description

traceId
string

No description

FieldDataType

object

Properties

type
required
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
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
string

No description

FieldProfile

object

Field Profile

Properties

name
string

No description

tags
Array<string>

No description

index
integer<int32>

No description

median
number<double>

No description

average
number<double>

No description

dataType
string

No description

Enum:

DATE

TIME

DATETIME

TIMESTAMP

STRING

DOUBLE

DECIMAL

INTEGER

BOOLEAN

BINARY

CUSTOM

kurtosis
number<double>

No description

skewness
number<double>

No description

fractiles
Array<number<double>>

No description

sampleValues
Array<string>

No description

technicalName
string

No description

classification

No description

nullValueCount
integer<int64>

No description

textValueCount
integer<int64>

No description

zeroValueCount
integer<int64>

No description

maxNumericValue
number<double>

No description

maxStringLength
integer<int64>

No description

minNumericValue
number<double>

No description

minStringLength
integer<int64>

No description

sumStringLength
integer<int64>

No description

emptyStringCount
integer<int64>

No description

sumNumericValues
number<double>

No description

numericValueCount
integer<int64>

No description

standardDeviation
number<double>

No description

distinctValueCount
integer<int64>

No description

mostFrequentValues

No description

negativeValueCount
integer<int64>

No description

positiveValueCount
integer<int64>

No description

averageStringLength
number<double>

No description

frequencyDistribution

No description

lastSortedStringValue
string

No description

firstSortedStringValue
string

No description

sumSquaredNumericValues
number<double>

No description

Frequency

object

Properties

value
string

No description

frequency
integer<int64>

No description

JsonPatch

object

Properties

op
required
string

The operation to be performed.

Enum:

add

remove

replace

move

copy

test

from
string

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

path
required
string

A JSON pointer to the property being affected.

value
object

The value to add, replace or test.

object

Properties

href
string

No description

object

Properties

last

No description

next

No description

prev

No description

self

No description

first

No description

Operational

object

Operational

Properties

size
integer<int64>

No description

status
string

No description

endDate
string<date-time>

No description

location
string

No description

rowCount
integer<int64>

No description

startDate
string<date-time>

No description

logMessage
string

No description

tableOwner
string

No description

lastLoadTime
string<date-time>

No description

contentUpdated
boolean

No description

lastUpdateTime
string<date-time>

No description

tableConnectionInfo

No description

PageDataSetProfile

object

Properties

data

No description

page
integer<int32>

No description

limit
integer<int32>

No description

links

No description

pages
integer<int32>

No description

total
integer<int64>

No description

ProfileMetadata

object

Profile Metadata

Properties

status
string

No description

Enum:

QUEUED

RUNNING

FINISHED

FAILED

INCOMPLETE

CANCELLED

STALE

PARTIAL

DEFERRED

messages
Array<string>

No description

dataSetId
string

No description

connectionId
string

No description

lastLoadTime
string<date-time>

No description

computationEndTime
string<date-time>

No description

computationStartTime
string<date-time>

No description

Schema

object

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

Properties

anomalies
Array<string>

Anomalies associated with this schema. Example: $warning-unknown-headers

dataFields
required

No description

schemaName
string

No description

loadOptions
object

Options for loading files. Example: "qLabel": "embedded labels"

effectiveDate
string<date-time>

No description

overrideSchemaAnomalies
boolean

No description

TableConnectionInfo

object

Properties

tableName
string

No description

selectionScript
string

No description

additionalProperties
object

No description

TableProfile

object

Table Profile

Properties

name
string

No description

sizeInBytes
integer<int64>

No description

numberOfRows
integer<int64>

No description

fieldProfiles

No description

TableRecord

object

Properties

values
Array<string>

No description

TableSample

object

Table Sample

Properties

name
string

No description

records

No description

fieldNames
Array<string>

No description

Tag

object

Properties

tag
string

No description

score
number<double>

No description

UserTag

object

An array of user-supplied tags

Properties

id
string

The id of the tag in Collections

name
string

No description

v0.809.0
Was this page helpful?