Data sets

Data sets are part of the catalog in Qlik Cloud. A data set is a member of a data asset.

Download OpenAPI spec

Save a new data set

Creates and saves a new data set in the catalog.

Facts

Rate limit Tier 2 (100 requests per minute)

Request Body

Required
  • application/json object
    Show application/json properties
    • id string

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

    • qri string
      Required

      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.

      minLength = 8, maxLength = 1024, format = "qdf:<store-type>:<tenant-guid>:<<uid@/sid@>user/space guid>:<path-to-file>"

    • name string

      minLength = 0, maxLength = 255

    • tags array of strings

      uniqueItems = true

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

      Show schema properties
      • anomalies array of strings

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

        uniqueItems = true

      • dataFields array of objects
        Required
        Show dataFields properties
        • name string
          Required

          minLength = 1, maxLength = 255

        • tags array of strings

          An array of system tags

          uniqueItems = true

        • alias string

          Alias of the field. Must be unique within the schema and must not match another field's name. Returns 400 if violated.

        • index integer

          format = int32

        • orphan boolean
        • dataType object
          Required
          Show dataType properties
          • type string
            Required

            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.

            Can be one of: "DATE""TIME""DATETIME""TIMESTAMP""STRING""DOUBLE""DECIMAL""INTEGER""BOOLEAN""BINARY""CUSTOM"

          • properties object

            The properties map key is string and the value is of type object. Please note, Datatype DECIMAL requires two mandatory properties to be defined; these properties must be named: precision and scale, each of these property accepts integer value. All other datatypes does not require any manadatory properties to be defined.

            Show additional optional properties
            • object object

              The properties map key is string and the value is of type object. Please note, Datatype DECIMAL requires two mandatory properties to be defined; these properties must be named: precision and scale, each of these property accepts integer value. All other datatypes does not require any manadatory properties to be defined.
          • originalType string
        • nullable boolean
        • userTags array of objects

          An array of user-supplied tags

          uniqueItems = true

          Show userTags properties
          • id string

            The id of the tag in Collections

          • name string

            minLength = 1, maxLength = 128

        • encrypted boolean
        • sensitive boolean
        • primaryKey boolean
        • properties object
          Show additional optional properties
          • object object
        • description string
        • ordinalPositionInKey integer

          format = int32

      • schemaName string
      • loadOptions object

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

        Show additional optional properties
        • object object

          Options for loading files. Example: "qLabel": "embedded labels"
      • overrideSchemaAnomalies boolean
    • ownerId string

      The value is automatically set by the application.

    • spaceId string
    • version integer

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

      format = int64

    • secureQri string
      Required
    • properties object

      A Map of name-value pairs.

      Show additional optional properties
      • object object

        A Map of name-value pairs.
    • description string

      minLength = 0, maxLength = 1024

    • operational object
      Show operational properties
      • size integer

        format = int64

      • status string
      • endDate string

        format = "date-time"

      • location string
      • rowCount integer

        format = int64

      • startDate string

        format = "date-time"

      • logMessage string
      • tableOwner string
      • lastLoadTime string

        format = "date-time"

      • contentUpdated boolean
      • lastUpdateTime string

        format = "date-time"

      • tableConnectionInfo object
        Show tableConnectionInfo properties
        • tableName string
        • selectionScript string
        • additionalProperties object
          Show additional optional properties
          • string string
    • dataAssetInfo object
      Required
      Show dataAssetInfo properties
      • id string
        Required
      • dataStoreInfo object
        Show dataStoreInfo properties
        • id string
          Required
    • technicalName string
      Required

      minLength = 1, maxLength = 255

    • appTypeOverride string

      Optional override of DataAsset appType.

    • additionalSchemas array of objects

      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

      Show additionalSchemas properties
      • anomalies array of strings

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

        uniqueItems = true

      • dataFields array of objects
        Required
        Show dataFields properties
        • name string
          Required

          minLength = 1, maxLength = 255

        • tags array of strings

          An array of system tags

          uniqueItems = true

        • alias string

          Alias of the field. Must be unique within the schema and must not match another field's name. Returns 400 if violated.

        • index integer

          format = int32

        • orphan boolean
        • dataType object
          Required
          Show dataType properties
          • type string
            Required

            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.

            Can be one of: "DATE""TIME""DATETIME""TIMESTAMP""STRING""DOUBLE""DECIMAL""INTEGER""BOOLEAN""BINARY""CUSTOM"

          • properties object

            The properties map key is string and the value is of type object. Please note, Datatype DECIMAL requires two mandatory properties to be defined; these properties must be named: precision and scale, each of these property accepts integer value. All other datatypes does not require any manadatory properties to be defined.

            Show additional optional properties
            • object object

              The properties map key is string and the value is of type object. Please note, Datatype DECIMAL requires two mandatory properties to be defined; these properties must be named: precision and scale, each of these property accepts integer value. All other datatypes does not require any manadatory properties to be defined.
          • originalType string
        • nullable boolean
        • userTags array of objects

          An array of user-supplied tags

          uniqueItems = true

          Show userTags properties
          • id string

            The id of the tag in Collections

          • name string

            minLength = 1, maxLength = 128

        • encrypted boolean
        • sensitive boolean
        • primaryKey boolean
        • properties object
          Show additional optional properties
          • object object
        • description string
        • ordinalPositionInKey integer

          format = int32

      • schemaName string
      • loadOptions object

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

        Show additional optional properties
        • object object

          Options for loading files. Example: "qLabel": "embedded labels"
      • effectiveDate string

        format = "date-time"

      • overrideSchemaAnomalies boolean
    • technicalDescription string

      minLength = 0, maxLength = 1024

    • createdByConnectionId string

      The connectionId that created the Dataset. Optional.

Responses

201

Created new data set successfully.

  • application/json object
    Show application/json properties
    • id string

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

    • qri string
      Required

      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.

      minLength = 8, maxLength = 1024, format = "qdf:<store-type>:<tenant-guid>:<<uid@/sid@>user/space guid>:<path-to-file>"

    • name string

      minLength = 0, maxLength = 255

    • tags array of strings

      uniqueItems = true

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

      Show schema properties
      • anomalies array of strings

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

        uniqueItems = true

      • dataFields array of objects
        Required
        Show dataFields properties
        • name string
          Required

          minLength = 1, maxLength = 255

        • tags array of strings

          An array of system tags

          uniqueItems = true

        • alias string

          Alias of the field. Must be unique within the schema and must not match another field's name. Returns 400 if violated.

        • index integer

          format = int32

        • orphan boolean
        • dataType object
          Required
          Show dataType properties
          • type string
            Required

            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.

            Can be one of: "DATE""TIME""DATETIME""TIMESTAMP""STRING""DOUBLE""DECIMAL""INTEGER""BOOLEAN""BINARY""CUSTOM"

          • properties object

            The properties map key is string and the value is of type object. Please note, Datatype DECIMAL requires two mandatory properties to be defined; these properties must be named: precision and scale, each of these property accepts integer value. All other datatypes does not require any manadatory properties to be defined.

            Show additional optional properties
            • object object

              The properties map key is string and the value is of type object. Please note, Datatype DECIMAL requires two mandatory properties to be defined; these properties must be named: precision and scale, each of these property accepts integer value. All other datatypes does not require any manadatory properties to be defined.
          • originalType string
        • nullable boolean
        • userTags array of objects

          An array of user-supplied tags

          uniqueItems = true

          Show userTags properties
          • id string

            The id of the tag in Collections

          • name string

            minLength = 1, maxLength = 128

        • encrypted boolean
        • sensitive boolean
        • primaryKey boolean
        • properties object
          Show additional optional properties
          • object object
        • description string
        • ordinalPositionInKey integer

          format = int32

      • schemaName string
      • loadOptions object

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

        Show additional optional properties
        • object object

          Options for loading files. Example: "qLabel": "embedded labels"
      • effectiveDate string

        format = "date-time"

      • overrideSchemaAnomalies boolean
    • ownerId string

      The value is automatically set by the application.

    • spaceId string
    • version integer

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

      format = int64

    • tenantId string

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

    • createdBy string

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

    • secureQri string
      Required
    • properties object

      A Map of name-value pairs.

      Show additional optional properties
      • object object

        A Map of name-value pairs.
    • createdTime string

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

      format = "date-time"

    • description string

      minLength = 0, maxLength = 1024

    • operational object
      Show operational properties
      • size integer

        format = int64

      • status string
      • endDate string

        format = "date-time"

      • location string
      • rowCount integer

        format = int64

      • startDate string

        format = "date-time"

      • logMessage string
      • tableOwner string
      • lastLoadTime string

        format = "date-time"

      • contentUpdated boolean
      • lastUpdateTime string

        format = "date-time"

      • tableConnectionInfo object
        Show tableConnectionInfo properties
        • tableName string
        • selectionScript string
        • additionalProperties object
          Show additional optional properties
          • string string
    • dataAssetInfo object
      Required
      Show dataAssetInfo properties
      • id string
        Required
      • name string
      • dataStoreInfo object
        Show dataStoreInfo properties
        • id string
          Required
        • name string
        • type string
    • technicalName string
      Required

      minLength = 1, maxLength = 255

    • lastModifiedBy string

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

    • appTypeOverride string

      Optional override of DataAsset appType.

    • lastModifiedTime string

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

      format = "date-time"

    • additionalSchemas array of objects

      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

      Show additionalSchemas properties
      • anomalies array of strings

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

        uniqueItems = true

      • dataFields array of objects
        Required
        Show dataFields properties
        • name string
          Required

          minLength = 1, maxLength = 255

        • tags array of strings

          An array of system tags

          uniqueItems = true

        • alias string

          Alias of the field. Must be unique within the schema and must not match another field's name. Returns 400 if violated.

        • index integer

          format = int32

        • orphan boolean
        • dataType object
          Required
          Show dataType properties
          • type string
            Required

            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.

            Can be one of: "DATE""TIME""DATETIME""TIMESTAMP""STRING""DOUBLE""DECIMAL""INTEGER""BOOLEAN""BINARY""CUSTOM"

          • properties object

            The properties map key is string and the value is of type object. Please note, Datatype DECIMAL requires two mandatory properties to be defined; these properties must be named: precision and scale, each of these property accepts integer value. All other datatypes does not require any manadatory properties to be defined.

            Show additional optional properties
            • object object

              The properties map key is string and the value is of type object. Please note, Datatype DECIMAL requires two mandatory properties to be defined; these properties must be named: precision and scale, each of these property accepts integer value. All other datatypes does not require any manadatory properties to be defined.
          • originalType string
        • nullable boolean
        • userTags array of objects

          An array of user-supplied tags

          uniqueItems = true

          Show userTags properties
          • id string

            The id of the tag in Collections

          • name string

            minLength = 1, maxLength = 128

        • encrypted boolean
        • sensitive boolean
        • primaryKey boolean
        • properties object
          Show additional optional properties
          • object object
        • description string
        • ordinalPositionInKey integer

          format = int32

      • schemaName string
      • loadOptions object

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

        Show additional optional properties
        • object object

          Options for loading files. Example: "qLabel": "embedded labels"
      • effectiveDate string

        format = "date-time"

      • overrideSchemaAnomalies boolean
    • technicalDescription string

      minLength = 0, maxLength = 1024

    • createdByConnectionId string

      The connectionId that created the Dataset. Optional.

