data-stores

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

Endpoints

Skip to section

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

Get all data stores.

Query Parameters GET /data-stores

projections optional Array<string>	Comma-separated fields to return in the response.
page optional integer<int32>	No description
limit optional, default=20, maximum=100 integer<int32>	Page size limit.
sort optional Array<string>	Comma-separated fields and field start with '-' character sorts the result set in descending order.

Responses GET /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/data-stores

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

Response GET /data-stores

{
  "data": [
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "tenantId": "string",
      "spaceId": "string",
      "ownerId": "string",
      "createdTime": "2022-06-28T20:33:35.049Z",
      "createdBy": "string",
      "lastModifiedTime": "2022-06-28T20:33:35.049Z",
      "lastModifiedBy": "string",
      "version": 0,
      "technicalDescription": "string",
      "technicalName": "string",
      "tags": [],
      "properties": {},
      "type": "string",
      "uri": "string"
    }
  ],
  "page": 0,
  "limit": 0,
  "total": 0,
  "pages": 0,
  "links": {
    "self": {
      "href": "string"
    },
    "first": {
      "href": "string"
    },
    "last": {
      "href": "string"
    },
    "next": {
      "href": "string"
    },
    "prev": {
      "href": "string"
    }
  }
}

Save new data store.

Request Body POST /data-stores

Data Store

application/json

DataStore

No description

Responses POST /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/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","name":"string","description":"string","tenantId":"string","spaceId":"string","ownerId":"string","createdTime":"2022-06-28T20:33:35.049Z","createdBy":"string","lastModifiedTime":"2022-06-28T20:33:35.049Z","lastModifiedBy":"string","version":0,"technicalDescription":"string","technicalName":"string","tags":[],"properties":{},"type":"string","uri":"string"}'

Request POST /data-stores

{
  "id": "string",
  "name": "string",
  "description": "string",
  "tenantId": "string",
  "spaceId": "string",
  "ownerId": "string",
  "createdTime": "2022-06-28T20:33:35.049Z",
  "createdBy": "string",
  "lastModifiedTime": "2022-06-28T20:33:35.049Z",
  "lastModifiedBy": "string",
  "version": 0,
  "technicalDescription": "string",
  "technicalName": "string",
  "tags": [],
  "properties": {},
  "type": "string",
  "uri": "string"
}

Response POST /data-stores

{
  "id": "string",
  "name": "string",
  "description": "string",
  "tenantId": "string",
  "spaceId": "string",
  "ownerId": "string",
  "createdTime": "2022-06-28T20:33:35.049Z",
  "createdBy": "string",
  "lastModifiedTime": "2022-06-28T20:33:35.049Z",
  "lastModifiedBy": "string",
  "version": 0,
  "technicalDescription": "string",
  "technicalName": "string",
  "tags": [],
  "properties": {},
  "type": "string",
  "uri": "string"
}

Delete data stores.

Request Body DELETE /data-stores/

application/json

BatchIdDto

No description

Responses DELETE /data-stores/

204 object	Deleted 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/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 /data-stores/

{
  "ids": []
}

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

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

data-store-ids

Array<string>

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

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

projections optional Array<string>	Comma-separated fields to return in the response.
page optional integer<int32>	No description
limit optional, default=20, maximum=100 integer<int32>	Page size limit.
sort optional Array<string>	Comma-separated fields and field start with '-' character sorts the result set in descending order.

Responses GET /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/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 /data-stores/{data-store-ids}/data-assets

{
  "data": [
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "tenantId": "string",
      "spaceId": "string",
      "ownerId": "string",
      "createdTime": "2022-06-28T20:33:35.049Z",
      "createdBy": "string",
      "lastModifiedTime": "2022-06-28T20:33:35.049Z",
      "lastModifiedBy": "string",
      "version": 0,
      "technicalDescription": "string",
      "technicalName": "string",
      "tags": [],
      "properties": {},
      "appType": "string",
      "appId": "string",
      "dataStoreInfo": {
        "id": "string",
        "name": "string",
        "type": "string"
      }
    }
  ],
  "page": 0,
  "limit": 0,
  "total": 0,
  "pages": 0,
  "links": {
    "self": {
      "href": "string"
    },
    "first": {
      "href": "string"
    },
    "last": {
      "href": "string"
    },
    "next": {
      "href": "string"
    },
    "prev": {
      "href": "string"
    }
  }
}

Delete data assets by data-store IDs.

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

data-store-ids

Array<string>

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

Responses DELETE /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/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).

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

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

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

