Skip to content

data-sets

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

Endpoints

Skip to section
POST/data-sets
DELETE/data-sets/
GET/data-sets/{data-set-id}
PUT/data-sets/{data-set-id}
PATCH/data-sets/{data-set-id}

Save new data set

Request Body POST /data-sets

Data Set
application/json

No description

Responses POST /data-sets

201
application/json

Created new data set successfully.

400
application/json

The request is in incorrect format.

401
application/json

User does not have valid authentication credentials.

403
application/json

User does not have access to the resource.

404
application/json

Resource does not exist.

409
application/json

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

500
application/json

Internal Server Error.

503
application/json

Requested service is not available.

POST/data-sets

curl "https://your-tenant.us.qlikcloud.com/api/v1/data-sets" \
 -X POST \
 -H "Authorization: Bearer <API-key>" \
 -H "Content-type: application/json" \
 -d '{"id":"string","name":"string","description":"string","tenantId":"string","spaceId":"string","ownerId":"string","createdTime":"2022-06-28T20:33:35.168Z","createdBy":"string","lastModifiedTime":"2022-06-28T20:33:35.168Z","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.168Z","startDate":"2022-06-28T20:33:35.168Z","endDate":"2022-06-28T20:33:35.168Z","logMessage":"string","status":"string","location":"string","contentUpdated":true,"tableOwner":"string","tableConnectionInfo":{"tableName":"string","selectionScript":"string","additionalProperties":{}},"lastUpdateTime":"2022-06-28T20:33:35.168Z"},"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.168Z","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.168Z","schemaName":"string"}],"qri":"string","secureQri":"string","type":"string","classifications":{"subjectArea":"string","personalInformation":[],"sensitiveInformation":[]}}'

Request POST /data-sets

{
  "id": "string",
  "name": "string",
  "description": "string",
  "tenantId": "string",
  "spaceId": "string",
  "ownerId": "string",
  "createdTime": "2022-06-28T20:33:35.168Z",
  "createdBy": "string",
  "lastModifiedTime": "2022-06-28T20:33:35.168Z",
  "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.168Z",
    "startDate": "2022-06-28T20:33:35.168Z",
    "endDate": "2022-06-28T20:33:35.168Z",
    "logMessage": "string",
    "status": "string",
    "location": "string",
    "contentUpdated": true,
    "tableOwner": "string",
    "tableConnectionInfo": {
      "tableName": "string",
      "selectionScript": "string",
      "additionalProperties": {}
    },
    "lastUpdateTime": "2022-06-28T20:33:35.168Z"
  },
  "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.168Z",
    "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.168Z",
      "schemaName": "string"
    }
  ],
  "qri": "string",
  "secureQri": "string",
  "type": "string",
  "classifications": {
    "subjectArea": "string",
    "personalInformation": [],
    "sensitiveInformation": []
  }
}

Response POST /data-sets

{
  "id": "string",
  "name": "string",
  "description": "string",
  "tenantId": "string",
  "spaceId": "string",
  "ownerId": "string",
  "createdTime": "2022-06-28T20:33:35.168Z",
  "createdBy": "string",
  "lastModifiedTime": "2022-06-28T20:33:35.168Z",
  "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.168Z",
    "startDate": "2022-06-28T20:33:35.168Z",
    "endDate": "2022-06-28T20:33:35.168Z",
    "logMessage": "string",
    "status": "string",
    "location": "string",
    "contentUpdated": true,
    "tableOwner": "string",
    "tableConnectionInfo": {
      "tableName": "string",
      "selectionScript": "string",
      "additionalProperties": {}
    },
    "lastUpdateTime": "2022-06-28T20:33:35.168Z"
  },
  "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.168Z",
    "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.168Z",
      "schemaName": "string"
    }
  ],
  "qri": "string",
  "secureQri": "string",
  "type": "string",
  "classifications": {
    "subjectArea": "string",
    "personalInformation": [],
    "sensitiveInformation": []
  }
}

Batch delete data sets.

Request Body DELETE /data-sets/

application/json

No description

Responses DELETE /data-sets/

204
object

Deleted data sets.

400
application/json

The request is in incorrect format.

401
application/json

User does not have valid authentication credentials.

403
application/json

User does not have access to the resource.

404
application/json

Resource does not exist.

409
application/json

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

500
application/json