400

The request is in incorrect format. Also returned when field aliases are not unique within a schema or conflict with another field's name.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
      • status string
    • traceId string

401

User does not have valid authentication credentials.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
      • status string
    • traceId string

403

User does not have access to the resource.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
      • status string
    • traceId string

404

Resource does not exist.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
      • status string
    • traceId string

409

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

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
      • status string
    • traceId string

500

Internal Server Error.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
      • status string
    • traceId string

503

Requested service is not available.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
      • status string
    • traceId string
POST /api/v1/data-sets 
import { createQlikApi } from '@qlik/api'


const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})


await qlik.dataSets.createDataSet({
  additionalSchemas: [
    {
      anomalies: ['string'],
      dataFields: [
        {
          alias: 'string',
          dataType: {
            originalType: 'string',
            properties: {},
            type: 'DATE',
          },
          description: 'string',
          encrypted: true,
          name: 'string',
          nullable: true,
          ordinalPositionInKey: 42,
          orphan: true,
          primaryKey: true,
          properties: {},
          sensitive: true,
          tags: ['string'],
          userTags: [
            { id: 'string', name: 'string' },
          ],
        },
      ],
      loadOptions: {},
      overrideSchemaAnomalies: true,
      schemaName: 'string',
    },
  ],
  appTypeOverride: 'string',
  createdByConnectionId: 'string',
  dataAssetInfo: {
    dataStoreInfo: { id: 'string' },
    id: 'string',
  },
  description: 'string',
  id: 'string',
  name: 'string',
  operational: {
    contentUpdated: true,
    endDate: '2018-10-30T07:06:22Z',
    lastLoadTime: '2018-10-30T07:06:22Z',
    lastUpdateTime: '2018-10-30T07:06:22Z',
    location: 'string',
    logMessage: 'string',
    rowCount: 42,
    size: 42,
    startDate: '2018-10-30T07:06:22Z',
    status: 'string',
    tableConnectionInfo: {
      additionalProperties: {},
      selectionScript: 'string',
      tableName: 'string',
    },
    tableOwner: 'string',
  },
  ownerId: 'string',
  properties: {},
  qri: 'string',
  schema: {
    anomalies: ['string'],
    dataFields: [
      {
        alias: 'string',
        dataType: {
          originalType: 'string',
          properties: {},
          type: 'DATE',
        },
        description: 'string',
        encrypted: true,
        name: 'string',
        nullable: true,
        ordinalPositionInKey: 42,
        orphan: true,
        primaryKey: true,
        properties: {},
        sensitive: true,
        tags: ['string'],
        userTags: [
          { id: 'string', name: 'string' },
        ],
      },
    ],
    loadOptions: {},
    overrideSchemaAnomalies: true,
    schemaName: 'string',
  },
  secureQri: 'string',
  spaceId: 'string',
  tags: ['string'],
  technicalDescription: 'string',
  technicalName: 'string',
  type: 'string',
  version: 42,
})
qlik data-set create \
  --additionalSchemas-dataFields-alias '' \
  --additionalSchemas-dataFields-dataType-originalType '' \
  --additionalSchemas-dataFields-dataType-type '' \
  --additionalSchemas-dataFields-description '' \
  --additionalSchemas-dataFields-encrypted  \
  --additionalSchemas-dataFields-name '' \
  --additionalSchemas-dataFields-nullable  \
  --additionalSchemas-dataFields-ordinalPositionInKey  \
  --additionalSchemas-dataFields-orphan  \
  --additionalSchemas-dataFields-primaryKey  \
  --additionalSchemas-dataFields-sensitive  \
  --additionalSchemas-dataFields-tags '' \
  --additionalSchemas-dataFields-userTags-id '' \
  --additionalSchemas-dataFields-userTags-name '' \
  --dataAssetInfo-dataStoreInfo-id 'string' \
  --dataAssetInfo-id 'string' \
  --qri 'string' \
  --schema-dataFields-alias '' \
  --schema-dataFields-dataType-originalType '' \
  --schema-dataFields-dataType-type '' \
  --schema-dataFields-description '' \
  --schema-dataFields-encrypted  \
  --schema-dataFields-name '' \
  --schema-dataFields-nullable  \
  --schema-dataFields-ordinalPositionInKey  \
  --schema-dataFields-orphan  \
  --schema-dataFields-primaryKey  \
  --schema-dataFields-sensitive  \
  --schema-dataFields-tags '' \
  --schema-dataFields-userTags-id '' \
  --schema-dataFields-userTags-name '' \
  --secureQri 'string' \
  --technicalName 'string'
curl "https://{tenant}.{region}.qlikcloud.com/api/v1/data-sets" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{"id":"string","qri":"string","name":"string","tags":["string"],"type":"string","schema":{"anomalies":["string"],"dataFields":[{"name":"string","tags":["string"],"alias":"string","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":42}],"schemaName":"string","loadOptions":{},"overrideSchemaAnomalies":true},"ownerId":"string","spaceId":"string","version":42,"secureQri":"string","properties":{},"description":"string","operational":{"size":42,"status":"string","endDate":"2018-10-30T07:06:22Z","location":"string","rowCount":42,"startDate":"2018-10-30T07:06:22Z","logMessage":"string","tableOwner":"string","lastLoadTime":"2018-10-30T07:06:22Z","contentUpdated":true,"lastUpdateTime":"2018-10-30T07:06:22Z","tableConnectionInfo":{"tableName":"string","selectionScript":"string","additionalProperties":{}}},"dataAssetInfo":{"id":"string","dataStoreInfo":{"id":"string"}},"technicalName":"string","appTypeOverride":"string","additionalSchemas":[{"anomalies":["string"],"dataFields":[{"name":"string","tags":["string"],"alias":"string","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":42}],"schemaName":"string","loadOptions":{},"overrideSchemaAnomalies":true}],"technicalDescription":"string","createdByConnectionId":"string"}'

Example Response

{
  "id": "string",
  "qri": "string",
  "name": "string",
  "tags": [
    "string"
  ],
  "type": "string",
  "schema": {
    "anomalies": [
      "string"
    ],
    "dataFields": [
      {
        "name": "string",
        "tags": [
          "string"
        ],
        "alias": "string",
        "index": 42,
        "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": 42
      }
    ],
    "schemaName": "string",
    "loadOptions": {},
    "effectiveDate": "2018-10-30T07:06:22Z",
    "overrideSchemaAnomalies": true
  },
  "ownerId": "string",
  "spaceId": "string",
  "version": 42,
  "tenantId": "string",
  "createdBy": "string",
  "secureQri": "string",
  "properties": {},
  "createdTime": "2018-10-30T07:06:22Z",
  "description": "string",
  "operational": {
    "size": 42,
    "status": "string",
    "endDate": "2018-10-30T07:06:22Z",
    "location": "string",
    "rowCount": 42,
    "startDate": "2018-10-30T07:06:22Z",
    "logMessage": "string",
    "tableOwner": "string",
    "lastLoadTime": "2018-10-30T07:06:22Z",
    "contentUpdated": true,
    "lastUpdateTime": "2018-10-30T07:06:22Z",
    "tableConnectionInfo": {
      "tableName": "string",
      "selectionScript": "string",
      "additionalProperties": {}
    }
  },
  "dataAssetInfo": {
    "id": "string",
    "name": "string",
    "dataStoreInfo": {
      "id": "string",
      "name": "string",
      "type": "string"
    }
  },
  "technicalName": "string",
  "lastModifiedBy": "string",
  "appTypeOverride": "string",
  "lastModifiedTime": "2018-10-30T07:06:22Z",
  "additionalSchemas": [
    {
      "anomalies": [
        "string"
      ],
      "dataFields": [
        {
          "name": "string",
          "tags": [
            "string"
          ],
          "alias": "string",
          "index": 42,
          "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": 42
        }
      ],
      "schemaName": "string",
      "loadOptions": {},
      "effectiveDate": "2018-10-30T07:06:22Z",
      "overrideSchemaAnomalies": true
    }
  ],
  "technicalDescription": "string",
  "createdByConnectionId": "string"
}

