Data stores

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

Endpoints

Skip to section

GET	/v1/data-stores
POST	/v1/data-stores
DELETE	/v1/data-stores
GET	/v1/data-stores/{data-store-id}
PATCH	/v1/data-stores/{data-store-id}
PUT	/v1/data-stores/{data-store-id}
GET	/v1/data-stores/{data-store-ids}/data-assets
DELETE	/v1/data-stores/{data-store-ids}/data-assets
GET	/v1/data-stores/{data-store-ids}/data-assets/{data-asset-ids}/data-sets
DELETE	/v1/data-stores/{data-store-ids}/data-assets/{data-asset-ids}/data-sets

Get all data stores.

build

Facts GET /v1/data-stores

Rate limit

required

Tier 1 (1000 requests per minute)

Query Parameters GET /v1/data-stores

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>	Comma-separated fields and field start with '-' character sorts the result set in descending order.

Responses GET /v1/data-stores

200 application/json PageDataStore	Successful Operation
400 application/json ErrorResponse	The request is in incorrect format.
401 application/json ErrorResponse	User does not have valid authentication credentials.
403 application/json ErrorResponse	User does not have access to the resource.
404 application/json ErrorResponse	Resource does not exist.
409 application/json ErrorResponse	The input request conflicts with the current state of the resource.
500 application/json ErrorResponse	Internal Server Error.
503 application/json ErrorResponse	Requested service is not available.

GET/v1/data-stores

curl "https://your-tenant.us.qlikcloud.com/api/v1/data-stores" \
 -H "Authorization: Bearer <API-key>"

Response GET /v1/data-stores

{
  "data": [
    {
      "id": "string",
      "uri": "string",
      "name": "string",
      "tags": [],
      "type": "string",
      "ownerId": "string",
      "spaceId": "string",
      "version": 0,
      "tenantId": "string",
      "createdBy": "string",
      "properties": {},
      "createdTime": "2023-09-19T16:48:55.412Z",
      "description": "string",
      "technicalName": "string",
      "lastModifiedBy": "string",
      "lastModifiedTime": "2023-09-19T16:48:55.412Z",
      "technicalDescription": "string"
    }
  ],
  "page": 0,
  "limit": 0,
  "links": {
    "last": {
      "href": "string"
    },
    "next": {
      "href": "string"
    },
    "prev": {
      "href": "string"
    },
    "self": {
      "href": "string"
    },
    "first": {
      "href": "string"
    }
  },
  "pages": 0,
  "total": 0
}

Save new data store.

build

Facts POST /v1/data-stores

Rate limit

required

Tier 2 (100 requests per minute)

Request Body POST /v1/data-stores

Data Store

application/json

DataStore

No description

Responses POST /v1/data-stores

201 application/json DataStore	Created new data store successfully.
400 application/json ErrorResponse	The request is in incorrect format.
401 application/json ErrorResponse	User does not have valid authentication credentials.
403 application/json ErrorResponse	User does not have access to the resource.
404 application/json ErrorResponse	Resource does not exist.
409 application/json ErrorResponse	The input request conflicts with the current state of the resource.
500 application/json ErrorResponse	Internal Server Error.
503 application/json ErrorResponse	Requested service is not available.

POST/v1/data-stores

curl "https://your-tenant.us.qlikcloud.com/api/v1/data-stores" \
 -X POST \
 -H "Authorization: Bearer <API-key>" \
 -H "Content-type: application/json" \
 -d '{"id":"string","uri":"string","name":"string","tags":[],"type":"string","ownerId":"string","spaceId":"string","version":0,"tenantId":"string","createdBy":"string","properties":{},"createdTime":"2023-09-19T16:48:55.412Z","description":"string","technicalName":"string","lastModifiedBy":"string","lastModifiedTime":"2023-09-19T16:48:55.412Z","technicalDescription":"string"}'

Request POST /v1/data-stores

{
  "id": "string",
  "uri": "string",
  "name": "string",
  "tags": [],
  "type": "string",
  "ownerId": "string",
  "spaceId": "string",
  "version": 0,
  "tenantId": "string",
  "createdBy": "string",
  "properties": {},
  "createdTime": "2023-09-19T16:48:55.412Z",
  "description": "string",
  "technicalName": "string",
  "lastModifiedBy": "string",
  "lastModifiedTime": "2023-09-19T16:48:55.412Z",
  "technicalDescription": "string"
}