Internal Server Error.

503
application/json

Requested service is not available.

DELETE/data-sets/

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

Request DELETE /data-sets/

{
  "ids": []
}

Get data set by ID.

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

data-set-id
string

No description

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

projections
optional
Array<string>

Comma-separated fields to return in the response.

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

200
application/json

Successful Operation.

400
application/json

The request is in incorrect format.

401
application/json

User does not have valid authentication credentials.

403
application/json

User does not have access to the resource.

404
application/json

Resource does not exist.

409
application/json

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

500
application/json

Internal Server Error.

503
application/json

Requested service is not available.

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

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

Response GET /data-sets/{data-set-id}

{
  "id": "string",
  "name": "string",
  "description": "string",
  "tenantId": "string",
  "spaceId": "string",
  "ownerId": "string",
  "createdTime": "2022-06-28T20:33:35.168Z",
  "createdBy": "string",
  "lastModifiedTime": "2022-06-28T20:33:35.168Z",
  "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.168Z",
    "startDate": "2022-06-28T20:33:35.168Z",
    "endDate": "2022-06-28T20:33:35.168Z",
    "logMessage": "string",
    "status": "string",
    "location": "string",
    "contentUpdated": true,
    "tableOwner": "string",
    "tableConnectionInfo": {
      "tableName": "string",
      "selectionScript": "string",
      "additionalProperties": {}
    },
    "lastUpdateTime": "2022-06-28T20:33:35.168Z"
  },
  "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.169Z",
    "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.169Z",
      "schemaName": "string"
    }
  ],
  "qri": "string",
  "secureQri": "string",
  "type": "string",
  "classifications": {
    "subjectArea": "string",
    "personalInformation": [],
    "sensitiveInformation": []
  }
}

Update data set.

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

data-set-id
string

No description

Request Body PUT /data-sets/{data-set-id}

Data Set
application/json

No description

Responses PUT /data-sets/{data-set-id}

200
application/json

Updated data set successfully.

400
application/json

The request is in incorrect format.

401
application/json

User does not have valid authentication credentials.

403
application/json

User does not have access to the resource.

404
application/json

Resource does not exist.

409
application/json

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

500
application/json

Internal Server Error.

503
application/json

Requested service is not available.

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

curl "https://your-tenant.us.qlikcloud.com/api/v1/data-sets/{data-set-id}" \
 -X PUT \
 -H "Authorization: Bearer <API-key>" \
 -H "Content-type: application/json" \
 -d '{"id":"string","name":"string","description":"string","tenantId":"string","spaceId":"string","ownerId":"string","createdTime":"2022-06-28T20:33:35.169Z","createdBy":"string","lastModifiedTime":"2022-06-28T20:33:35.169Z","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.169Z","startDate":"2022-06-28T20:33:35.169Z","endDate":"2022-06-28T20:33:35.169Z","logMessage":"string","status":"string","location":"string","contentUpdated":true,"tableOwner":"string","tableConnectionInfo":{"tableName":"string","selectionScript":"string","additionalProperties":{}},"lastUpdateTime":"2022-06-28T20:33:35.169Z"},"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.169Z","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.169Z","schemaName":"string"}],"qri":"string","secureQri":"string","type":"string","classifications":{"subjectArea":"string","personalInformation":[],"sensitiveInformation":[]}}'

Request PUT /data-sets/{data-set-id}

{
  "id": "string",
  "name": "string",
  "description": "string",
  "tenantId": "string",
  "spaceId": "string",
  "ownerId": "string",
  "createdTime": "2022-06-28T20:33:35.169Z",
  "createdBy": "string",
  "lastModifiedTime": "2022-06-28T20:33:35.169Z",
  "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.169Z",
    "startDate": "2022-06-28T20:33:35.169Z",
    "endDate": "2022-06-28T20:33:35.169Z",
    "logMessage": "string",
    "status": "string",
    "location": "string",
    "contentUpdated": true,
    "tableOwner": "string",
    "tableConnectionInfo": {
      "tableName": "string",
      "selectionScript": "string",
      "additionalProperties": {}
    },
    "lastUpdateTime": "2022-06-28T20:33:35.169Z"
  },
  "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.169Z",
    "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.169Z",
      "schemaName": "string"
    }
  ],
  "qri": "string",
  "secureQri": "string",
  "type": "string",
  "classifications": {
    "subjectArea": "string",
    "personalInformation": [],
    "sensitiveInformation": []
  }
}