Batch delete data sets.

Facts

Rate limit Tier 2 (100 requests per minute)

Request Body

Required
  • application/json object
    Show application/json properties
    • ids array of strings

      uniqueItems = true

Responses

204

Deleted data sets.

400

The request is in incorrect format.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
      • status string
    • traceId string

401

User does not have valid authentication credentials.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
      • status string
    • traceId string

403

User does not have access to the resource.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
      • status string
    • traceId string

404

Resource does not exist.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
      • status string
    • traceId string

409

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

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
      • status string
    • traceId string

500

Internal Server Error.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
      • status string
    • traceId string

503

Requested service is not available.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
      • status string
    • traceId string
DELETE /api/v1/data-sets 
import { createQlikApi } from '@qlik/api'


const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})


await qlik.dataSets.deleteDataSets({
  ids: ['string'],
})
qlik data-set delete-many
curl "https://{tenant}.{region}.qlikcloud.com/api/v1/data-sets" \
-X DELETE \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{"ids":["string"]}'

Get data set by ID.

Facts

Rate limit Tier 1 (1000 requests per minute)

Query Parameters

  • projections array of strings

    Comma-separated fields to return in the response.

Path Parameters

  • data-set-id string
    Required

Responses

200

Successful Operation.

  • application/json object
    Show application/json properties
    • id string

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

    • qri string
      Required

      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.

      minLength = 8, maxLength = 1024, format = "qdf:<store-type>:<tenant-guid>:<<uid@/sid@>user/space guid>:<path-to-file>"

    • name string

      minLength = 0, maxLength = 255

    • tags array of strings

      uniqueItems = true

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

      Show schema properties
      • anomalies array of strings

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

        uniqueItems = true

      • dataFields array of objects
        Required
        Show dataFields properties
        • name string
          Required

          minLength = 1, maxLength = 255

        • tags array of strings

          An array of system tags

          uniqueItems = true

        • alias string

          Alias of the field. Must be unique within the schema and must not match another field's name. Returns 400 if violated.

        • index integer

          format = int32

        • orphan boolean
        • dataType object
          Required
          Show dataType properties
          • type string
            Required

            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.

            Can be one of: "DATE""TIME""DATETIME""TIMESTAMP""STRING""DOUBLE""DECIMAL""INTEGER""BOOLEAN""BINARY""CUSTOM"

          • properties object

            The properties map key is string and the value is of type object. Please note, Datatype DECIMAL requires two mandatory properties to be defined; these properties must be named: precision and scale, each of these property accepts integer value. All other datatypes does not require any manadatory properties to be defined.

            Show additional optional properties
            • object object

              The properties map key is string and the value is of type object. Please note, Datatype DECIMAL requires two mandatory properties to be defined; these properties must be named: precision and scale, each of these property accepts integer value. All other datatypes does not require any manadatory properties to be defined.
          • originalType string
        • nullable boolean
        • userTags array of objects

          An array of user-supplied tags

          uniqueItems = true

          Show userTags properties
          • id string

            The id of the tag in Collections

          • name string

            minLength = 1, maxLength = 128

        • encrypted boolean
        • sensitive boolean
        • primaryKey boolean
        • properties object
          Show additional optional properties
          • object object
        • description string
        • ordinalPositionInKey integer

          format = int32

      • schemaName string
      • loadOptions object

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

        Show additional optional properties
        • object object

          Options for loading files. Example: "qLabel": "embedded labels"
      • effectiveDate string

        format = "date-time"

      • overrideSchemaAnomalies boolean
    • ownerId string

      The value is automatically set by the application.

    • spaceId string
    • version integer

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

      format = int64

    • tenantId string

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

    • createdBy string

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

    • secureQri string
      Required
    • properties object

      A Map of name-value pairs.

      Show additional optional properties
      • object object

        A Map of name-value pairs.
    • createdTime string

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

      format = "date-time"

    • description string

      minLength = 0, maxLength = 1024

    • operational object
      Show operational properties
      • size integer

        format = int64

      • status string
      • endDate string

        format = "date-time"

      • location string
      • rowCount integer

        format = int64

      • startDate string

        format = "date-time"

      • logMessage string
      • tableOwner string
      • lastLoadTime string

        format = "date-time"

      • contentUpdated boolean
      • lastUpdateTime string

        format = "date-time"

      • tableConnectionInfo object
        Show tableConnectionInfo properties
        • tableName string
        • selectionScript string
        • additionalProperties object
          Show additional optional properties
          • string string
    • dataAssetInfo object
      Required
      Show dataAssetInfo properties
      • id string
        Required
      • name string
      • dataStoreInfo object
        Show dataStoreInfo properties
        • id string
          Required
        • name string
        • type string
    • technicalName string
      Required

      minLength = 1, maxLength = 255

    • lastModifiedBy string

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

    • appTypeOverride string

      Optional override of DataAsset appType.

    • lastModifiedTime string

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

      format = "date-time"

    • additionalSchemas array of objects

      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

      Show additionalSchemas properties
      • anomalies array of strings

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

        uniqueItems = true

      • dataFields array of objects
        Required
        Show dataFields properties
        • name string
          Required

          minLength = 1, maxLength = 255

        • tags array of strings

          An array of system tags

          uniqueItems = true

        • alias string

          Alias of the field. Must be unique within the schema and must not match another field's name. Returns 400 if violated.

        • index integer

          format = int32

        • orphan boolean
        • dataType object
          Required
          Show dataType properties
          • type string
            Required

            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.

            Can be one of: "DATE""TIME""DATETIME""TIMESTAMP""STRING""DOUBLE""DECIMAL""INTEGER""BOOLEAN""BINARY""CUSTOM"

          • properties object

            The properties map key is string and the value is of type object. Please note, Datatype DECIMAL requires two mandatory properties to be defined; these properties must be named: precision and scale, each of these property accepts integer value. All other datatypes does not require any manadatory properties to be defined.

            Show additional optional properties
            • object object

              The properties map key is string and the value is of type object. Please note, Datatype DECIMAL requires two mandatory properties to be defined; these properties must be named: precision and scale, each of these property accepts integer value. All other datatypes does not require any manadatory properties to be defined.
          • originalType string
        • nullable boolean
        • userTags array of objects

          An array of user-supplied tags

          uniqueItems = true

          Show userTags properties
          • id string

            The id of the tag in Collections

          • name string

            minLength = 1, maxLength = 128

        • encrypted boolean
        • sensitive boolean
        • primaryKey boolean
        • properties object
          Show additional optional properties
          • object object
        • description string
        • ordinalPositionInKey integer

          format = int32

      • schemaName string
      • loadOptions object

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

        Show additional optional properties
        • object object

          Options for loading files. Example: "qLabel": "embedded labels"
      • effectiveDate string

        format = "date-time"

      • overrideSchemaAnomalies boolean
    • technicalDescription string

      minLength = 0, maxLength = 1024

    • createdByConnectionId string

      The connectionId that created the Dataset. Optional.

400

The request is in incorrect format.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
      • status string
    • traceId string

401

User does not have valid authentication credentials.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
      • status string
    • traceId string

403

User does not have access to the resource.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
      • status string
    • traceId string

404

Resource does not exist.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
      • status string
    • traceId string

409

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

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
      • status string
    • traceId string

500

Internal Server Error.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
      • status string
    • traceId string

503

Requested service is not available.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
      • status string
    • traceId string
GET /api/v1/data-sets/{data-set-id} 
import { createQlikApi } from '@qlik/api'


const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})