Response POST /v1/data-stores

{
  "id": "string",
  "uri": "string",
  "name": "string",
  "tags": [],
  "type": "string",
  "ownerId": "string",
  "spaceId": "string",
  "version": 0,
  "tenantId": "string",
  "createdBy": "string",
  "properties": {},
  "createdTime": "2023-09-19T16:48:55.412Z",
  "description": "string",
  "technicalName": "string",
  "lastModifiedBy": "string",
  "lastModifiedTime": "2023-09-19T16:48:55.412Z",
  "technicalDescription": "string"
}

Delete data stores if it does not contain any data-assets.

build

Facts DELETE /v1/data-stores

Rate limit

required

Tier 2 (100 requests per minute)

Request Body DELETE /v1/data-stores

application/json

BatchIdDto

No description

Responses DELETE /v1/data-stores

204 object	Deleted empty data stores.
400 application/json ErrorResponse	The request is in incorrect format.
401 application/json ErrorResponse	User does not have valid authentication credentials.
403 application/json ErrorResponse	User does not have access to the resource.
404 application/json ErrorResponse	Resource does not exist.
409 application/json ErrorResponse	The input request conflicts with the current state of the resource.
500 application/json ErrorResponse	Internal Server Error.
503 application/json ErrorResponse	Requested service is not available.

DELETE/v1/data-stores

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

Request DELETE /v1/data-stores

{
  "ids": []
}

Get data store by ID.

build

Facts GET /v1/data-stores/{data-store-id}

Rate limit

required

Tier 1 (1000 requests per minute)

Path Parameters GET /v1/data-stores/{data-store-id}

data-store-id

required

string

No description

Query Parameters GET /v1/data-stores/{data-store-id}

projections

Array<string>

Comma-separated fields to return in the response.

Responses GET /v1/data-stores/{data-store-id}

200 application/json DataStore	Successful Operation.
400 application/json ErrorResponse	The request is in incorrect format.
401 application/json ErrorResponse	User does not have valid authentication credentials.
403 application/json ErrorResponse	User does not have access to the resource.
404 application/json ErrorResponse	Resource does not exist.
409 application/json ErrorResponse	The input request conflicts with the current state of the resource.
500 application/json ErrorResponse	Internal Server Error.
503 application/json ErrorResponse	Requested service is not available.

GET/v1/data-stores/{data-store-id}

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

Response GET /v1/data-stores/{data-store-id}

{
  "id": "string",
  "uri": "string",
  "name": "string",
  "tags": [],
  "type": "string",
  "ownerId": "string",
  "spaceId": "string",
  "version": 0,
  "tenantId": "string",
  "createdBy": "string",
  "properties": {},
  "createdTime": "2023-09-19T16:48:55.412Z",
  "description": "string",
  "technicalName": "string",
  "lastModifiedBy": "string",
  "lastModifiedTime": "2023-09-19T16:48:55.412Z",
  "technicalDescription": "string"
}

Patch data store.

build

Facts PATCH /v1/data-stores/{data-store-id}

Rate limit

required

Tier 2 (100 requests per minute)

Path Parameters PATCH /v1/data-stores/{data-store-id}

data-store-id

required

string

No description

Request Body PATCH /v1/data-stores/{data-store-id}

application/json

Array<JsonPatch>

No description

Responses PATCH /v1/data-stores/{data-store-id}

200 application/json DataStore	Patched data store successfully.
204 application/json DataStore	Patched data store successfully.
400 application/json ErrorResponse	The request is in incorrect format.
401 application/json ErrorResponse	User does not have valid authentication credentials.
403 application/json ErrorResponse	User does not have access to the resource.
404 application/json ErrorResponse	Resource does not exist.
409 application/json ErrorResponse	The input request conflicts with the current state of the resource.
500 application/json ErrorResponse	Internal Server Error.
503 application/json ErrorResponse	Requested service is not available.

PATCH/v1/data-stores/{data-store-id}

curl "https://your-tenant.us.qlikcloud.com/api/v1/data-stores/{data-store-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-stores/{data-store-id}

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

Response PATCH /v1/data-stores/{data-store-id}