projections optional Array<string>	Comma-separated fields to return in the response.
page optional integer<int32>	No description
limit optional, default=20, maximum=100 integer<int32>	Page size limit.
sort optional Array<string>	Comma-separated fields and field start with '-' character sorts the result set in descending order.

Responses GET /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/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 /data-stores/{data-store-ids}/data-assets/{data-asset-ids}/data-sets

{
  "data": [
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "tenantId": "string",
      "spaceId": "string",
      "ownerId": "string",
      "createdTime": "2022-06-28T20:33:35.049Z",
      "createdBy": "string",
      "lastModifiedTime": "2022-06-28T20:33:35.049Z",
      "lastModifiedBy": "string",
      "version": 0,
      "technicalDescription": "string",
      "technicalName": "string",
      "tags": [],
      "properties": {},
      "dataAssetInfo": {
        "id": "string",
        "name": "string",
        "dataStoreInfo": {
          "id": "string",
          "name": "string",
          "type": "string"
        }
      },
      "operational": {
        "size": 0,
        "rowCount": 0,
        "lastLoadTime": "2022-06-28T20:33:35.049Z",
        "startDate": "2022-06-28T20:33:35.049Z",
        "endDate": "2022-06-28T20:33:35.049Z",
        "logMessage": "string",
        "status": "string",
        "location": "string",
        "contentUpdated": true,
        "tableOwner": "string",
        "tableConnectionInfo": {
          "tableName": "string",
          "selectionScript": "string",
          "additionalProperties": {}
        },
        "lastUpdateTime": "2022-06-28T20:33:35.049Z"
      },
      "schema": {
        "dataFields": [
          {
            "name": "string",
            "alias": "string",
            "description": "string",
            "ordinalPositionInKey": 0,
            "index": 0,
            "dataType": {
              "type": "DATE",
              "originalType": "string",
              "properties": {}
            },
            "tags": [],
            "properties": {},
            "encrypted": true,
            "primaryKey": true,
            "sensitive": true,
            "orphan": true,
            "nullable": true
          }
        ],
        "effectiveDate": "2022-06-28T20:33:35.049Z",
        "schemaName": "string"
      },
      "additionalSchemas": [
        {
          "dataFields": [
            {
              "name": "string",
              "alias": "string",
              "description": "string",
              "ordinalPositionInKey": 0,
              "index": 0,
              "dataType": {
                "type": "DATE",
                "originalType": "string",
                "properties": {}
              },
              "tags": [],
              "properties": {},
              "encrypted": true,
              "primaryKey": true,
              "sensitive": true,
              "orphan": true,
              "nullable": true
            }
          ],
          "effectiveDate": "2022-06-28T20:33:35.049Z",
          "schemaName": "string"
        }
      ],
      "qri": "string",
      "secureQri": "string",
      "type": "string",
      "classifications": {
        "subjectArea": "string",
        "personalInformation": [],
        "sensitiveInformation": []
      }
    }
  ],
  "page": 0,
  "limit": 0,
  "total": 0,
  "pages": 0,
  "links": {
    "self": {
      "href": "string"
    },
    "first": {
      "href": "string"
    },
    "last": {
      "href": "string"
    },
    "next": {
      "href": "string"
    },
    "prev": {
      "href": "string"
    }
  }
}

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

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

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

Responses DELETE /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/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>"

Get data store by ID.

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

data-store-id

string

No description

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

projections

optional

Array<string>

Comma-separated fields to return in the response.

Responses GET /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/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 /data-stores/{data-store-id}

{
  "id": "string",
  "name": "string",
  "description": "string",
  "tenantId": "string",
  "spaceId": "string",
  "ownerId": "string",
  "createdTime": "2022-06-28T20:33:35.049Z",
  "createdBy": "string",
  "lastModifiedTime": "2022-06-28T20:33:35.049Z",
  "lastModifiedBy": "string",
  "version": 0,
  "technicalDescription": "string",
  "technicalName": "string",
  "tags": [],
  "properties": {},
  "type": "string",
  "uri": "string"
}

Update data store.

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

data-store-id

string

No description

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

Data Store

application/json

DataStore

No description

Responses PUT /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/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","name":"string","description":"string","tenantId":"string","spaceId":"string","ownerId":"string","createdTime":"2022-06-28T20:33:35.049Z","createdBy":"string","lastModifiedTime":"2022-06-28T20:33:35.049Z","lastModifiedBy":"string","version":0,"technicalDescription":"string","technicalName":"string","tags":[],"properties":{},"type":"string","uri":"string"}'

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