await qlik.dataSets.getDataSet('string', {})
qlik data-set get 'string'
curl "https://{tenant}.{region}.qlikcloud.com/api/v1/data-sets/{data-set-id}" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "id": "string",
  "qri": "string",
  "name": "string",
  "tags": [
    "string"
  ],
  "type": "string",
  "schema": {
    "anomalies": [
      "string"
    ],
    "dataFields": [
      {
        "name": "string",
        "tags": [
          "string"
        ],
        "alias": "string",
        "index": 42,
        "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": 42
      }
    ],
    "schemaName": "string",
    "loadOptions": {},
    "effectiveDate": "2018-10-30T07:06:22Z",
    "overrideSchemaAnomalies": true
  },
  "ownerId": "string",
  "spaceId": "string",
  "version": 42,
  "tenantId": "string",
  "createdBy": "string",
  "secureQri": "string",
  "properties": {},
  "createdTime": "2018-10-30T07:06:22Z",
  "description": "string",
  "operational": {
    "size": 42,
    "status": "string",
    "endDate": "2018-10-30T07:06:22Z",
    "location": "string",
    "rowCount": 42,
    "startDate": "2018-10-30T07:06:22Z",
    "logMessage": "string",
    "tableOwner": "string",
    "lastLoadTime": "2018-10-30T07:06:22Z",
    "contentUpdated": true,
    "lastUpdateTime": "2018-10-30T07:06:22Z",
    "tableConnectionInfo": {
      "tableName": "string",
      "selectionScript": "string",
      "additionalProperties": {}
    }
  },
  "dataAssetInfo": {
    "id": "string",
    "name": "string",
    "dataStoreInfo": {
      "id": "string",
      "name": "string",
      "type": "string"
    }
  },
  "technicalName": "string",
  "lastModifiedBy": "string",
  "appTypeOverride": "string",
  "lastModifiedTime": "2018-10-30T07:06:22Z",
  "additionalSchemas": [
    {
      "anomalies": [
        "string"
      ],
      "dataFields": [
        {
          "name": "string",
          "tags": [
            "string"
          ],
          "alias": "string",
          "index": 42,
          "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": 42
        }
      ],
      "schemaName": "string",
      "loadOptions": {},
      "effectiveDate": "2018-10-30T07:06:22Z",
      "overrideSchemaAnomalies": true
    }
  ],
  "technicalDescription": "string",
  "createdByConnectionId": "string"
}

Patch data set.

Partially updates an existing DataSet by ID using JSON Patch operations (RFC 6902), including ownership attributes.

A user can update any DataSet within a space if they fulfill one of the following conditions:

  • Has Can edit permission in a data space.
  • Is a Professional user with the Editor or Operator role in a shared space.
  • Is a Professional user with the Facilitator or Operator role in a managed space.

Facts

Rate limit Tier 2 (100 requests per minute)

Path Parameters

  • data-set-id string
    Required

Request Body

Required
  • application/json array of objects

    Array of JSON patch documents as defined by RFC 6902.

    Show application/json properties
    • op string
      Required

      The operation to be performed.

      Can be one of: "add""remove""replace""move""copy""test"

    • from string

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

    • path string
      Required

      A JSON pointer to the property being affected.

    • value object

      The value to add, replace or test.

Responses

200

Patched data set successfully.

  • application/json object
    Show application/json properties
    • id string

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

    • qri string
      Required

      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.

      minLength = 8, maxLength = 1024, format = "qdf:<store-type>:<tenant-guid>:<<uid@/sid@>user/space guid>:<path-to-file>"

    • name string

      minLength = 0, maxLength = 255

    • tags array of strings

      uniqueItems = true

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

      Show schema properties
      • anomalies array of strings

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

        uniqueItems = true

      • dataFields array of objects
        Required
        Show dataFields properties
        • name string
          Required

          minLength = 1, maxLength = 255

        • tags array of strings

          An array of system tags

          uniqueItems = true

        • alias string

          Alias of the field. Must be unique within the schema and must not match another field's name. Returns 400 if violated.

        • index integer

          format = int32

        • orphan boolean
        • dataType object
          Required
          Show dataType properties
          • type string
            Required

            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.

            Can be one of: "DATE""TIME""DATETIME""TIMESTAMP""STRING""DOUBLE""DECIMAL""INTEGER""BOOLEAN""BINARY""CUSTOM"

          • properties object

            The properties map key is string and the value is of type object. Please note, Datatype DECIMAL requires two mandatory properties to be defined; these properties must be named: precision and scale, each of these property accepts integer value. All other datatypes does not require any manadatory properties to be defined.

            Show additional optional properties
            • object object

              The properties map key is string and the value is of type object. Please note, Datatype DECIMAL requires two mandatory properties to be defined; these properties must be named: precision and scale, each of these property accepts integer value. All other datatypes does not require any manadatory properties to be defined.
          • originalType string
        • nullable boolean
        • userTags array of objects

          An array of user-supplied tags

          uniqueItems = true

          Show userTags properties
          • id string

            The id of the tag in Collections

          • name string

            minLength = 1, maxLength = 128

        • encrypted boolean
        • sensitive boolean
        • primaryKey boolean
        • properties object
          Show additional optional properties
          • object object
        • description string
        • ordinalPositionInKey integer

          format = int32

      • schemaName string
      • loadOptions object

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

        Show additional optional properties
        • object object

          Options for loading files. Example: "qLabel": "embedded labels"
      • effectiveDate string

        format = "date-time"

      • overrideSchemaAnomalies boolean
    • ownerId string

      The value is automatically set by the application.

    • spaceId string
    • version integer

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

      format = int64

    • tenantId string

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

    • createdBy string

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

    • secureQri string
      Required
    • properties object

      A Map of name-value pairs.

      Show additional optional properties
      • object object

        A Map of name-value pairs.
    • createdTime string

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

      format = "date-time"

    • description string

      minLength = 0, maxLength = 1024

    • operational object
      Show operational properties
      • size integer

        format = int64

      • status string
      • endDate string

        format = "date-time"

      • location string
      • rowCount integer

        format = int64

      • startDate string

        format = "date-time"

      • logMessage string
      • tableOwner string
      • lastLoadTime string

        format = "date-time"

      • contentUpdated boolean
      • lastUpdateTime string

        format = "date-time"

      • tableConnectionInfo object
        Show tableConnectionInfo properties
        • tableName string
        • selectionScript string
        • additionalProperties object
          Show additional optional properties
          • string string
    • dataAssetInfo object
      Required
      Show dataAssetInfo properties
      • id string
        Required
      • name string
      • dataStoreInfo object
        Show dataStoreInfo properties
        • id string
          Required
        • name string
        • type string
    • technicalName string
      Required

      minLength = 1, maxLength = 255

    • lastModifiedBy string

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

    • appTypeOverride string

      Optional override of DataAsset appType.

    • lastModifiedTime string

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

      format = "date-time"

    • additionalSchemas array of objects

      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

      Show additionalSchemas properties
      • anomalies array of strings

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

        uniqueItems = true

      • dataFields array of objects
        Required
        Show dataFields properties
        • name string
          Required

          minLength = 1, maxLength = 255

        • tags array of strings

          An array of system tags

          uniqueItems = true

        • alias string

          Alias of the field. Must be unique within the schema and must not match another field's name. Returns 400 if violated.

        • index integer

          format = int32

        • orphan boolean
        • dataType object
          Required
          Show dataType properties
          • type string
            Required

            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.

            Can be one of: "DATE""TIME""DATETIME""TIMESTAMP""STRING""DOUBLE""DECIMAL""INTEGER""BOOLEAN""BINARY""CUSTOM"

          • properties object

            The properties map key is string and the value is of type object. Please note, Datatype DECIMAL requires two mandatory properties to be defined; these properties must be named: precision and scale, each of these property accepts integer value. All other datatypes does not require any manadatory properties to be defined.

            Show additional optional properties
            • object object

              The properties map key is string and the value is of type object. Please note, Datatype DECIMAL requires two mandatory properties to be defined; these properties must be named: precision and scale, each of these property accepts integer value. All other datatypes does not require any manadatory properties to be defined.
          • originalType string
        • nullable boolean
        • userTags array of objects

          An array of user-supplied tags

          uniqueItems = true

          Show userTags properties
          • id string

            The id of the tag in Collections

          • name string

            minLength = 1, maxLength = 128

        • encrypted boolean
        • sensitive boolean
        • primaryKey boolean
        • properties object
          Show additional optional properties
          • object object
        • description string
        • ordinalPositionInKey integer

          format = int32

      • schemaName string
      • loadOptions object

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

        Show additional optional properties
        • object object

          Options for loading files. Example: "qLabel": "embedded labels"
      • effectiveDate string

        format = "date-time"

      • overrideSchemaAnomalies boolean
    • technicalDescription string

      minLength = 0, maxLength = 1024

    • createdByConnectionId string

      The connectionId that created the Dataset. Optional.

204