{
  "id": "string",
  "uri": "string",
  "name": "string",
  "tags": [],
  "type": "string",
  "ownerId": "string",
  "spaceId": "string",
  "version": 0,
  "tenantId": "string",
  "createdBy": "string",
  "properties": {},
  "createdTime": "2023-09-19T16:48:55.412Z",
  "description": "string",
  "technicalName": "string",
  "lastModifiedBy": "string",
  "lastModifiedTime": "2023-09-19T16:48:55.412Z",
  "technicalDescription": "string"
}

Update data store.

build

Facts PUT /v1/data-stores/{data-store-id}

Rate limit

required

Tier 2 (100 requests per minute)

Path Parameters PUT /v1/data-stores/{data-store-id}

data-store-id

required

string

No description

Request Body PUT /v1/data-stores/{data-store-id}

Data Store

application/json

DataStore

No description

Responses PUT /v1/data-stores/{data-store-id}

200 application/json DataStore	Updated data store successfully.
400 application/json ErrorResponse	The request is in incorrect format.
401 application/json ErrorResponse	User does not have valid authentication credentials.
403 application/json ErrorResponse	User does not have access to the resource.
404 application/json ErrorResponse	Resource does not exist.
409 application/json ErrorResponse	The input request conflicts with the current state of the resource.
500 application/json ErrorResponse	Internal Server Error.
503 application/json ErrorResponse	Requested service is not available.

PUT/v1/data-stores/{data-store-id}

curl "https://your-tenant.us.qlikcloud.com/api/v1/data-stores/{data-store-id}" \
 -X PUT \
 -H "Authorization: Bearer <API-key>" \
 -H "Content-type: application/json" \
 -d '{"id":"string","uri":"string","name":"string","tags":[],"type":"string","ownerId":"string","spaceId":"string","version":0,"tenantId":"string","createdBy":"string","properties":{},"createdTime":"2023-09-19T16:48:55.412Z","description":"string","technicalName":"string","lastModifiedBy":"string","lastModifiedTime":"2023-09-19T16:48:55.412Z","technicalDescription":"string"}'

Request PUT /v1/data-stores/{data-store-id}

{
  "id": "string",
  "uri": "string",
  "name": "string",
  "tags": [],
  "type": "string",
  "ownerId": "string",
  "spaceId": "string",
  "version": 0,
  "tenantId": "string",
  "createdBy": "string",
  "properties": {},
  "createdTime": "2023-09-19T16:48:55.412Z",
  "description": "string",
  "technicalName": "string",
  "lastModifiedBy": "string",
  "lastModifiedTime": "2023-09-19T16:48:55.412Z",
  "technicalDescription": "string"
}

Response PUT /v1/data-stores/{data-store-id}

{
  "id": "string",
  "uri": "string",
  "name": "string",
  "tags": [],
  "type": "string",
  "ownerId": "string",
  "spaceId": "string",
  "version": 0,
  "tenantId": "string",
  "createdBy": "string",
  "properties": {},
  "createdTime": "2023-09-19T16:48:55.412Z",
  "description": "string",
  "technicalName": "string",
  "lastModifiedBy": "string",
  "lastModifiedTime": "2023-09-19T16:48:55.412Z",
  "technicalDescription": "string"
}

Get all data assets belonging to the data store(s).

build

Facts GET /v1/data-stores/{data-store-ids}/data-assets

Rate limit

required

Tier 1 (1000 requests per minute)

Path Parameters GET /v1/data-stores/{data-store-ids}/data-assets

data-store-ids

required

Array<string>

Comma-separated data store IDs or * to include all data stores.

Query Parameters GET /v1/data-stores/{data-store-ids}/data-assets

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>	Comma-separated fields and field start with '-' character sorts the result set in descending order.

Responses GET /v1/data-stores/{data-store-ids}/data-assets

200 application/json PageDataAsset	Successful Operation
400 application/json ErrorResponse	The request is in incorrect format.
401 application/json ErrorResponse	User does not have valid authentication credentials.
403 application/json ErrorResponse	User does not have access to the resource.
404 application/json ErrorResponse	Resource does not exist.
409 application/json ErrorResponse	The input request conflicts with the current state of the resource.
500 application/json ErrorResponse	Internal Server Error.
503 application/json ErrorResponse	Requested service is not available.

GET/v1/data-stores/{data-store-ids}/data-assets

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

Response GET /v1/data-stores/{data-store-ids}/data-assets