{
  "id": "string",
  "name": "string",
  "description": "string",
  "tenantId": "string",
  "spaceId": "string",
  "ownerId": "string",
  "createdTime": "2022-06-28T20:33:35.049Z",
  "createdBy": "string",
  "lastModifiedTime": "2022-06-28T20:33:35.049Z",
  "lastModifiedBy": "string",
  "version": 0,
  "technicalDescription": "string",
  "technicalName": "string",
  "tags": [],
  "properties": {},
  "type": "string",
  "uri": "string"
}

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

{
  "id": "string",
  "name": "string",
  "description": "string",
  "tenantId": "string",
  "spaceId": "string",
  "ownerId": "string",
  "createdTime": "2022-06-28T20:33:35.049Z",
  "createdBy": "string",
  "lastModifiedTime": "2022-06-28T20:33:35.049Z",
  "lastModifiedBy": "string",
  "version": 0,
  "technicalDescription": "string",
  "technicalName": "string",
  "tags": [],
  "properties": {},
  "type": "string",
  "uri": "string"
}

Patch data store.

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

data-store-id

string

No description

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

application/json

Array<JsonPatch>

No description

Responses PATCH /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/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","path":"string","value":{},"from":"string"}'

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

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

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

{
  "id": "string",
  "name": "string",
  "description": "string",
  "tenantId": "string",
  "spaceId": "string",
  "ownerId": "string",
  "createdTime": "2022-06-28T20:33:35.050Z",
  "createdBy": "string",
  "lastModifiedTime": "2022-06-28T20:33:35.050Z",
  "lastModifiedBy": "string",
  "version": 0,
  "technicalDescription": "string",
  "technicalName": "string",
  "tags": [],
  "properties": {},
  "type": "string",
  "uri": "string"
}

BatchIdDto

object

Properties

ids

Array<string>

No description

Classifications

object

Classifications

Properties

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

DataAsset

object

Data Asset

Properties

id optional string	Only required when updating the resource. Must be null for new resources.
name optional string	No description
description optional string	No description
tenantId optional string	The value is automatically set by the application. User defined value is ignored.
spaceId optional string	No description
ownerId optional string	The value is automatically set by the application.
createdTime optional string<date-time>	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.
lastModifiedTime optional string<date-time>	The value is automatically set by the application. User defined value is ignored.
lastModifiedBy optional string	The value is automatically set by the application. User defined value is ignored.
version optional integer<int64>	Only required when updating the resource. Must be null for new resources.
technicalDescription optional string	No description
technicalName string	No description
tags optional Array<string>	No description
properties optional object	A Map of name-value pairs.
appType string	No description
appId string	No description
dataStoreInfo optional DataStoreInfo	No description

DataAssetDeletion

object

Properties

id optional string	No description
name string	No description
createdTime optional string<date-time>	No description
createdBy optional string	No description
lastModifiedTime optional string<date-time>	No description
lastModifiedBy optional string	No description
version optional integer<int64>	No description
description optional string	No description
tenantId optional string	No description
spaceId optional string	No description
ownerId optional string	No description
technicalDescription optional string	No description
technicalName optional string	No description
systemProperties optional SystemProperties	No description
tags optional Array<string>	No description
properties optional object	No description
dataAssetId optional string	No description
deletedTime optional string<date-time>	No description
resourceType optional string	No description

DataAssetInfo

object

Properties

id string	No description
name optional string	No description
dataStoreInfo optional DataStoreInfo	No description

DataConnectionInfo

object

Data Connection Info

Properties

connectionId string	No description
spaceId string	No description
database string	No description
schema string	No description
tables Array<TableConnectionInfo>	No description

DataField

object

Properties

name string	No description
alias optional string	No description
description optional string	No description
ordinalPositionInKey optional integer<int32>	No description
index optional integer<int32>	No description
dataType optional FieldDataType	No description
tags optional Array<string>	No description
properties optional object	No description
encrypted optional boolean	No description
primaryKey optional boolean	No description
sensitive optional boolean	No description
orphan optional boolean	No description
nullable optional boolean	No description

DataSet

object

Data Set

Properties

id optional string	Only required when updating the resource. Must be null for new resources.
name optional string	No description
description optional string	No description
tenantId optional string	The value is automatically set by the application. User defined value is ignored.
spaceId optional string	No description
ownerId optional string	The value is automatically set by the application.
createdTime optional string<date-time>	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.
lastModifiedTime optional string<date-time>	The value is automatically set by the application. User defined value is ignored.
lastModifiedBy optional string	The value is automatically set by the application. User defined value is ignored.
version optional integer<int64>	Only required when updating the resource. Must be null for new resources.
technicalDescription optional string	No description
technicalName string	No description
tags optional Array<string>	No description
properties optional object	A Map of name-value pairs.
dataAssetInfo optional DataAssetInfo	No description
Operational optional Operational	Operational
Schema optional 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
additionalSchemas optional 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
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.
secureQri optional string	No description
type optional string	No description
Classifications optional Classifications	Classifications