Patched data set successfully.

  • application/json object
    Show application/json properties
    • id string

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

    • qri string
      Required

      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.

      minLength = 8, maxLength = 1024, format = "qdf:<store-type>:<tenant-guid>:<<uid@/sid@>user/space guid>:<path-to-file>"

    • name string

      minLength = 0, maxLength = 255

    • tags array of strings

      uniqueItems = true

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

      Show schema properties
      • anomalies array of strings

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

        uniqueItems = true

      • dataFields array of objects
        Required
        Show dataFields properties
        • name string
          Required

          minLength = 1, maxLength = 255

        • tags array of strings

          An array of system tags

          uniqueItems = true

        • alias string

          Alias of the field. Must be unique within the schema and must not match another field's name. Returns 400 if violated.

        • index integer

          format = int32

        • orphan boolean
        • dataType object
          Required
          Show dataType properties
          • type string
            Required

            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.

            Can be one of: "DATE""TIME""DATETIME""TIMESTAMP""STRING""DOUBLE""DECIMAL""INTEGER""BOOLEAN""BINARY""CUSTOM"

          • properties object

            The properties map key is string and the value is of type object. Please note, Datatype DECIMAL requires two mandatory properties to be defined; these properties must be named: precision and scale, each of these property accepts integer value. All other datatypes does not require any manadatory properties to be defined.

            Show additional optional properties
            • object object

              The properties map key is string and the value is of type object. Please note, Datatype DECIMAL requires two mandatory properties to be defined; these properties must be named: precision and scale, each of these property accepts integer value. All other datatypes does not require any manadatory properties to be defined.
          • originalType string
        • nullable boolean
        • userTags array of objects

          An array of user-supplied tags

          uniqueItems = true

          Show userTags properties
          • id string

            The id of the tag in Collections

          • name string

            minLength = 1, maxLength = 128

        • encrypted boolean
        • sensitive boolean
        • primaryKey boolean
        • properties object
          Show additional optional properties
          • object object
        • description string
        • ordinalPositionInKey integer

          format = int32

      • schemaName string
      • loadOptions object

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

        Show additional optional properties
        • object object

          Options for loading files. Example: "qLabel": "embedded labels"
      • effectiveDate string

        format = "date-time"

      • overrideSchemaAnomalies boolean
    • ownerId string

      The value is automatically set by the application.

    • spaceId string
    • version integer

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

      format = int64

    • tenantId string

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

    • createdBy string

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

    • secureQri string
      Required
    • properties object

      A Map of name-value pairs.

      Show additional optional properties
      • object object

        A Map of name-value pairs.
    • createdTime string

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

      format = "date-time"

    • description string

      minLength = 0, maxLength = 1024

    • operational object
      Show operational properties
      • size integer

        format = int64

      • status string
      • endDate string

        format = "date-time"

      • location string
      • rowCount integer

        format = int64

      • startDate string

        format = "date-time"

      • logMessage string
      • tableOwner string
      • lastLoadTime string

        format = "date-time"

      • contentUpdated boolean
      • lastUpdateTime string

        format = "date-time"

      • tableConnectionInfo object
        Show tableConnectionInfo properties
        • tableName string
        • selectionScript string
        • additionalProperties object
          Show additional optional properties
          • string string
    • dataAssetInfo object
      Required
      Show dataAssetInfo properties
      • id string
        Required
      • name string
      • dataStoreInfo object
        Show dataStoreInfo properties
        • id string
          Required
        • name string
        • type string
    • technicalName string
      Required

      minLength = 1, maxLength = 255

    • lastModifiedBy string

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

    • appTypeOverride string

      Optional override of DataAsset appType.

    • lastModifiedTime string

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

      format = "date-time"

    • additionalSchemas array of objects

      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

      Show additionalSchemas properties
      • anomalies array of strings

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

        uniqueItems = true

      • dataFields array of objects
        Required
        Show dataFields properties
        • name string
          Required

          minLength = 1, maxLength = 255

        • tags array of strings

          An array of system tags

          uniqueItems = true

        • alias string

          Alias of the field. Must be unique within the schema and must not match another field's name. Returns 400 if violated.

        • index integer

          format = int32

        • orphan boolean
        • dataType object
          Required
          Show dataType properties
          • type string
            Required

            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.

            Can be one of: "DATE""TIME""DATETIME""TIMESTAMP""STRING""DOUBLE""DECIMAL""INTEGER""BOOLEAN""BINARY""CUSTOM"

          • properties object

            The properties map key is string and the value is of type object. Please note, Datatype DECIMAL requires two mandatory properties to be defined; these properties must be named: precision and scale, each of these property accepts integer value. All other datatypes does not require any manadatory properties to be defined.

            Show additional optional properties
            • object object

              The properties map key is string and the value is of type object. Please note, Datatype DECIMAL requires two mandatory properties to be defined; these properties must be named: precision and scale, each of these property accepts integer value. All other datatypes does not require any manadatory properties to be defined.
          • originalType string
        • nullable boolean
        • userTags array of objects

          An array of user-supplied tags

          uniqueItems = true

          Show userTags properties
          • id string

            The id of the tag in Collections

          • name string

            minLength = 1, maxLength = 128

        • encrypted boolean
        • sensitive boolean
        • primaryKey boolean
        • properties object
          Show additional optional properties
          • object object
        • description string
        • ordinalPositionInKey integer

          format = int32

      • schemaName string
      • loadOptions object

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

        Show additional optional properties
        • object object

          Options for loading files. Example: "qLabel": "embedded labels"
      • effectiveDate string

        format = "date-time"

      • overrideSchemaAnomalies boolean
    • technicalDescription string

      minLength = 0, maxLength = 1024

    • createdByConnectionId string

      The connectionId that created the Dataset. Optional.

400

The request is in incorrect format. Also returned when field aliases are not unique within a schema or conflict with another field's name.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
      • status string
    • traceId string

401

User does not have valid authentication credentials.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
      • status string
    • traceId string

403

User does not have access to the resource.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
      • status string
    • traceId string

404

Resource does not exist.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
      • status string
    • traceId string

409

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

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
      • status string
    • traceId string

500

Internal Server Error.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
      • status string
    • traceId string

503

Requested service is not available.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
      • status string
    • traceId string
PATCH /api/v1/data-sets/{data-set-id} 
import { createQlikApi } from '@qlik/api'


const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})


await qlik.dataSets.patchDataSet('string', [
  {
    from: 'string',
    op: 'add',
    path: 'string',
    value: {},
  },
])
qlik data-set patch 'string' \
  --op 'add' \
  --path 'string'
curl "https://{tenant}.{region}.qlikcloud.com/api/v1/data-sets/{data-set-id}" \
-X PATCH \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '[{"op":"add","from":"string","path":"string","value":{}}]'

Example Response

{
  "id": "string",
  "qri": "string",
  "name": "string",
  "tags": [
    "string"
  ],
  "type": "string",
  "schema": {
    "anomalies": [
      "string"
    ],
    "dataFields": [
      {
        "name": "string",
        "tags": [
          "string"
        ],
        "alias": "string",
        "index": 42,
        "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": 42
      }
    ],
    "schemaName": "string",
    "loadOptions": {},
    "effectiveDate": "2018-10-30T07:06:22Z",
    "overrideSchemaAnomalies": true
  },
  "ownerId": "string",
  "spaceId": "string",
  "version": 42,
  "tenantId": "string",
  "createdBy": "string",
  "secureQri": "string",
  "properties": {},
  "createdTime": "2018-10-30T07:06:22Z",
  "description": "string",
  "operational": {
    "size": 42,
    "status": "string",
    "endDate": "2018-10-30T07:06:22Z",
    "location": "string",
    "rowCount": 42,
    "startDate": "2018-10-30T07:06:22Z",
    "logMessage": "string",
    "tableOwner": "string",
    "lastLoadTime": "2018-10-30T07:06:22Z",
    "contentUpdated": true,
    "lastUpdateTime": "2018-10-30T07:06:22Z",
    "tableConnectionInfo": {
      "tableName": "string",
      "selectionScript": "string",
      "additionalProperties": {}
    }
  },
  "dataAssetInfo": {
    "id": "string",
    "name": "string",
    "dataStoreInfo": {
      "id": "string",
      "name": "string",
      "type": "string"
    }
  },
  "technicalName": "string",
  "lastModifiedBy": "string",
  "appTypeOverride": "string",
  "lastModifiedTime": "2018-10-30T07:06:22Z",
  "additionalSchemas": [
    {
      "anomalies": [
        "string"
      ],
      "dataFields": [
        {
          "name": "string",
          "tags": [
            "string"
          ],
          "alias": "string",
          "index": 42,
          "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": 42
        }
      ],
      "schemaName": "string",
      "loadOptions": {},
      "effectiveDate": "2018-10-30T07:06:22Z",
      "overrideSchemaAnomalies": true
    }
  ],
  "technicalDescription": "string",
  "createdByConnectionId": "string"
}

Update data set.

Fully replaces an existing DataSet by ID, including ownership attributes.

A user can update any DataSet within a space if they fulfill one of the following conditions:

  • Has Can edit permission in a data space.
  • Is a Professional user with the Editor or Operator role in a shared space.
  • Is a Professional user with the Facilitator or Operator role in a managed space.

Facts

Rate limit Tier 2 (100 requests per minute)

Path Parameters

  • data-set-id string
    Required

Request Body