{
  "data": [
    {
      "id": "string",
      "name": "string",
      "tags": [],
      "appId": "string",
      "appType": "string",
      "ownerId": "string",
      "spaceId": "string",
      "version": 0,
      "tenantId": "string",
      "createdBy": "string",
      "properties": {},
      "createdTime": "2023-09-19T16:48:55.413Z",
      "description": "string",
      "dataStoreInfo": {
        "id": "string",
        "name": "string",
        "type": "string"
      },
      "technicalName": "string",
      "lastModifiedBy": "string",
      "lastModifiedTime": "2023-09-19T16:48:55.413Z",
      "technicalDescription": "string"
    }
  ],
  "page": 0,
  "limit": 0,
  "links": {
    "last": {
      "href": "string"
    },
    "next": {
      "href": "string"
    },
    "prev": {
      "href": "string"
    },
    "self": {
      "href": "string"
    },
    "first": {
      "href": "string"
    }
  },
  "pages": 0,
  "total": 0
}

Delete data assets and child data-sets by data-store IDs.

build

Facts DELETE /v1/data-stores/{data-store-ids}/data-assets

Rate limit

required

Tier 2 (100 requests per minute)

Path Parameters DELETE /v1/data-stores/{data-store-ids}/data-assets

data-store-ids

required

Array<string>

Comma-separated data store IDs or * to include all data stores.

Responses DELETE /v1/data-stores/{data-store-ids}/data-assets

204 object	Deleted data assets successfully.
400 application/json ErrorResponse	The request is in incorrect format.
401 application/json ErrorResponse	User does not have valid authentication credentials.
403 application/json ErrorResponse	User does not have access to the resource.
404 application/json ErrorResponse	Resource does not exist.
409 application/json ErrorResponse	The input request conflicts with the current state of the resource.
500 application/json ErrorResponse	Internal Server Error.
503 application/json ErrorResponse	Requested service is not available.

DELETE/v1/data-stores/{data-store-ids}/data-assets

curl "https://your-tenant.us.qlikcloud.com/api/v1/data-stores/{data-store-ids}/data-assets" \
 -X DELETE \
 -H "Authorization: Bearer <API-key>"

Get all data sets belonging to the data store(s) and data asset(s).

build

Facts GET /v1/data-stores/{data-store-ids}/data-assets/{data-asset-ids}/data-sets

Rate limit

required

Tier 1 (1000 requests per minute)

Path Parameters GET /v1/data-stores/{data-store-ids}/data-assets/{data-asset-ids}/data-sets

data-asset-ids required Array<string>	Comma-separated data asset IDs or * to include all data assets.
data-store-ids required Array<string>	Comma-separated data store IDs or * to include all data stores.

Query Parameters GET /v1/data-stores/{data-store-ids}/data-assets/{data-asset-ids}/data-sets

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>	Comma-separated fields and field start with '-' character sorts the result set in descending order.

Responses GET /v1/data-stores/{data-store-ids}/data-assets/{data-asset-ids}/data-sets

200 application/json PageDataSet	Successful Operation.
400 application/json ErrorResponse	The request is in incorrect format.
401 application/json ErrorResponse	User does not have valid authentication credentials.
403 application/json ErrorResponse	User does not have access to the resource.
404 application/json ErrorResponse	Resource does not exist.
409 application/json ErrorResponse	The input request conflicts with the current state of the resource.
500 application/json ErrorResponse	Internal Server Error.
503 application/json ErrorResponse	Requested service is not available.

GET/v1/data-stores/{data-store-ids}/data-assets/{data-asset-ids}/data-sets

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

Response GET /v1/data-stores/{data-store-ids}/data-assets/{data-asset-ids}/data-sets

{
  "data": [
    {
      "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.413Z",
        "overrideSchemaAnomalies": true
      },
      "ownerId": "string",
      "spaceId": "string",
      "version": 0,
      "tenantId": "string",
      "createdBy": "string",
      "secureQri": "string",
      "properties": {},
      "createdTime": "2023-09-19T16:48:55.413Z",
      "description": "string",
      "operational": {
        "size": 0,
        "status": "string",
        "endDate": "2023-09-19T16:48:55.413Z",
        "location": "string",
        "rowCount": 0,
        "startDate": "2023-09-19T16:48:55.413Z",
        "logMessage": "string",
        "tableOwner": "string",
        "lastLoadTime": "2023-09-19T16:48:55.413Z",
        "contentUpdated": true,
        "lastUpdateTime": "2023-09-19T16:48:55.413Z",
        "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.413Z",
      "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.413Z",
          "overrideSchemaAnomalies": true
        }
      ],
      "technicalDescription": "string"
    }
  ],
  "page": 0,
  "limit": 0,
  "links": {
    "last": {
      "href": "string"
    },
    "next": {
      "href": "string"
    },
    "prev": {
      "href": "string"
    },
    "self": {
      "href": "string"
    },
    "first": {
      "href": "string"
    }
  },
  "pages": 0,
  "total": 0
}

