Data stores
Catalog Service provides persistence and REST APIs for Catalog CRUD and List operations.
Endpoints
Skip to sectionGET | /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.
Facts GET /v1/data-stores
Rate limit | Tier 1 (1000 requests per minute) |
Query Parameters GET /v1/data-stores
limit optional, default=20, maximum=100 integer<int32> | Page size limit. |
page optional integer<int32> | No description |
projections optional Array<string> | Comma-separated fields to return in the response. |
sort optional Array<string> | Comma-separated fields and field start with '-' character sorts the result set in descending order. |
Responses GET /v1/data-stores
200 optional, application/json | Successful Operation |
400 optional, application/json | The request is in incorrect format. |
401 optional, application/json | User does not have valid authentication credentials. |
403 optional, application/json | User does not have access to the resource. |
404 optional, application/json | Resource does not exist. |
409 optional, application/json | The input request conflicts with the current state of the resource. |
500 optional, application/json | Internal Server Error. |
503 optional, application/json | Requested service is not available. |
GET/v1/data-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-01-26T11:56:36.837Z",
"description": "string",
"technicalName": "string",
"lastModifiedBy": "string",
"lastModifiedTime": "2023-01-26T11:56:36.837Z",
"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.
Facts POST /v1/data-stores
Rate limit | Tier 2 (100 requests per minute) |
Request Body POST /v1/data-stores
Data Store application/json | No description |
Responses POST /v1/data-stores
201 optional, application/json | Created new data store successfully. |
400 optional, application/json | The request is in incorrect format. |
401 optional, application/json | User does not have valid authentication credentials. |
403 optional, application/json | User does not have access to the resource. |
404 optional, application/json | Resource does not exist. |
409 optional, application/json | The input request conflicts with the current state of the resource. |
500 optional, application/json | Internal Server Error. |
503 optional, application/json | Requested service is not available. |
POST/v1/data-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-01-26T11:56:36.837Z","description":"string","technicalName":"string","lastModifiedBy":"string","lastModifiedTime":"2023-01-26T11:56:36.837Z","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-01-26T11:56:36.837Z",
"description": "string",
"technicalName": "string",
"lastModifiedBy": "string",
"lastModifiedTime": "2023-01-26T11:56:36.837Z",
"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-01-26T11:56:36.837Z",
"description": "string",
"technicalName": "string",
"lastModifiedBy": "string",
"lastModifiedTime": "2023-01-26T11:56:36.837Z",
"technicalDescription": "string"
}
Delete data stores if it does not contain any data-assets.
Facts DELETE /v1/data-stores
Rate limit | Tier 2 (100 requests per minute) |
Request Body DELETE /v1/data-stores
optional, application/json | No description |
Responses DELETE /v1/data-stores
204 optional object | Deleted empty data stores. |
400 optional, application/json | The request is in incorrect format. |
401 optional, application/json | User does not have valid authentication credentials. |
403 optional, application/json | User does not have access to the resource. |
404 optional, application/json | Resource does not exist. |
409 optional, application/json | The input request conflicts with the current state of the resource. |
500 optional, application/json | Internal Server Error. |
503 optional, application/json | Requested service is not available. |
DELETE/v1/data-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.
Facts GET /v1/data-stores/{data-store-id}
Rate limit | Tier 1 (1000 requests per minute) |
Path Parameters GET /v1/data-stores/{data-store-id}
data-store-id string | No description |
Query Parameters GET /v1/data-stores/{data-store-id}
projections optional Array<string> | Comma-separated fields to return in the response. |
Responses GET /v1/data-stores/{data-store-id}
200 optional, application/json | Successful Operation. |
400 optional, application/json | The request is in incorrect format. |
401 optional, application/json | User does not have valid authentication credentials. |
403 optional, application/json | User does not have access to the resource. |
404 optional, application/json | Resource does not exist. |
409 optional, application/json | The input request conflicts with the current state of the resource. |
500 optional, application/json | Internal Server Error. |
503 optional, application/json | Requested service is not available. |
GET/v1/data-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-01-26T11:56:36.837Z",
"description": "string",
"technicalName": "string",
"lastModifiedBy": "string",
"lastModifiedTime": "2023-01-26T11:56:36.837Z",
"technicalDescription": "string"
}
Patch data store.
Facts PATCH /v1/data-stores/{data-store-id}
Rate limit | Tier 2 (100 requests per minute) |
Path Parameters PATCH /v1/data-stores/{data-store-id}
data-store-id string | No description |
Request Body PATCH /v1/data-stores/{data-store-id}
optional, application/json | No description |
Responses PATCH /v1/data-stores/{data-store-id}
200 optional, application/json | Patched data store successfully. |
204 optional, application/json | Patched data store successfully. |
400 optional, application/json | The request is in incorrect format. |
401 optional, application/json | User does not have valid authentication credentials. |
403 optional, application/json | User does not have access to the resource. |
404 optional, application/json | Resource does not exist. |
409 optional, application/json | The input request conflicts with the current state of the resource. |
500 optional, application/json | Internal Server Error. |
503 optional, application/json | Requested service is not available. |
PATCH/v1/data-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-01-26T11:56:36.837Z",
"description": "string",
"technicalName": "string",
"lastModifiedBy": "string",
"lastModifiedTime": "2023-01-26T11:56:36.837Z",
"technicalDescription": "string"
}
Update data store.
Facts PUT /v1/data-stores/{data-store-id}
Rate limit | Tier 2 (100 requests per minute) |
Path Parameters PUT /v1/data-stores/{data-store-id}
data-store-id string | No description |
Request Body PUT /v1/data-stores/{data-store-id}
Data Store application/json | No description |
Responses PUT /v1/data-stores/{data-store-id}
200 optional, application/json | Updated data store successfully. |
400 optional, application/json | The request is in incorrect format. |
401 optional, application/json | User does not have valid authentication credentials. |
403 optional, application/json | User does not have access to the resource. |
404 optional, application/json | Resource does not exist. |
409 optional, application/json | The input request conflicts with the current state of the resource. |
500 optional, application/json | Internal Server Error. |
503 optional, application/json | Requested service is not available. |
PUT/v1/data-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-01-26T11:56:36.837Z","description":"string","technicalName":"string","lastModifiedBy":"string","lastModifiedTime":"2023-01-26T11:56:36.837Z","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-01-26T11:56:36.837Z",
"description": "string",
"technicalName": "string",
"lastModifiedBy": "string",
"lastModifiedTime": "2023-01-26T11:56:36.837Z",
"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-01-26T11:56:36.837Z",
"description": "string",
"technicalName": "string",
"lastModifiedBy": "string",
"lastModifiedTime": "2023-01-26T11:56:36.837Z",
"technicalDescription": "string"
}
Get all data assets belonging to the data store(s).
Facts GET /v1/data-stores/{data-store-ids}/data-assets
Rate limit | Tier 1 (1000 requests per minute) |
Path Parameters GET /v1/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 /v1/data-stores/{data-store-ids}/data-assets
limit optional, default=20, maximum=100 integer<int32> | Page size limit. |
page optional integer<int32> | No description |
projections optional Array<string> | Comma-separated fields to return in the response. |
sort optional Array<string> | 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 optional, application/json | Successful Operation |
400 optional, application/json | The request is in incorrect format. |
401 optional, application/json | User does not have valid authentication credentials. |
403 optional, application/json | User does not have access to the resource. |
404 optional, application/json | Resource does not exist. |
409 optional, application/json | The input request conflicts with the current state of the resource. |
500 optional, application/json | Internal Server Error. |
503 optional, application/json | Requested service is not available. |
GET/v1/data-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-01-26T11:56:36.837Z",
"description": "string",
"dataStoreInfo": {
"id": "string",
"name": "string",
"type": "string"
},
"technicalName": "string",
"lastModifiedBy": "string",
"lastModifiedTime": "2023-01-26T11:56:36.838Z",
"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.
Facts DELETE /v1/data-stores/{data-store-ids}/data-assets
Rate limit | Tier 2 (100 requests per minute) |
Path Parameters DELETE /v1/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 /v1/data-stores/{data-store-ids}/data-assets
204 optional object | Deleted data assets successfully. |
400 optional, application/json | The request is in incorrect format. |
401 optional, application/json | User does not have valid authentication credentials. |
403 optional, application/json | User does not have access to the resource. |
404 optional, application/json | Resource does not exist. |
409 optional, application/json | The input request conflicts with the current state of the resource. |
500 optional, application/json | Internal Server Error. |
503 optional, application/json | Requested service is not available. |
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).
Facts GET /v1/data-stores/{data-store-ids}/data-assets/{data-asset-ids}/data-sets
Rate limit | 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 Array<string> | Comma-separated data asset IDs or * to include all data assets. |
data-store-ids 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 optional, default=20, maximum=100 integer<int32> | Page size limit. |
page optional integer<int32> | No description |
projections optional Array<string> | Comma-separated fields to return in the response. |
sort optional Array<string> | 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 optional, application/json | Successful Operation. |
400 optional, application/json | The request is in incorrect format. |
401 optional, application/json | User does not have valid authentication credentials. |
403 optional, application/json | User does not have access to the resource. |
404 optional, application/json | Resource does not exist. |
409 optional, application/json | The input request conflicts with the current state of the resource. |
500 optional, application/json | Internal Server Error. |
503 optional, application/json | Requested service is not available. |
GET/v1/data-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-01-26T11:56:36.838Z",
"overrideSchemaAnomalies": true
},
"ownerId": "string",
"spaceId": "string",
"version": 0,
"tenantId": "string",
"createdBy": "string",
"secureQri": "string",
"properties": {},
"createdTime": "2023-01-26T11:56:36.838Z",
"description": "string",
"operational": {
"size": 0,
"status": "string",
"endDate": "2023-01-26T11:56:36.838Z",
"location": "string",
"rowCount": 0,
"startDate": "2023-01-26T11:56:36.838Z",
"logMessage": "string",
"tableOwner": "string",
"lastLoadTime": "2023-01-26T11:56:36.838Z",
"contentUpdated": true,
"lastUpdateTime": "2023-01-26T11:56:36.838Z",
"tableConnectionInfo": {
"tableName": "string",
"selectionScript": "string",
"additionalProperties": {}
}
},
"dataAssetInfo": {
"id": "string",
"name": "string",
"dataStoreInfo": {
"id": "string",
"name": "string",
"type": "string"
}
},
"technicalName": "string",
"lastModifiedBy": "string",
"classifications": {
"subjectArea": "string",
"personalInformation": [
{
"fieldName": "string",
"tableName": "string",
"fieldAlias": "string"
}
],
"sensitiveInformation": [
{
"fieldName": "string",
"tableName": "string",
"fieldAlias": "string"
}
]
},
"lastModifiedTime": "2023-01-26T11:56:36.838Z",
"additionalSchemas": [
{
"anomalies": [],
"dataFields": [
{
"name": "string",
"tags": [],
"alias": "string",
"index": 0,
"orphan": true,
"dataType": {
"type": "DATE",
"properties": {},
"originalType": "string"
},
"nullable": true,
"userTags": [
{
"id": "string",
"name": "string"
}
],
"encrypted": true,
"sensitive": true,
"primaryKey": true,
"properties": {},
"description": "string",
"ordinalPositionInKey": 0
}
],
"schemaName": "string",
"loadOptions": {},
"effectiveDate": "2023-01-26T11:56:36.838Z",
"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.
Facts DELETE /v1/data-stores/{data-store-ids}/data-assets/{data-asset-ids}/data-sets
Rate limit | 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 Array<string> | Comma-separated data asset IDs or * to include all data assets. |
data-store-ids 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 optional object | Deleted data sets. |
400 optional, application/json | The request is in incorrect format. |
401 optional, application/json | User does not have valid authentication credentials. |
403 optional, application/json | User does not have access to the resource. |
404 optional, application/json | Resource does not exist. |
409 optional, application/json | The input request conflicts with the current state of the resource. |
500 optional, application/json | Internal Server Error. |
503 optional, application/json | Requested service is not available. |
DELETE/v1/data-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
objectProperties
fieldName optional string | No description |
tableName optional string | No description |
fieldAlias optional string | No description |
BatchIdDto
objectProperties
ids optional Array<string> | No description |
Classifications
objectClassifications
Properties
subjectArea optional string | No description |
personalInformation optional | No description |
sensitiveInformation optional | No description |
DataAsset
objectData Asset
Properties
id optional string | Only required when updating the resource. Must be null for new resources. |
name optional string | No description |
tags optional Array<string> | No description |
appId string | No description |
appType string | No description |
ownerId optional string | The value is automatically set by the application. |
spaceId optional string | No description |
version optional integer<int64> | Only required when updating the resource. Must be null for new resources. |
tenantId optional string | The value is automatically set by the application. User defined value is ignored. |
createdBy optional string | The value is automatically set by the application. User defined value is ignored. |
properties optional object | A Map of name-value pairs. |
createdTime optional string<date-time> | The value is automatically set by the application. User defined value is ignored. |
description optional string | No description |
dataStoreInfo optional | No description |
technicalName string | No description |
lastModifiedBy optional string | The value is automatically set by the application. User defined value is ignored. |
lastModifiedTime optional string<date-time> | The value is automatically set by the application. User defined value is ignored. |
technicalDescription optional string | No description |
DataAssetInfo
objectProperties
id string | No description |
name optional string | No description |
dataStoreInfo optional | No description |
DataField
objectProperties
name string | No description |
tags optional Array<string> | An array of system tags |
alias optional string | No description |
index optional integer<int32> | No description |
orphan optional boolean | No description |
dataType optional | No description |
nullable optional boolean | No description |
userTags optional | An array of user-supplied tags |
encrypted optional boolean | No description |
sensitive optional boolean | No description |
primaryKey optional boolean | No description |
properties optional object | No description |
description optional string | No description |
ordinalPositionInKey optional integer<int32> | No description |
DataSet
objectData Set
Properties
id optional string | Only required when updating the resource. Must be null for new resources. |
qri string<qdf:<store-type>:<tenant-guid>:<<uid@/sid@>user/space guid>:<path-to-file>> | NOTE: this will be deprecated after migration to secureQri. Required user defined field. All the parts in the format must be separated by ':'. The first part denotes the resourceType, followed by dataStoreType and tenant guid. The spaceGuid or userGuid is to be populated based on if the dataset is in shared or private space and finally the full file name. This field is auto populated for the dataSet generated for qix-datafiles. |
name optional string | No description |
tags optional Array<string> | No description |
type optional string | No description |
Schema optional | Optional field to specify additional schemas for files where multiple tables or sheets are available. User must define primary schema in 'schema' attribute and rest of the sheets/ tables can be defined using this field. This field is not populated for the dataSets with single schema |
ownerId optional string | The value is automatically set by the application. |
spaceId optional string | No description |
version optional integer<int64> | Only required when updating the resource. Must be null for new resources. |
tenantId optional string | The value is automatically set by the application. User defined value is ignored. |
createdBy optional string | The value is automatically set by the application. User defined value is ignored. |
secureQri string | No description |
properties optional object | A Map of name-value pairs. |
createdTime optional string<date-time> | The value is automatically set by the application. User defined value is ignored. |
description optional string | No description |
Operational optional | Operational |
dataAssetInfo optional | No description |
technicalName string | No description |
lastModifiedBy optional string | The value is automatically set by the application. User defined value is ignored. |
Classifications optional | Classifications |
lastModifiedTime optional string<date-time> | The value is automatically set by the application. User defined value is ignored. |
additionalSchemas optional | Optional field to specify additional schemas for files where multiple tables or sheets are available. User must define primary schema in 'schema' attribute and rest of the sheets/ tables can be defined using this field. This field is not populated for the dataSets with single schema |
technicalDescription optional string | No description |
DataStore
objectData Store
Properties
id optional string | Only required when updating the resource. Must be null for new resources. |
uri string | No description |
name optional string | No description |
tags optional Array<string> | No description |
type string | No description |
ownerId optional string | The value is automatically set by the application. |
spaceId optional string | No description |
version optional integer<int64> | Only required when updating the resource. Must be null for new resources. |
tenantId optional string | The value is automatically set by the application. User defined value is ignored. |
createdBy optional string | The value is automatically set by the application. User defined value is ignored. |
properties optional object | A Map of name-value pairs. |
createdTime optional string<date-time> | The value is automatically set by the application. User defined value is ignored. |
description optional string | No description |
technicalName string | No description |
lastModifiedBy optional string | The value is automatically set by the application. User defined value is ignored. |
lastModifiedTime optional string<date-time> | The value is automatically set by the application. User defined value is ignored. |
technicalDescription optional string | No description |
DataStoreInfo
objectProperties
id string | No description |
name optional string | No description |
type optional string | No description |
Error
objectProperties
code optional string | No description |
title optional string | No description |
detail optional string | No description |
status optional string | No description |
ErrorResponse
objectProperties
errors optional | No description |
traceId optional string | No description |
FieldDataType
objectProperties
type string | Each datatype may vary in terms of required properties. Example: Datatype DECIMAL requires two mandatory properties to be defined - precision and scale, each one accepts integer value. All other datatypes does not have any required properties. Enum: DATE TIME DATETIME TIMESTAMP STRING DOUBLE DECIMAL INTEGER BOOLEAN BINARY CUSTOM |
properties optional object | The properties map key is string and the value is of type object. Please note, Datatype DECIMAL requires two mandatory properties to be defined; these properties must be named: precision and scale, each of these property accepts integer value. All other datatypes does not require any manadatory properties to be defined. |
originalType optional string | No description |
JsonPatch
objectProperties
op string | The operation to be performed. Enum: add remove replace move copy test |
from optional string | A JSON Pointer path pointing to the location to move/copy from. |
path string | A JSON pointer to the property being affected. |
value optional object | The value to add, replace or test. |
Link
objectProperties
href optional string | No description |
Links
objectProperties
last optional | No description |
next optional | No description |
prev optional | No description |
self optional | No description |
first optional | No description |
Operational
objectOperational
Properties
size optional integer<int64> | No description |
status optional string | No description |
endDate optional string<date-time> | No description |
location optional string | No description |
rowCount optional integer<int64> | No description |
startDate optional string<date-time> | No description |
logMessage optional string | No description |
tableOwner optional string | No description |
lastLoadTime optional string<date-time> | No description |
contentUpdated optional boolean | No description |
lastUpdateTime optional string<date-time> | No description |
tableConnectionInfo optional | No description |
PageDataAsset
objectProperties
data optional | No description |
page optional integer<int32> | No description |
limit optional integer<int32> | No description |
links optional | No description |
pages optional integer<int32> | No description |
total optional integer<int64> | No description |
PageDataSet
objectProperties
data optional | No description |
page optional integer<int32> | No description |
limit optional integer<int32> | No description |
links optional | No description |
pages optional integer<int32> | No description |
total optional integer<int64> | No description |
PageDataStore
objectProperties
data optional | No description |
page optional integer<int32> | No description |
limit optional integer<int32> | No description |
links optional | No description |
pages optional integer<int32> | No description |
total optional integer<int64> | No description |
Schema
objectOptional field to specify additional schemas for files where multiple tables or sheets are available. User must define primary schema in 'schema' attribute and rest of the sheets/ tables can be defined using this field. This field is not populated for the dataSets with single schema
Properties
anomalies optional Array<string> | No description |
dataFields | No description |
schemaName optional string | No description |
loadOptions optional object | No description |
effectiveDate optional string<date-time> | No description |
overrideSchemaAnomalies optional boolean | No description |
TableConnectionInfo
objectProperties
tableName optional string | No description |
selectionScript optional string | No description |
additionalProperties optional object | No description |
UserTag
objectAn array of user-supplied tags
Properties
id optional string | The id of the tag in Collections |
name optional string | No description |