Required
  • application/json object
    Show application/json properties
    • id string

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

    • qri string
      Required

      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.

      minLength = 8, maxLength = 1024, format = "qdf:<store-type>:<tenant-guid>:<<uid@/sid@>user/space guid>:<path-to-file>"

    • name string

      minLength = 0, maxLength = 255

    • tags array of strings

      uniqueItems = true

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

      Show schema properties
      • anomalies array of strings

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

        uniqueItems = true

      • dataFields array of objects
        Required
        Show dataFields properties
        • name string
          Required

          minLength = 1, maxLength = 255

        • tags array of strings

          An array of system tags

          uniqueItems = true

        • alias string

          Alias of the field. Must be unique within the schema and must not match another field's name. Returns 400 if violated.

        • index integer

          format = int32

        • orphan boolean
        • dataType object
          Required
          Show dataType properties
          • type string
            Required

            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.

            Can be one of: "DATE""TIME""DATETIME""TIMESTAMP""STRING""DOUBLE""DECIMAL""INTEGER""BOOLEAN""BINARY""CUSTOM"

          • properties object

            The properties map key is string and the value is of type object. Please note, Datatype DECIMAL requires two mandatory properties to be defined; these properties must be named: precision and scale, each of these property accepts integer value. All other datatypes does not require any manadatory properties to be defined.

            Show additional optional properties
            • object object

              The properties map key is string and the value is of type object. Please note, Datatype DECIMAL requires two mandatory properties to be defined; these properties must be named: precision and scale, each of these property accepts integer value. All other datatypes does not require any manadatory properties to be defined.
          • originalType string
        • nullable boolean
        • userTags array of objects

          An array of user-supplied tags

          uniqueItems = true

          Show userTags properties
          • id string

            The id of the tag in Collections

          • name string

            minLength = 1, maxLength = 128

        • encrypted boolean
        • sensitive boolean
        • primaryKey boolean
        • properties object
          Show additional optional properties
          • object object
        • description string
        • ordinalPositionInKey integer

          format = int32

      • schemaName string
      • loadOptions object

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

        Show additional optional properties
        • object object

          Options for loading files. Example: "qLabel": "embedded labels"
      • overrideSchemaAnomalies boolean
    • ownerId string

      The value is automatically set by the application.

    • spaceId string
    • version integer

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

      format = int64

    • secureQri string
      Required
    • properties object

      A Map of name-value pairs.

      Show additional optional properties
      • object object

        A Map of name-value pairs.
    • description string

      minLength = 0, maxLength = 1024

    • operational object
      Show operational properties
      • size integer

        format = int64

      • status string
      • endDate string

        format = "date-time"

      • location string
      • rowCount integer

        format = int64

      • startDate string

        format = "date-time"

      • logMessage string
      • tableOwner string
      • lastLoadTime string

        format = "date-time"

      • contentUpdated boolean
      • lastUpdateTime string

        format = "date-time"

      • tableConnectionInfo object
        Show tableConnectionInfo properties
        • tableName string
        • selectionScript string
        • additionalProperties object
          Show additional optional properties
          • string string
    • dataAssetInfo object
      Required
      Show dataAssetInfo properties
      • id string
        Required
      • dataStoreInfo object
        Show dataStoreInfo properties
        • id string
          Required
    • technicalName string
      Required

      minLength = 1, maxLength = 255

    • appTypeOverride string

      Optional override of DataAsset appType.

    • additionalSchemas array of objects

      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

      Show additionalSchemas properties
      • anomalies array of strings

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

        uniqueItems = true

      • dataFields array of objects
        Required
        Show dataFields properties
        • name string
          Required

          minLength = 1, maxLength = 255

        • tags array of strings

          An array of system tags

          uniqueItems = true

        • alias string

          Alias of the field. Must be unique within the schema and must not match another field's name. Returns 400 if violated.

        • index integer

          format = int32

        • orphan boolean
        • dataType object
          Required
          Show dataType properties
          • type string
            Required

            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.

            Can be one of: "DATE""TIME""DATETIME""TIMESTAMP""STRING""DOUBLE""DECIMAL""INTEGER""BOOLEAN""BINARY""CUSTOM"

          • properties object

            The properties map key is string and the value is of type object. Please note, Datatype DECIMAL requires two mandatory properties to be defined; these properties must be named: precision and scale, each of these property accepts integer value. All other datatypes does not require any manadatory properties to be defined.

            Show additional optional properties
            • object object

              The properties map key is string and the value is of type object. Please note, Datatype DECIMAL requires two mandatory properties to be defined; these properties must be named: precision and scale, each of these property accepts integer value. All other datatypes does not require any manadatory properties to be defined.
          • originalType string
        • nullable boolean
        • userTags array of objects

          An array of user-supplied tags

          uniqueItems = true

          Show userTags properties
          • id string

            The id of the tag in Collections

          • name string

            minLength = 1, maxLength = 128

        • encrypted boolean
        • sensitive boolean
        • primaryKey boolean
        • properties object
          Show additional optional properties
          • object object
        • description string
        • ordinalPositionInKey integer

          format = int32

      • schemaName string
      • loadOptions object

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

        Show additional optional properties
        • object object

          Options for loading files. Example: "qLabel": "embedded labels"
      • effectiveDate string

        format = "date-time"

      • overrideSchemaAnomalies boolean
    • technicalDescription string

      minLength = 0, maxLength = 1024

    • createdByConnectionId string

      The connectionId that created the Dataset. Optional.

Responses

200

Updated data set successfully.

  • application/json object
    Show application/json properties
    • id string

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

    • qri string
      Required

      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.

      minLength = 8, maxLength = 1024, format = "qdf:<store-type>:<tenant-guid>:<<uid@/sid@>user/space guid>:<path-to-file>"

    • name string

      minLength = 0, maxLength = 255

    • tags array of strings

      uniqueItems = true

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

      Show schema properties
      • anomalies array of strings

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

        uniqueItems = true

      • dataFields array of objects
        Required
        Show dataFields properties
        • name string
          Required

          minLength = 1, maxLength = 255

        • tags array of strings

          An array of system tags

          uniqueItems = true

        • alias string

          Alias of the field. Must be unique within the schema and must not match another field's name. Returns 400 if violated.

        • index integer

          format = int32

        • orphan boolean
        • dataType object
          Required
          Show dataType properties
          • type string
            Required

            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.

            Can be one of: "DATE""TIME""DATETIME""TIMESTAMP""STRING""DOUBLE""DECIMAL""INTEGER""BOOLEAN""BINARY""CUSTOM"

          • properties object

            The properties map key is string and the value is of type object. Please note, Datatype DECIMAL requires two mandatory properties to be defined; these properties must be named: precision and scale, each of these property accepts integer value. All other datatypes does not require any manadatory properties to be defined.

            Show additional optional properties
            • object object

              The properties map key is string and the value is of type object. Please note, Datatype DECIMAL requires two mandatory properties to be defined; these properties must be named: precision and scale, each of these property accepts integer value. All other datatypes does not require any manadatory properties to be defined.
          • originalType string
        • nullable boolean
        • userTags array of objects

          An array of user-supplied tags

          uniqueItems = true

          Show userTags properties
          • id string

            The id of the tag in Collections

          • name string

            minLength = 1, maxLength = 128

        • encrypted boolean
        • sensitive boolean
        • primaryKey boolean
        • properties object
          Show additional optional properties
          • object object
        • description string
        • ordinalPositionInKey integer

          format = int32

      • schemaName string
      • loadOptions object

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

        Show additional optional properties
        • object object

          Options for loading files. Example: "qLabel": "embedded labels"
      • effectiveDate string

        format = "date-time"

      • overrideSchemaAnomalies boolean
    • ownerId string

      The value is automatically set by the application.

    • spaceId string
    • version integer

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

      format = int64

    • tenantId string

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

    • createdBy string

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

    • secureQri string
      Required
    • properties object

      A Map of name-value pairs.

      Show additional optional properties
      • object object

        A Map of name-value pairs.
    • createdTime string

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

      format = "date-time"

    • description string

      minLength = 0, maxLength = 1024

    • operational object
      Show operational properties
      • size integer

        format = int64

      • status string
      • endDate string

        format = "date-time"

      • location string
      • rowCount integer

        format = int64

      • startDate string

        format = "date-time"

      • logMessage string
      • tableOwner string
      • lastLoadTime string

        format = "date-time"

      • contentUpdated boolean
      • lastUpdateTime string

        format = "date-time"

      • tableConnectionInfo object
        Show tableConnectionInfo properties
        • tableName string
        • selectionScript string
        • additionalProperties object
          Show additional optional properties
          • string string
    • dataAssetInfo object
      Required
      Show dataAssetInfo properties
      • id string
        Required
      • name string
      • dataStoreInfo object
        Show dataStoreInfo properties
        • id string
          Required
        • name string
        • type string
    • technicalName string
      Required

      minLength = 1, maxLength = 255

    • lastModifiedBy string

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

    • appTypeOverride string

      Optional override of DataAsset appType.

    • lastModifiedTime string

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

      format = "date-time"

    • additionalSchemas array of objects

      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

      Show additionalSchemas properties
      • anomalies array of strings

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

        uniqueItems = true

      • dataFields array of objects
        Required
        Show dataFields properties
        • name string
          Required

          minLength = 1, maxLength = 255

        • tags array of strings

          An array of system tags

          uniqueItems = true

        • alias string

          Alias of the field. Must be unique within the schema and must not match another field's name. Returns 400 if violated.

        • index integer

          format = int32

        • orphan boolean
        • dataType object
          Required
          Show dataType properties
          • type string
            Required

            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.

            Can be one of: "DATE""TIME""DATETIME""TIMESTAMP""STRING""DOUBLE""DECIMAL""INTEGER""BOOLEAN""BINARY""CUSTOM"

          • properties object

            The properties map key is string and the value is of type object. Please note, Datatype DECIMAL requires two mandatory properties to be defined; these properties must be named: precision and scale, each of these property accepts integer value. All other datatypes does not require any manadatory properties to be defined.

            Show additional optional properties
            • object object

              The properties map key is string and the value is of type object. Please note, Datatype DECIMAL requires two mandatory properties to be defined; these properties must be named: precision and scale, each of these property accepts integer value. All other datatypes does not require any manadatory properties to be defined.
          • originalType string
        • nullable boolean
        • userTags array of objects

          An array of user-supplied tags

          uniqueItems = true

          Show userTags properties
          • id string

            The id of the tag in Collections

          • name string

            minLength = 1, maxLength = 128

        • encrypted boolean
        • sensitive boolean
        • primaryKey boolean
        • properties object
          Show additional optional properties
          • object object
        • description string
        • ordinalPositionInKey integer

          format = int32

      • schemaName string
      • loadOptions object

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

        Show additional optional properties
        • object object

          Options for loading files. Example: "qLabel": "embedded labels"
      • effectiveDate string

        format = "date-time"

      • overrideSchemaAnomalies boolean
    • technicalDescription string

      minLength = 0, maxLength = 1024

    • createdByConnectionId string

      The connectionId that created the Dataset. Optional.