Delete data sets by data-store IDs and data-asset IDs.

build

Facts DELETE /v1/data-stores/{data-store-ids}/data-assets/{data-asset-ids}/data-sets

Rate limit

required

Tier 2 (100 requests per minute)

Path Parameters DELETE /v1/data-stores/{data-store-ids}/data-assets/{data-asset-ids}/data-sets

data-asset-ids required Array<string>	Comma-separated data asset IDs or * to include all data assets.
data-store-ids required Array<string>	Comma-separated data store IDs or * to include all data stores.

Responses DELETE /v1/data-stores/{data-store-ids}/data-assets/{data-asset-ids}/data-sets

204 object	Deleted data sets.
400 application/json ErrorResponse	The request is in incorrect format.
401 application/json ErrorResponse	User does not have valid authentication credentials.
403 application/json ErrorResponse	User does not have access to the resource.
404 application/json ErrorResponse	Resource does not exist.
409 application/json ErrorResponse	The input request conflicts with the current state of the resource.
500 application/json ErrorResponse	Internal Server Error.
503 application/json ErrorResponse	Requested service is not available.

DELETE/v1/data-stores/{data-store-ids}/data-assets/{data-asset-ids}/data-sets

curl "https://your-tenant.us.qlikcloud.com/api/v1/data-stores/{data-store-ids}/data-assets/{data-asset-ids}/data-sets" \
 -X DELETE \
 -H "Authorization: Bearer <API-key>"

AggregateClassificationFieldInfo

object

Properties

fieldName string	No description
tableName string	No description
fieldAlias string	No description

BatchIdDto

object

Properties

ids

Array<string>

No description

Classifications

object

Classifications

Properties

subjectArea string	No description
personalInformation Array<AggregateClassificationFieldInfo>	No description
sensitiveInformation Array<AggregateClassificationFieldInfo>	No description

DataAsset

object

Data Asset

Properties

id string	Only required when updating the resource. Must be null for new resources.
name string	No description
tags Array<string>	No description
appId required string	No description
appType required string	No description
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.
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
dataStoreInfo DataStoreInfo	No description
technicalName required string	No description
lastModifiedBy string	The value is automatically set by the application. User defined value is ignored.
lastModifiedTime string<date-time>	The value is automatically set by the application. User defined value is ignored.
technicalDescription string	No description

DataAssetInfo

object

Properties

id required string	No description
name string	No description
dataStoreInfo 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 required FieldDataType	No description
nullable boolean	No description
userTags Array<UserTag>	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 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	Operational
dataAssetInfo required 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	Classifications
lastModifiedTime string<date-time>	The value is automatically set by the application. User defined value is ignored.
additionalSchemas Array<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
technicalDescription string	No description

DataStore

object

Data Store

Properties

id string	Only required when updating the resource. Must be null for new resources.
uri required string	No description
name string	No description
tags Array<string>	No description
type required string	No description
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.
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
technicalName required string	No description
lastModifiedBy string	The value is automatically set by the application. User defined value is ignored.
lastModifiedTime string<date-time>	The value is automatically set by the application. User defined value is ignored.
technicalDescription string	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 Array<Error>	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

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.

Link

object

Properties

href

string

No description

Links

object

Properties

last Link	No description
next Link	No description
prev Link	No description
self Link	No description
first Link	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 TableConnectionInfo	No description

PageDataAsset

object

Properties

data Array<DataAsset>	No description
page integer<int32>	No description
limit integer<int32>	No description
links Links	No description
pages integer<int32>	No description
total integer<int64>	No description

PageDataSet

object

Properties

data Array<DataSet>	No description
page integer<int32>	No description
limit integer<int32>	No description
links Links	No description
pages integer<int32>	No description
total integer<int64>	No description

PageDataStore

object

Properties

data Array<DataStore>	No description
page integer<int32>	No description
limit integer<int32>	No description
links Links	No description
pages integer<int32>	No description
total integer<int64>	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 Array<DataField>	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

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