DataSetDeletion

object

Properties

id optional string	No description
name string	No description
createdTime optional string<date-time>	No description
createdBy optional string	No description
lastModifiedTime optional string<date-time>	No description
lastModifiedBy optional string	No description
version optional integer<int64>	No description
description optional string	No description
tenantId optional string	No description
spaceId optional string	No description
ownerId optional string	No description
technicalDescription optional string	No description
technicalName optional string	No description
systemProperties optional SystemProperties	No description
tags optional Array<string>	No description
properties optional object	No description
dataSetId optional string	No description
deletedTime optional string<date-time>	No description
resourceType optional string	No description

DataSetInfo

object

Properties

id string	No description
version optional integer<int64>	No description

DataSetRevision

object

Data Set Revision

Properties

id optional string	Only required when updating the resource. Must be null for new resources.
name optional string	No description
description optional string	No description
tenantId optional string	The value is automatically set by the application. User defined value is ignored.
spaceId optional string	No description
ownerId optional string	The value is automatically set by the application.
createdTime optional string<date-time>	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.
lastModifiedTime optional string<date-time>	The value is automatically set by the application. User defined value is ignored.
lastModifiedBy optional string	The value is automatically set by the application. User defined value is ignored.
version optional integer<int64>	Only required when updating the resource. Must be null for new resources.
technicalDescription optional string	No description
technicalName string	No description
tags optional Array<string>	No description
properties optional object	A Map of name-value pairs.
dataSetInfo optional DataSetInfo	No description
Schema optional 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
changes optional Array<JsonPatch>	No description
additionalSchemas optional Array<Schema>	No description

DataStore

object

Data Store

Properties

id optional string	Only required when updating the resource. Must be null for new resources.
name optional string	No description
description optional string	No description
tenantId optional string	The value is automatically set by the application. User defined value is ignored.
spaceId optional string	No description
ownerId optional string	The value is automatically set by the application.
createdTime optional string<date-time>	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.
lastModifiedTime optional string<date-time>	The value is automatically set by the application. User defined value is ignored.
lastModifiedBy optional string	The value is automatically set by the application. User defined value is ignored.
version optional integer<int64>	Only required when updating the resource. Must be null for new resources.
technicalDescription optional string	No description
technicalName string	No description
tags optional Array<string>	No description
properties optional object	A Map of name-value pairs.
type string	No description
uri string	No description

DataStoreInfo

object

Properties

id string	No description
name optional string	No description
type optional string	No description

Error

object

Properties

status string	No description
code string	No description
title string	No description
detail string	No description

ErrorResponse

object

Properties

errors Array<Error>	No description
traceId string	No description

FieldDataType

object

Properties

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
originalType optional string	No description
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.

JsonPatch

object

Properties

op string	The operation to be performed. Enum: add remove replace move copy test
path string	A JSON pointer to the property being affected.
value optional object	The value to add, replace or test.
from optional string	A JSON Pointer path pointing to the location to move/copy from.

Link

object

Properties

href

string

No description

Links

object

Properties

self optional Link	No description
first optional Link	No description
last optional Link	No description
next optional Link	No description
prev optional Link	No description

MetadataDomain

object

Properties

name string	No description
description string	No description
properties object	The properties map key is string and the value is another map. The purpose is to allow flexibility in defining any key value pair any level deep.

Operational

object

Operational

Properties

size integer<int64>	No description
rowCount integer<int64>	No description
lastLoadTime string<date-time>	No description
startDate string<date-time>	No description
endDate string<date-time>	No description
logMessage string	No description
status string	No description
location string	No description
contentUpdated boolean	No description
tableOwner string	No description
tableConnectionInfo optional TableConnectionInfo	No description
lastUpdateTime string<date-time>	No description

PageDataAsset

object

Properties

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

PageDataSet

object

Properties

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

PageDataSetRevision

object

Properties

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

PageDataStore

object

Properties

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

dataFields Array<DataField>	No description
effectiveDate optional string<date-time>	No description
schemaName optional string	No description

SystemProperties

object

Properties

sourceSystemId

string

No description

TableConnectionInfo

object

Properties

tableName string	No description
selectionScript string	No description
additionalProperties object	No description

v3.4.0