400

The request is in incorrect format. Also returned when field aliases are not unique within a schema or conflict with another field's name.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
      • status string
    • traceId string

401

User does not have valid authentication credentials.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
      • status string
    • traceId string

403

User does not have access to the resource.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
      • status string
    • traceId string

404

Resource does not exist.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
      • status string
    • traceId string

409

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

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
      • status string
    • traceId string

500

Internal Server Error.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
      • status string
    • traceId string

503

Requested service is not available.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
      • status string
    • traceId string
PUT /api/v1/data-sets/{data-set-id} 
import { createQlikApi } from '@qlik/api'


const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})


await qlik.dataSets.updateDataSet('string', {
  additionalSchemas: [
    {
      anomalies: ['string'],
      dataFields: [
        {
          alias: 'string',
          dataType: {
            originalType: 'string',
            properties: {},
            type: 'DATE',
          },
          description: 'string',
          encrypted: true,
          name: 'string',
          nullable: true,
          ordinalPositionInKey: 42,
          orphan: true,
          primaryKey: true,
          properties: {},
          sensitive: true,
          tags: ['string'],
          userTags: [
            { id: 'string', name: 'string' },
          ],
        },
      ],
      loadOptions: {},
      overrideSchemaAnomalies: true,
      schemaName: 'string',
    },
  ],
  appTypeOverride: 'string',
  createdByConnectionId: 'string',
  dataAssetInfo: {
    dataStoreInfo: { id: 'string' },
    id: 'string',
  },
  description: 'string',
  id: 'string',
  name: 'string',
  operational: {
    contentUpdated: true,
    endDate: '2018-10-30T07:06:22Z',
    lastLoadTime: '2018-10-30T07:06:22Z',
    lastUpdateTime: '2018-10-30T07:06:22Z',
    location: 'string',
    logMessage: 'string',
    rowCount: 42,
    size: 42,
    startDate: '2018-10-30T07:06:22Z',
    status: 'string',
    tableConnectionInfo: {
      additionalProperties: {},
      selectionScript: 'string',
      tableName: 'string',
    },
    tableOwner: 'string',
  },
  ownerId: 'string',
  properties: {},
  qri: 'string',
  schema: {
    anomalies: ['string'],
    dataFields: [
      {
        alias: 'string',
        dataType: {
          originalType: 'string',
          properties: {},
          type: 'DATE',
        },
        description: 'string',
        encrypted: true,
        name: 'string',
        nullable: true,
        ordinalPositionInKey: 42,
        orphan: true,
        primaryKey: true,
        properties: {},
        sensitive: true,
        tags: ['string'],
        userTags: [
          { id: 'string', name: 'string' },
        ],
      },
    ],
    loadOptions: {},
    overrideSchemaAnomalies: true,
    schemaName: 'string',
  },
  secureQri: 'string',
  spaceId: 'string',
  tags: ['string'],
  technicalDescription: 'string',
  technicalName: 'string',
  type: 'string',
  version: 42,
})
qlik data-set update 'string' \
  --additionalSchemas-dataFields-alias '' \
  --additionalSchemas-dataFields-dataType-originalType '' \
  --additionalSchemas-dataFields-dataType-type '' \
  --additionalSchemas-dataFields-description '' \
  --additionalSchemas-dataFields-encrypted  \
  --additionalSchemas-dataFields-name '' \
  --additionalSchemas-dataFields-nullable  \
  --additionalSchemas-dataFields-ordinalPositionInKey  \
  --additionalSchemas-dataFields-orphan  \
  --additionalSchemas-dataFields-primaryKey  \
  --additionalSchemas-dataFields-sensitive  \
  --additionalSchemas-dataFields-tags '' \
  --additionalSchemas-dataFields-userTags-id '' \
  --additionalSchemas-dataFields-userTags-name '' \
  --dataAssetInfo-dataStoreInfo-id 'string' \
  --dataAssetInfo-id 'string' \
  --qri 'string' \
  --schema-dataFields-alias '' \
  --schema-dataFields-dataType-originalType '' \
  --schema-dataFields-dataType-type '' \
  --schema-dataFields-description '' \
  --schema-dataFields-encrypted  \
  --schema-dataFields-name '' \
  --schema-dataFields-nullable  \
  --schema-dataFields-ordinalPositionInKey  \
  --schema-dataFields-orphan  \
  --schema-dataFields-primaryKey  \
  --schema-dataFields-sensitive  \
  --schema-dataFields-tags '' \
  --schema-dataFields-userTags-id '' \
  --schema-dataFields-userTags-name '' \
  --secureQri 'string' \
  --technicalName 'string'
curl "https://{tenant}.{region}.qlikcloud.com/api/v1/data-sets/{data-set-id}" \
-X PUT \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{"id":"string","qri":"string","name":"string","tags":["string"],"type":"string","schema":{"anomalies":["string"],"dataFields":[{"name":"string","tags":["string"],"alias":"string","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":42}],"schemaName":"string","loadOptions":{},"overrideSchemaAnomalies":true},"ownerId":"string","spaceId":"string","version":42,"secureQri":"string","properties":{},"description":"string","operational":{"size":42,"status":"string","endDate":"2018-10-30T07:06:22Z","location":"string","rowCount":42,"startDate":"2018-10-30T07:06:22Z","logMessage":"string","tableOwner":"string","lastLoadTime":"2018-10-30T07:06:22Z","contentUpdated":true,"lastUpdateTime":"2018-10-30T07:06:22Z","tableConnectionInfo":{"tableName":"string","selectionScript":"string","additionalProperties":{}}},"dataAssetInfo":{"id":"string","dataStoreInfo":{"id":"string"}},"technicalName":"string","appTypeOverride":"string","additionalSchemas":[{"anomalies":["string"],"dataFields":[{"name":"string","tags":["string"],"alias":"string","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":42}],"schemaName":"string","loadOptions":{},"overrideSchemaAnomalies":true}],"technicalDescription":"string","createdByConnectionId":"string"}'

Example Response

{
  "id": "string",
  "qri": "string",
  "name": "string",
  "tags": [
    "string"
  ],
  "type": "string",
  "schema": {
    "anomalies": [
      "string"
    ],
    "dataFields": [
      {
        "name": "string",
        "tags": [
          "string"
        ],
        "alias": "string",
        "index": 42,
        "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": 42
      }
    ],
    "schemaName": "string",
    "loadOptions": {},
    "effectiveDate": "2018-10-30T07:06:22Z",
    "overrideSchemaAnomalies": true
  },
  "ownerId": "string",
  "spaceId": "string",
  "version": 42,
  "tenantId": "string",
  "createdBy": "string",
  "secureQri": "string",
  "properties": {},
  "createdTime": "2018-10-30T07:06:22Z",
  "description": "string",
  "operational": {
    "size": 42,
    "status": "string",
    "endDate": "2018-10-30T07:06:22Z",
    "location": "string",
    "rowCount": 42,
    "startDate": "2018-10-30T07:06:22Z",
    "logMessage": "string",
    "tableOwner": "string",
    "lastLoadTime": "2018-10-30T07:06:22Z",
    "contentUpdated": true,
    "lastUpdateTime": "2018-10-30T07:06:22Z",
    "tableConnectionInfo": {
      "tableName": "string",
      "selectionScript": "string",
      "additionalProperties": {}
    }
  },
  "dataAssetInfo": {
    "id": "string",
    "name": "string",
    "dataStoreInfo": {
      "id": "string",
      "name": "string",
      "type": "string"
    }
  },
  "technicalName": "string",
  "lastModifiedBy": "string",
  "appTypeOverride": "string",
  "lastModifiedTime": "2018-10-30T07:06:22Z",
  "additionalSchemas": [
    {
      "anomalies": [
        "string"
      ],
      "dataFields": [
        {
          "name": "string",
          "tags": [
            "string"
          ],
          "alias": "string",
          "index": 42,
          "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": 42
        }
      ],
      "schemaName": "string",
      "loadOptions": {},
      "effectiveDate": "2018-10-30T07:06:22Z",
      "overrideSchemaAnomalies": true
    }
  ],
  "technicalDescription": "string",
  "createdByConnectionId": "string"
}

Get profile for the given dataset and connection Id pair, if the profile already exists in the system. Profile returned can be either latest or Stale one based on when it was computed.

Facts

Rate limit Tier 1 (1000 requests per minute)

Query Parameters

  • dataConnectionIds array of strings

    Comma-separated data connection IDs.

  • limit integer

    Page size limit.

    maximum = 100, default = 20, format = int32, default = 20

  • page integer

    default = 0, format = int32, default = 0

  • projections array of strings

    Comma-separated fields to return in the response.

  • sort array of strings

Path Parameters

  • data-set-id string
    Required

Responses

200