Response PUT /data-sets/{data-set-id}

{
  "id": "string",
  "name": "string",
  "description": "string",
  "tenantId": "string",
  "spaceId": "string",
  "ownerId": "string",
  "createdTime": "2022-06-28T20:33:35.169Z",
  "createdBy": "string",
  "lastModifiedTime": "2022-06-28T20:33:35.169Z",
  "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.169Z",
    "startDate": "2022-06-28T20:33:35.169Z",
    "endDate": "2022-06-28T20:33:35.169Z",
    "logMessage": "string",
    "status": "string",
    "location": "string",
    "contentUpdated": true,
    "tableOwner": "string",
    "tableConnectionInfo": {
      "tableName": "string",
      "selectionScript": "string",
      "additionalProperties": {}
    },
    "lastUpdateTime": "2022-06-28T20:33:35.169Z"
  },
  "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.169Z",
    "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.169Z",
      "schemaName": "string"
    }
  ],
  "qri": "string",
  "secureQri": "string",
  "type": "string",
  "classifications": {
    "subjectArea": "string",
    "personalInformation": [],
    "sensitiveInformation": []
  }
}

Patch data set.

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

data-set-id
string

No description

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

application/json

No description

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

200
application/json

Patched data set successfully.

204
application/json

Patched data set successfully.

400
application/json

The request is in incorrect format.

401
application/json

User does not have valid authentication credentials.

403
application/json

User does not have access to the resource.

404
application/json

Resource does not exist.

409
application/json

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

500
application/json

Internal Server Error.

503
application/json

Requested service is not available.

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

curl "https://your-tenant.us.qlikcloud.com/api/v1/data-sets/{data-set-id}" \
 -X PATCH \
 -H "Authorization: Bearer <API-key>" \
 -H "Content-type: application/json" \
 -d '{"op":"add","path":"string","value":{},"from":"string"}'

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

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

Response PATCH /data-sets/{data-set-id}

{
  "id": "string",
  "name": "string",
  "description": "string",
  "tenantId": "string",
  "spaceId": "string",
  "ownerId": "string",
  "createdTime": "2022-06-28T20:33:35.169Z",
  "createdBy": "string",
  "lastModifiedTime": "2022-06-28T20:33:35.169Z",
  "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.169Z",
    "startDate": "2022-06-28T20:33:35.169Z",
    "endDate": "2022-06-28T20:33:35.169Z",
    "logMessage": "string",
    "status": "string",
    "location": "string",
    "contentUpdated": true,
    "tableOwner": "string",
    "tableConnectionInfo": {
      "tableName": "string",
      "selectionScript": "string",
      "additionalProperties": {}
    },
    "lastUpdateTime": "2022-06-28T20:33:35.169Z"
  },
  "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.169Z",
    "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.169Z",
      "schemaName": "string"
    }
  ],
  "qri": "string",
  "secureQri": "string",
  "type": "string",
  "classifications": {
    "subjectArea": "string",
    "personalInformation": [],
    "sensitiveInformation": []
  }
}

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

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

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

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

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

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

No description

Operational
optional

Operational

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

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

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

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

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

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

changes
optional

No description

additionalSchemas
optional

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

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.

object

Properties

href
string

No description

object

Properties

self
optional

No description

first
optional

No description

last
optional

No description

next
optional

No description

prev
optional

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

No description

lastUpdateTime
string<date-time>

No description

PageDataAsset

object

Properties

data

No description

page
integer<int32>

No description

limit
integer<int32>

No description

total
integer<int64>

No description

pages
integer<int32>

No description

links
optional

No description

PageDataSet

object

Properties

data

No description

page
integer<int32>

No description

limit
integer<int32>

No description

total
integer<int64>

No description

pages
integer<int32>

No description

links
optional

No description

PageDataSetRevision

object

Properties

data

No description

page
integer<int32>

No description

limit
integer<int32>

No description

total
integer<int64>

No description

pages
integer<int32>

No description

links
optional

No description

PageDataStore

object

Properties

data

No description

page
integer<int32>

No description

limit
integer<int32>

No description

total
integer<int64>

No description

pages
integer<int32>

No description

links
optional

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

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
Was this page helpful?