Return profiles of data set.

  • application/json object
    Show application/json properties
    • data array of objects
      Show data properties
      • meta object
        Show meta properties
        • status string

          Can be one of: "QUEUED""RUNNING""FINISHED""FAILED""INCOMPLETE""CANCELLED""STALE""PARTIAL""DEFERRED"

        • messages array of strings
        • dataSetId string
        • resultType string

          Can be one of: "NORMAL""BASIC"

        • connectionId string
        • lastLoadTime string

          format = "date-time"

        • computationEndTime string

          format = "date-time"

        • computationStartTime string

          format = "date-time"

      • samples array of objects
        Show samples properties
        • name string
        • records array of objects
          Show records properties
          • values array of strings
        • fieldNames array of strings
      • profiles array of objects
        Show profiles properties
        • name string
        • sizeInBytes integer

          format = int64

        • numberOfRows integer

          format = int64

        • fieldProfiles array of objects
          Show fieldProfiles properties
          • name string
          • tags array of strings
          • index integer

            format = int32

          • median number

            format = double

          • average number

            format = double

          • dataType string

            Can be one of: "DATE""TIME""DATETIME""TIMESTAMP""STRING""DOUBLE""DECIMAL""INTEGER""BOOLEAN""BINARY""CUSTOM"

          • evenness number

            format = double

          • kurtosis number

            format = double

          • skewness number

            format = double

          • fractiles array of numbers
          • sampleValues array of strings
          • technicalName string
          • classification object
            Show classification properties
            • pii boolean
            • tags array of objects
              Show tags properties
              • tag string
              • score number

                format = double

            • sensitive boolean
            • obfuscation string
          • nullValueCount integer

            format = int64

          • textValueCount integer

            format = int64

          • zeroValueCount integer

            format = int64

          • maxNumericValue number

            format = double

          • maxStringLength integer

            format = int64

          • minNumericValue number

            format = double

          • minStringLength integer

            format = int64

          • sumStringLength integer

            format = int64

          • emptyStringCount integer

            format = int64

          • sumNumericValues number

            format = double

          • numericValueCount integer

            format = int64

          • standardDeviation number

            format = double

          • distinctValueCount integer

            format = int64

          • mostFrequentValues array of objects
            Show mostFrequentValues properties
            • value string
            • frequency integer

              format = int64

          • negativeValueCount integer

            format = int64

          • positiveValueCount integer

            format = int64

          • averageStringLength number

            format = double

          • frequencyDistribution array of objects
            Show frequencyDistribution properties
            • binEdge number

              format = double

            • frequency integer

              format = int64

          • lastSortedStringValue string
          • firstSortedStringValue string
          • sumSquaredNumericValues number

            format = double

    • page integer

      format = int32

    • limit integer

      format = int32

    • links object
      Show links properties
      • last object
        Show last properties
        • href string
      • next object
        Show next properties
        • href string
      • prev object
        Show prev properties
        • href string
      • self object
        Show self properties
        • href string
      • first object
        Show first properties
        • href string
    • pages integer

      format = int32

    • total integer

      format = int64

202

The profile is currently running.

  • application/json object
    Show application/json properties
    • data array of objects
      Show data properties
      • meta object
        Show meta properties
        • status string

          Can be one of: "QUEUED""RUNNING""FINISHED""FAILED""INCOMPLETE""CANCELLED""STALE""PARTIAL""DEFERRED"

        • messages array of strings
        • dataSetId string
        • resultType string

          Can be one of: "NORMAL""BASIC"

        • connectionId string
        • lastLoadTime string

          format = "date-time"

        • computationEndTime string

          format = "date-time"

        • computationStartTime string

          format = "date-time"

      • samples array of objects
        Show samples properties
        • name string
        • records array of objects
          Show records properties
          • values array of strings
        • fieldNames array of strings
      • profiles array of objects
        Show profiles properties
        • name string
        • sizeInBytes integer

          format = int64

        • numberOfRows integer

          format = int64

        • fieldProfiles array of objects
          Show fieldProfiles properties
          • name string
          • tags array of strings
          • index integer

            format = int32

          • median number

            format = double

          • average number

            format = double

          • dataType string

            Can be one of: "DATE""TIME""DATETIME""TIMESTAMP""STRING""DOUBLE""DECIMAL""INTEGER""BOOLEAN""BINARY""CUSTOM"

          • evenness number

            format = double

          • kurtosis number

            format = double

          • skewness number

            format = double

          • fractiles array of numbers
          • sampleValues array of strings
          • technicalName string
          • classification object
            Show classification properties
            • pii boolean
            • tags array of objects
              Show tags properties
              • tag string
              • score number

                format = double

            • sensitive boolean
            • obfuscation string
          • nullValueCount integer

            format = int64

          • textValueCount integer

            format = int64

          • zeroValueCount integer

            format = int64

          • maxNumericValue number

            format = double

          • maxStringLength integer

            format = int64

          • minNumericValue number

            format = double

          • minStringLength integer

            format = int64

          • sumStringLength integer

            format = int64

          • emptyStringCount integer

            format = int64

          • sumNumericValues number

            format = double

          • numericValueCount integer

            format = int64

          • standardDeviation number

            format = double

          • distinctValueCount integer

            format = int64

          • mostFrequentValues array of objects
            Show mostFrequentValues properties
            • value string
            • frequency integer

              format = int64

          • negativeValueCount integer

            format = int64

          • positiveValueCount integer

            format = int64

          • averageStringLength number

            format = double

          • frequencyDistribution array of objects
            Show frequencyDistribution properties
            • binEdge number

              format = double

            • frequency integer

              format = int64

          • lastSortedStringValue string
          • firstSortedStringValue string
          • sumSquaredNumericValues number

            format = double

    • page integer

      format = int32

    • limit integer

      format = int32

    • links object
      Show links properties
      • last object
        Show last properties
        • href string
      • next object
        Show next properties
        • href string
      • prev object
        Show prev properties
        • href string
      • self object
        Show self properties
        • href string
      • first object
        Show first properties
        • href string
    • pages integer

      format = int32

    • total integer

      format = int64

400

The request is in incorrect format.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
      • status string
    • traceId string

401

User does not have valid authentication credentials.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
      • status string
    • traceId string

403

User does not have access to the resource.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
      • status string
    • traceId string

404

Resource does not exist.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
      • status string
    • traceId string

409

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

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
      • status string
    • traceId string

500

Internal Server Error.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
      • status string
    • traceId string

503

Requested service is not available.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
      • status string
    • traceId string
GET /api/v1/data-sets/{data-set-id}/profiles 
import { createQlikApi } from '@qlik/api'


const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})


await qlik.dataSets.getDataSetProfiles(
  'string',
  {},
)
qlik data-set profiles 'string'
curl "https://{tenant}.{region}.qlikcloud.com/api/v1/data-sets/{data-set-id}/profiles" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "data": [
    {
      "meta": {
        "status": "QUEUED",
        "messages": [
          "string"
        ],
        "dataSetId": "string",
        "resultType": "NORMAL",
        "connectionId": "string",
        "lastLoadTime": "2018-10-30T07:06:22Z",
        "computationEndTime": "2018-10-30T07:06:22Z",
        "computationStartTime": "2018-10-30T07:06:22Z"
      },
      "samples": [
        {
          "name": "string",
          "records": [
            {
              "values": [
                "string"
              ]
            }
          ],
          "fieldNames": [
            "string"
          ]
        }
      ],
      "profiles": [
        {
          "name": "string",
          "sizeInBytes": 42,
          "numberOfRows": 42,
          "fieldProfiles": [
            {
              "name": "string",
              "tags": [
                "string"
              ],
              "index": 42,
              "median": 42,
              "average": 42,
              "dataType": "DATE",
              "evenness": 42,
              "kurtosis": 42,
              "skewness": 42,
              "fractiles": [
                42
              ],
              "sampleValues": [
                "string"
              ],
              "technicalName": "string",
              "classification": {
                "pii": true,
                "tags": [
                  {
                    "tag": "string",
                    "score": 42
                  }
                ],
                "sensitive": true,
                "obfuscation": "string"
              },
              "nullValueCount": 42,
              "textValueCount": 42,
              "zeroValueCount": 42,
              "maxNumericValue": 42,
              "maxStringLength": 42,
              "minNumericValue": 42,
              "minStringLength": 42,
              "sumStringLength": 42,
              "emptyStringCount": 42,
              "sumNumericValues": 42,
              "numericValueCount": 42,
              "standardDeviation": 42,
              "distinctValueCount": 42,
              "mostFrequentValues": [
                {
                  "value": "string",
                  "frequency": 42
                }
              ],
              "negativeValueCount": 42,
              "positiveValueCount": 42,
              "averageStringLength": 42,
              "frequencyDistribution": [
                {
                  "binEdge": 42,
                  "frequency": 42
                }
              ],
              "lastSortedStringValue": "string",
              "firstSortedStringValue": "string",
              "sumSquaredNumericValues": 42
            }
          ]
        }
      ]
    }
  ],
  "page": 42,
  "limit": 42,
  "links": {
    "last": {
      "href": "string"
    },
    "next": {
      "href": "string"
    },
    "prev": {
      "href": "string"
    },
    "self": {
      "href": "string"
    },
    "first": {
      "href": "string"
    }
  },
  "pages": 42,
  "total": 42
}