Data sets

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

Download specification

Save new data set

Facts

Rate limit Tier 2 (100 requests per minute)
Categories build

Request Body

Required

application/json

  • application/jsonobject
    Show application/json properties
    • idstring

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

    • qristring
      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>"

    • namestring

      minLength = 0, maxLength = 255

    • tagsarray of strings

      uniqueItems = true

    • typestring
    • schemaobject

      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
      • anomaliesarray of strings

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

        uniqueItems = true

      • dataFieldsarray of objects
        Required
        Show dataFields properties
        • namestring
          Required

          minLength = 1, maxLength = 255

        • tagsarray of strings

          An array of system tags

          uniqueItems = true

        • aliasstring
        • indexinteger

          format = int32

        • orphanboolean
        • dataTypeobject
          Required
          Show dataType properties
          • typestring
            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"

          • propertiesobject

            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.

            additional properties

          • originalTypestring
        • nullableboolean
        • userTagsarray of objects

          An array of user-supplied tags

          uniqueItems = true

          Show userTags properties
          • idstring

            The id of the tag in Collections

          • namestring

            minLength = 1, maxLength = 128

        • encryptedboolean
        • sensitiveboolean
        • primaryKeyboolean
        • propertiesobject

          additional properties

        • descriptionstring
        • ordinalPositionInKeyinteger

          format = int32

      • schemaNamestring
      • loadOptionsobject

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

        additional properties

      • overrideSchemaAnomaliesboolean
    • ownerIdstring

      The value is automatically set by the application.

    • spaceIdstring
    • versioninteger

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

      format = int64

    • secureQristring
      Required
    • propertiesobject

      A Map of name-value pairs.

      additional properties

    • descriptionstring

      minLength = 0, maxLength = 1024

    • operationalobject
      Show operational properties
      • sizeinteger

        format = int64

      • statusstring
      • endDatestring

        format = "date-time"

      • locationstring
      • rowCountinteger

        format = int64

      • startDatestring

        format = "date-time"

      • logMessagestring
      • tableOwnerstring
      • lastLoadTimestring

        format = "date-time"

      • contentUpdatedboolean
      • lastUpdateTimestring

        format = "date-time"

      • tableConnectionInfoobject
        Show tableConnectionInfo properties
        • tableNamestring
        • selectionScriptstring
        • additionalPropertiesobject

          additional properties

    • dataAssetInfoobject
      Required
      Show dataAssetInfo properties
      • idstring
        Required
      • dataStoreInfoobject
        Show dataStoreInfo properties
        • idstring
          Required
    • technicalNamestring
      Required

      minLength = 1, maxLength = 255

    • appTypeOverridestring

      Optional override of DataAsset appType.

    • additionalSchemasarray 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
      • anomaliesarray of strings

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

        uniqueItems = true

      • dataFieldsarray of objects
        Required
        Show dataFields properties
        • namestring
          Required

          minLength = 1, maxLength = 255

        • tagsarray of strings

          An array of system tags

          uniqueItems = true

        • aliasstring
        • indexinteger

          format = int32

        • orphanboolean
        • dataTypeobject
          Required
          Show dataType properties
          • typestring
            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"

          • propertiesobject

            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.

            additional properties

          • originalTypestring
        • nullableboolean
        • userTagsarray of objects

          An array of user-supplied tags

          uniqueItems = true

          Show userTags properties
          • idstring

            The id of the tag in Collections

          • namestring

            minLength = 1, maxLength = 128

        • encryptedboolean
        • sensitiveboolean
        • primaryKeyboolean
        • propertiesobject

          additional properties

        • descriptionstring
        • ordinalPositionInKeyinteger

          format = int32

      • schemaNamestring
      • loadOptionsobject

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

        additional properties

      • effectiveDatestring

        format = "date-time"

      • overrideSchemaAnomaliesboolean
    • technicalDescriptionstring

      minLength = 0, maxLength = 1024

    • createdByConnectionIdstring

      The connectionId that created the Dataset. Optional.

Responses

201

application/json

Created new data set successfully.

  • application/jsonobject
    Show application/json properties
    • idstring

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

    • qristring
      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>"

    • namestring

      minLength = 0, maxLength = 255

    • tagsarray of strings

      uniqueItems = true

    • typestring
    • schemaobject

      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
      • anomaliesarray of strings

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

        uniqueItems = true

      • dataFieldsarray of objects
        Required
        Show dataFields properties
        • namestring
          Required

          minLength = 1, maxLength = 255

        • tagsarray of strings

          An array of system tags

          uniqueItems = true

        • aliasstring
        • indexinteger

          format = int32

        • orphanboolean
        • dataTypeobject
          Required
          Show dataType properties
          • typestring
            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"

          • propertiesobject

            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.

            additional properties

          • originalTypestring
        • nullableboolean
        • userTagsarray of objects

          An array of user-supplied tags

          uniqueItems = true

          Show userTags properties
          • idstring

            The id of the tag in Collections

          • namestring

            minLength = 1, maxLength = 128

        • encryptedboolean
        • sensitiveboolean
        • primaryKeyboolean
        • propertiesobject

          additional properties

        • descriptionstring
        • ordinalPositionInKeyinteger

          format = int32

      • schemaNamestring
      • loadOptionsobject

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

        additional properties

      • effectiveDatestring

        format = "date-time"

      • overrideSchemaAnomaliesboolean
    • ownerIdstring

      The value is automatically set by the application.

    • spaceIdstring
    • versioninteger

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

      format = int64

    • tenantIdstring

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

    • createdBystring

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

    • secureQristring
      Required
    • propertiesobject

      A Map of name-value pairs.

      additional properties

    • createdTimestring

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

      format = "date-time"

    • descriptionstring

      minLength = 0, maxLength = 1024

    • operationalobject
      Show operational properties
      • sizeinteger

        format = int64

      • statusstring
      • endDatestring

        format = "date-time"

      • locationstring
      • rowCountinteger

        format = int64

      • startDatestring

        format = "date-time"

      • logMessagestring
      • tableOwnerstring
      • lastLoadTimestring

        format = "date-time"

      • contentUpdatedboolean
      • lastUpdateTimestring

        format = "date-time"

      • tableConnectionInfoobject
        Show tableConnectionInfo properties
        • tableNamestring
        • selectionScriptstring
        • additionalPropertiesobject

          additional properties

    • dataAssetInfoobject
      Required
      Show dataAssetInfo properties
      • idstring
        Required
      • namestring
      • dataStoreInfoobject
        Show dataStoreInfo properties
        • idstring
          Required
        • namestring
        • typestring
    • technicalNamestring
      Required

      minLength = 1, maxLength = 255

    • lastModifiedBystring

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

    • appTypeOverridestring

      Optional override of DataAsset appType.

    • lastModifiedTimestring

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

      format = "date-time"

    • additionalSchemasarray 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
      • anomaliesarray of strings

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

        uniqueItems = true

      • dataFieldsarray of objects
        Required
        Show dataFields properties
        • namestring
          Required

          minLength = 1, maxLength = 255

        • tagsarray of strings

          An array of system tags

          uniqueItems = true

        • aliasstring
        • indexinteger

          format = int32

        • orphanboolean
        • dataTypeobject
          Required
          Show dataType properties
          • typestring
            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"

          • propertiesobject

            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.

            additional properties

          • originalTypestring
        • nullableboolean
        • userTagsarray of objects

          An array of user-supplied tags

          uniqueItems = true

          Show userTags properties
          • idstring

            The id of the tag in Collections

          • namestring

            minLength = 1, maxLength = 128

        • encryptedboolean
        • sensitiveboolean
        • primaryKeyboolean
        • propertiesobject

          additional properties

        • descriptionstring
        • ordinalPositionInKeyinteger

          format = int32

      • schemaNamestring
      • loadOptionsobject

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

        additional properties

      • effectiveDatestring

        format = "date-time"

      • overrideSchemaAnomaliesboolean
    • technicalDescriptionstring

      minLength = 0, maxLength = 1024

    • createdByConnectionIdstring

      The connectionId that created the Dataset. Optional.

400

application/json

The request is in incorrect format.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
      • statusstring
    • traceIdstring

401

application/json

User does not have valid authentication credentials.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
      • statusstring
    • traceIdstring

403

application/json

User does not have access to the resource.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
      • statusstring
    • traceIdstring

404

application/json

Resource does not exist.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
      • statusstring
    • traceIdstring

409

application/json

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

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
      • statusstring
    • traceIdstring

500

application/json

Internal Server Error.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
      • statusstring
    • traceIdstring

503

application/json

Requested service is not available.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
      • statusstring
    • traceIdstring
POST /v1/data-sets 
curl "https://your-tenant.us.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"}'

const https = require('https')
  const data = JSON.stringify({"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"})
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/data-sets',
    'method': 'POST',
    'headers': {
      'Content-type': 'application/json',
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)
  req.write(data)
  

This API is not included yet in qlik-cli

Request

{
  "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"
}

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)
Categories build

Request Body

Required

application/json

  • application/jsonobject
    Show application/json properties
    • idsarray of strings

      uniqueItems = true

Responses

204

Deleted data sets.

400

application/json

The request is in incorrect format.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
      • statusstring
    • traceIdstring

401

application/json

User does not have valid authentication credentials.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
      • statusstring
    • traceIdstring

403

application/json

User does not have access to the resource.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
      • statusstring
    • traceIdstring

404

application/json

Resource does not exist.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
      • statusstring
    • traceIdstring

409

application/json

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

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
      • statusstring
    • traceIdstring

500

application/json

Internal Server Error.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
      • statusstring
    • traceIdstring

503

application/json

Requested service is not available.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
      • statusstring
    • traceIdstring
DELETE /v1/data-sets 
curl "https://your-tenant.us.qlikcloud.com/api/v1/data-sets" \
-X DELETE \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{"ids":["string"]}'

const https = require('https')
  const data = JSON.stringify({"ids":["string"]})
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/data-sets',
    'method': 'DELETE',
    'headers': {
      'Content-type': 'application/json',
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)
  req.write(data)
  

This API is not included yet in qlik-cli

Request

{
  "ids": [
    "string"
  ]
}

Get data set by ID.

Facts

Rate limit Tier 1 (1000 requests per minute)
Categories build

Query Parameters

  • projectionsarray of strings

    Comma-separated fields to return in the response.

Path Parameters

  • data-set-idstring
    Required

Responses

200

application/json

Successful Operation.

  • application/jsonobject
    Show application/json properties
    • idstring

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

    • qristring
      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>"

    • namestring

      minLength = 0, maxLength = 255

    • tagsarray of strings

      uniqueItems = true

    • typestring
    • schemaobject

      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
      • anomaliesarray of strings

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

        uniqueItems = true

      • dataFieldsarray of objects
        Required
        Show dataFields properties
        • namestring
          Required

          minLength = 1, maxLength = 255

        • tagsarray of strings

          An array of system tags

          uniqueItems = true

        • aliasstring
        • indexinteger

          format = int32

        • orphanboolean
        • dataTypeobject
          Required
          Show dataType properties
          • typestring
            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"

          • propertiesobject

            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.

            additional properties

          • originalTypestring
        • nullableboolean
        • userTagsarray of objects

          An array of user-supplied tags

          uniqueItems = true

          Show userTags properties
          • idstring

            The id of the tag in Collections

          • namestring

            minLength = 1, maxLength = 128

        • encryptedboolean
        • sensitiveboolean
        • primaryKeyboolean
        • propertiesobject

          additional properties

        • descriptionstring
        • ordinalPositionInKeyinteger

          format = int32

      • schemaNamestring
      • loadOptionsobject

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

        additional properties

      • effectiveDatestring

        format = "date-time"

      • overrideSchemaAnomaliesboolean
    • ownerIdstring

      The value is automatically set by the application.

    • spaceIdstring
    • versioninteger

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

      format = int64

    • tenantIdstring

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

    • createdBystring

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

    • secureQristring
      Required
    • propertiesobject

      A Map of name-value pairs.

      additional properties

    • createdTimestring

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

      format = "date-time"

    • descriptionstring

      minLength = 0, maxLength = 1024

    • operationalobject
      Show operational properties
      • sizeinteger

        format = int64

      • statusstring
      • endDatestring

        format = "date-time"

      • locationstring
      • rowCountinteger

        format = int64

      • startDatestring

        format = "date-time"

      • logMessagestring
      • tableOwnerstring
      • lastLoadTimestring

        format = "date-time"

      • contentUpdatedboolean
      • lastUpdateTimestring

        format = "date-time"

      • tableConnectionInfoobject
        Show tableConnectionInfo properties
        • tableNamestring
        • selectionScriptstring
        • additionalPropertiesobject

          additional properties

    • dataAssetInfoobject
      Required
      Show dataAssetInfo properties
      • idstring
        Required
      • namestring
      • dataStoreInfoobject
        Show dataStoreInfo properties
        • idstring
          Required
        • namestring
        • typestring
    • technicalNamestring
      Required

      minLength = 1, maxLength = 255

    • lastModifiedBystring

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

    • appTypeOverridestring

      Optional override of DataAsset appType.

    • lastModifiedTimestring

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

      format = "date-time"

    • additionalSchemasarray 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
      • anomaliesarray of strings

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

        uniqueItems = true

      • dataFieldsarray of objects
        Required
        Show dataFields properties
        • namestring
          Required

          minLength = 1, maxLength = 255

        • tagsarray of strings

          An array of system tags

          uniqueItems = true

        • aliasstring
        • indexinteger

          format = int32

        • orphanboolean
        • dataTypeobject
          Required
          Show dataType properties
          • typestring
            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"

          • propertiesobject

            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.

            additional properties

          • originalTypestring
        • nullableboolean
        • userTagsarray of objects

          An array of user-supplied tags

          uniqueItems = true

          Show userTags properties
          • idstring

            The id of the tag in Collections

          • namestring

            minLength = 1, maxLength = 128

        • encryptedboolean
        • sensitiveboolean
        • primaryKeyboolean
        • propertiesobject

          additional properties

        • descriptionstring
        • ordinalPositionInKeyinteger

          format = int32

      • schemaNamestring
      • loadOptionsobject

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

        additional properties

      • effectiveDatestring

        format = "date-time"

      • overrideSchemaAnomaliesboolean
    • technicalDescriptionstring

      minLength = 0, maxLength = 1024

    • createdByConnectionIdstring

      The connectionId that created the Dataset. Optional.

400

application/json

The request is in incorrect format.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
      • statusstring
    • traceIdstring

401

application/json

User does not have valid authentication credentials.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
      • statusstring
    • traceIdstring

403

application/json

User does not have access to the resource.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
      • statusstring
    • traceIdstring

404

application/json

Resource does not exist.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
      • statusstring
    • traceIdstring

409

application/json

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

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
      • statusstring
    • traceIdstring

500

application/json

Internal Server Error.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
      • statusstring
    • traceIdstring

503

application/json

Requested service is not available.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
      • statusstring
    • traceIdstring
GET /v1/data-sets/{data-set-id} 
curl "https://your-tenant.us.qlikcloud.com/api/v1/data-sets/{data-set-id}" \
-H "Authorization: Bearer <access_token>"

const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/data-sets/{data-set-id}',
    'method': 'GET',
    'headers': {
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)
  

This API is not included yet in qlik-cli

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.

Facts

Rate limit Tier 2 (100 requests per minute)
Categories build

Path Parameters

  • data-set-idstring
    Required

Request Body

Required

application/json

Array of JSON patch documents as defined by RFC 6902.

  • application/jsonarray of objects

    Array of JSON patch documents as defined by RFC 6902.

    Show application/json properties
    • opstring
      Required

      The operation to be performed.

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

    • fromstring

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

    • pathstring
      Required

      A JSON pointer to the property being affected.

    • valueobject

      The value to add, replace or test.

Responses

200

application/json

Patched data set successfully.

  • application/jsonobject
    Show application/json properties
    • idstring

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

    • qristring
      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>"

    • namestring

      minLength = 0, maxLength = 255

    • tagsarray of strings

      uniqueItems = true

    • typestring
    • schemaobject

      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
      • anomaliesarray of strings

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

        uniqueItems = true

      • dataFieldsarray of objects
        Required
        Show dataFields properties
        • namestring
          Required

          minLength = 1, maxLength = 255

        • tagsarray of strings

          An array of system tags

          uniqueItems = true

        • aliasstring
        • indexinteger

          format = int32

        • orphanboolean
        • dataTypeobject
          Required
          Show dataType properties
          • typestring
            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"

          • propertiesobject

            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.

            additional properties

          • originalTypestring
        • nullableboolean
        • userTagsarray of objects

          An array of user-supplied tags

          uniqueItems = true

          Show userTags properties
          • idstring

            The id of the tag in Collections

          • namestring

            minLength = 1, maxLength = 128

        • encryptedboolean
        • sensitiveboolean
        • primaryKeyboolean
        • propertiesobject

          additional properties

        • descriptionstring
        • ordinalPositionInKeyinteger

          format = int32

      • schemaNamestring
      • loadOptionsobject

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

        additional properties

      • effectiveDatestring

        format = "date-time"

      • overrideSchemaAnomaliesboolean
    • ownerIdstring

      The value is automatically set by the application.

    • spaceIdstring
    • versioninteger

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

      format = int64

    • tenantIdstring

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

    • createdBystring

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

    • secureQristring
      Required
    • propertiesobject

      A Map of name-value pairs.

      additional properties

    • createdTimestring

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

      format = "date-time"

    • descriptionstring

      minLength = 0, maxLength = 1024

    • operationalobject
      Show operational properties
      • sizeinteger

        format = int64

      • statusstring
      • endDatestring

        format = "date-time"

      • locationstring
      • rowCountinteger

        format = int64

      • startDatestring

        format = "date-time"

      • logMessagestring
      • tableOwnerstring
      • lastLoadTimestring

        format = "date-time"

      • contentUpdatedboolean
      • lastUpdateTimestring

        format = "date-time"

      • tableConnectionInfoobject
        Show tableConnectionInfo properties
        • tableNamestring
        • selectionScriptstring
        • additionalPropertiesobject

          additional properties

    • dataAssetInfoobject
      Required
      Show dataAssetInfo properties
      • idstring
        Required
      • namestring
      • dataStoreInfoobject
        Show dataStoreInfo properties
        • idstring
          Required
        • namestring
        • typestring
    • technicalNamestring
      Required

      minLength = 1, maxLength = 255

    • lastModifiedBystring

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

    • appTypeOverridestring

      Optional override of DataAsset appType.

    • lastModifiedTimestring

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

      format = "date-time"

    • additionalSchemasarray 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
      • anomaliesarray of strings

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

        uniqueItems = true

      • dataFieldsarray of objects
        Required
        Show dataFields properties
        • namestring
          Required

          minLength = 1, maxLength = 255

        • tagsarray of strings

          An array of system tags

          uniqueItems = true

        • aliasstring
        • indexinteger

          format = int32

        • orphanboolean
        • dataTypeobject
          Required
          Show dataType properties
          • typestring
            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"

          • propertiesobject

            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.

            additional properties

          • originalTypestring
        • nullableboolean
        • userTagsarray of objects

          An array of user-supplied tags

          uniqueItems = true

          Show userTags properties
          • idstring

            The id of the tag in Collections

          • namestring

            minLength = 1, maxLength = 128

        • encryptedboolean
        • sensitiveboolean
        • primaryKeyboolean
        • propertiesobject

          additional properties

        • descriptionstring
        • ordinalPositionInKeyinteger

          format = int32

      • schemaNamestring
      • loadOptionsobject

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

        additional properties

      • effectiveDatestring

        format = "date-time"

      • overrideSchemaAnomaliesboolean
    • technicalDescriptionstring

      minLength = 0, maxLength = 1024

    • createdByConnectionIdstring

      The connectionId that created the Dataset. Optional.

204

application/json

Patched data set successfully.

  • application/jsonobject
    Show application/json properties
    • idstring

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

    • qristring
      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>"

    • namestring

      minLength = 0, maxLength = 255

    • tagsarray of strings

      uniqueItems = true

    • typestring
    • schemaobject

      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
      • anomaliesarray of strings

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

        uniqueItems = true

      • dataFieldsarray of objects
        Required
        Show dataFields properties
        • namestring
          Required

          minLength = 1, maxLength = 255

        • tagsarray of strings

          An array of system tags

          uniqueItems = true

        • aliasstring
        • indexinteger

          format = int32

        • orphanboolean
        • dataTypeobject
          Required
          Show dataType properties
          • typestring
            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"

          • propertiesobject

            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.

            additional properties

          • originalTypestring
        • nullableboolean
        • userTagsarray of objects

          An array of user-supplied tags

          uniqueItems = true

          Show userTags properties
          • idstring

            The id of the tag in Collections

          • namestring

            minLength = 1, maxLength = 128

        • encryptedboolean
        • sensitiveboolean
        • primaryKeyboolean
        • propertiesobject

          additional properties

        • descriptionstring
        • ordinalPositionInKeyinteger

          format = int32

      • schemaNamestring
      • loadOptionsobject

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

        additional properties

      • effectiveDatestring

        format = "date-time"

      • overrideSchemaAnomaliesboolean
    • ownerIdstring

      The value is automatically set by the application.

    • spaceIdstring
    • versioninteger

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

      format = int64

    • tenantIdstring

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

    • createdBystring

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

    • secureQristring
      Required
    • propertiesobject

      A Map of name-value pairs.

      additional properties

    • createdTimestring

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

      format = "date-time"

    • descriptionstring

      minLength = 0, maxLength = 1024

    • operationalobject
      Show operational properties
      • sizeinteger

        format = int64

      • statusstring
      • endDatestring

        format = "date-time"

      • locationstring
      • rowCountinteger

        format = int64

      • startDatestring

        format = "date-time"

      • logMessagestring
      • tableOwnerstring
      • lastLoadTimestring

        format = "date-time"

      • contentUpdatedboolean
      • lastUpdateTimestring

        format = "date-time"

      • tableConnectionInfoobject
        Show tableConnectionInfo properties
        • tableNamestring
        • selectionScriptstring
        • additionalPropertiesobject

          additional properties

    • dataAssetInfoobject
      Required
      Show dataAssetInfo properties
      • idstring
        Required
      • namestring
      • dataStoreInfoobject
        Show dataStoreInfo properties
        • idstring
          Required
        • namestring
        • typestring
    • technicalNamestring
      Required

      minLength = 1, maxLength = 255

    • lastModifiedBystring

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

    • appTypeOverridestring

      Optional override of DataAsset appType.

    • lastModifiedTimestring

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

      format = "date-time"

    • additionalSchemasarray 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
      • anomaliesarray of strings

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

        uniqueItems = true

      • dataFieldsarray of objects
        Required
        Show dataFields properties
        • namestring
          Required

          minLength = 1, maxLength = 255

        • tagsarray of strings

          An array of system tags

          uniqueItems = true

        • aliasstring
        • indexinteger

          format = int32

        • orphanboolean
        • dataTypeobject
          Required
          Show dataType properties
          • typestring
            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"

          • propertiesobject

            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.

            additional properties

          • originalTypestring
        • nullableboolean
        • userTagsarray of objects

          An array of user-supplied tags

          uniqueItems = true

          Show userTags properties
          • idstring

            The id of the tag in Collections

          • namestring

            minLength = 1, maxLength = 128

        • encryptedboolean
        • sensitiveboolean
        • primaryKeyboolean
        • propertiesobject

          additional properties

        • descriptionstring
        • ordinalPositionInKeyinteger

          format = int32

      • schemaNamestring
      • loadOptionsobject

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

        additional properties

      • effectiveDatestring

        format = "date-time"

      • overrideSchemaAnomaliesboolean
    • technicalDescriptionstring

      minLength = 0, maxLength = 1024

    • createdByConnectionIdstring

      The connectionId that created the Dataset. Optional.

400

application/json

The request is in incorrect format.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
      • statusstring
    • traceIdstring

401

application/json

User does not have valid authentication credentials.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
      • statusstring
    • traceIdstring

403

application/json

User does not have access to the resource.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
      • statusstring
    • traceIdstring

404

application/json

Resource does not exist.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
      • statusstring
    • traceIdstring

409

application/json

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

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
      • statusstring
    • traceIdstring

500

application/json

Internal Server Error.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
      • statusstring
    • traceIdstring

503

application/json

Requested service is not available.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
      • statusstring
    • traceIdstring
PATCH /v1/data-sets/{data-set-id} 
curl "https://your-tenant.us.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":{}}]'

const https = require('https')
  const data = JSON.stringify([{"op":"add","from":"string","path":"string","value":{}}])
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/data-sets/{data-set-id}',
    'method': 'PATCH',
    'headers': {
      'Content-type': 'application/json',
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)
  req.write(data)
  

This API is not included yet in qlik-cli

Request

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

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.

Facts

Rate limit Tier 2 (100 requests per minute)
Categories build

Path Parameters

  • data-set-idstring
    Required

Request Body

Required

application/json

  • application/jsonobject
    Show application/json properties
    • idstring

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

    • qristring
      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>"

    • namestring

      minLength = 0, maxLength = 255

    • tagsarray of strings

      uniqueItems = true

    • typestring
    • schemaobject

      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
      • anomaliesarray of strings

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

        uniqueItems = true

      • dataFieldsarray of objects
        Required
        Show dataFields properties
        • namestring
          Required

          minLength = 1, maxLength = 255

        • tagsarray of strings

          An array of system tags

          uniqueItems = true

        • aliasstring
        • indexinteger

          format = int32

        • orphanboolean
        • dataTypeobject
          Required
          Show dataType properties
          • typestring
            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"

          • propertiesobject

            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.

            additional properties

          • originalTypestring
        • nullableboolean
        • userTagsarray of objects

          An array of user-supplied tags

          uniqueItems = true

          Show userTags properties
          • idstring

            The id of the tag in Collections

          • namestring

            minLength = 1, maxLength = 128

        • encryptedboolean
        • sensitiveboolean
        • primaryKeyboolean
        • propertiesobject

          additional properties

        • descriptionstring
        • ordinalPositionInKeyinteger

          format = int32

      • schemaNamestring
      • loadOptionsobject

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

        additional properties

      • overrideSchemaAnomaliesboolean
    • ownerIdstring

      The value is automatically set by the application.

    • spaceIdstring
    • versioninteger

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

      format = int64

    • secureQristring
      Required
    • propertiesobject

      A Map of name-value pairs.

      additional properties

    • descriptionstring

      minLength = 0, maxLength = 1024

    • operationalobject
      Show operational properties
      • sizeinteger

        format = int64

      • statusstring
      • endDatestring

        format = "date-time"

      • locationstring
      • rowCountinteger

        format = int64

      • startDatestring

        format = "date-time"

      • logMessagestring
      • tableOwnerstring
      • lastLoadTimestring

        format = "date-time"

      • contentUpdatedboolean
      • lastUpdateTimestring

        format = "date-time"

      • tableConnectionInfoobject
        Show tableConnectionInfo properties
        • tableNamestring
        • selectionScriptstring
        • additionalPropertiesobject

          additional properties

    • dataAssetInfoobject
      Required
      Show dataAssetInfo properties
      • idstring
        Required
      • dataStoreInfoobject
        Show dataStoreInfo properties
        • idstring
          Required
    • technicalNamestring
      Required

      minLength = 1, maxLength = 255

    • appTypeOverridestring

      Optional override of DataAsset appType.

    • additionalSchemasarray 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
      • anomaliesarray of strings

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

        uniqueItems = true

      • dataFieldsarray of objects
        Required
        Show dataFields properties
        • namestring
          Required

          minLength = 1, maxLength = 255

        • tagsarray of strings

          An array of system tags

          uniqueItems = true

        • aliasstring
        • indexinteger

          format = int32

        • orphanboolean
        • dataTypeobject
          Required
          Show dataType properties
          • typestring
            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"

          • propertiesobject

            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.

            additional properties

          • originalTypestring
        • nullableboolean
        • userTagsarray of objects

          An array of user-supplied tags

          uniqueItems = true

          Show userTags properties
          • idstring

            The id of the tag in Collections

          • namestring

            minLength = 1, maxLength = 128

        • encryptedboolean
        • sensitiveboolean
        • primaryKeyboolean
        • propertiesobject

          additional properties

        • descriptionstring
        • ordinalPositionInKeyinteger

          format = int32

      • schemaNamestring
      • loadOptionsobject

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

        additional properties

      • effectiveDatestring

        format = "date-time"

      • overrideSchemaAnomaliesboolean
    • technicalDescriptionstring

      minLength = 0, maxLength = 1024

    • createdByConnectionIdstring

      The connectionId that created the Dataset. Optional.

Responses

200

application/json

Updated data set successfully.

  • application/jsonobject
    Show application/json properties
    • idstring

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

    • qristring
      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>"

    • namestring

      minLength = 0, maxLength = 255

    • tagsarray of strings

      uniqueItems = true

    • typestring
    • schemaobject

      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
      • anomaliesarray of strings

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

        uniqueItems = true

      • dataFieldsarray of objects
        Required
        Show dataFields properties
        • namestring
          Required

          minLength = 1, maxLength = 255

        • tagsarray of strings

          An array of system tags

          uniqueItems = true

        • aliasstring
        • indexinteger

          format = int32

        • orphanboolean
        • dataTypeobject
          Required
          Show dataType properties
          • typestring
            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"

          • propertiesobject

            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.

            additional properties

          • originalTypestring
        • nullableboolean
        • userTagsarray of objects

          An array of user-supplied tags

          uniqueItems = true

          Show userTags properties
          • idstring

            The id of the tag in Collections

          • namestring

            minLength = 1, maxLength = 128

        • encryptedboolean
        • sensitiveboolean
        • primaryKeyboolean
        • propertiesobject

          additional properties

        • descriptionstring
        • ordinalPositionInKeyinteger

          format = int32

      • schemaNamestring
      • loadOptionsobject

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

        additional properties

      • effectiveDatestring

        format = "date-time"

      • overrideSchemaAnomaliesboolean
    • ownerIdstring

      The value is automatically set by the application.

    • spaceIdstring
    • versioninteger

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

      format = int64

    • tenantIdstring

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

    • createdBystring

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

    • secureQristring
      Required
    • propertiesobject

      A Map of name-value pairs.

      additional properties

    • createdTimestring

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

      format = "date-time"

    • descriptionstring

      minLength = 0, maxLength = 1024

    • operationalobject
      Show operational properties
      • sizeinteger

        format = int64

      • statusstring
      • endDatestring

        format = "date-time"

      • locationstring
      • rowCountinteger

        format = int64

      • startDatestring

        format = "date-time"

      • logMessagestring
      • tableOwnerstring
      • lastLoadTimestring

        format = "date-time"

      • contentUpdatedboolean
      • lastUpdateTimestring

        format = "date-time"

      • tableConnectionInfoobject
        Show tableConnectionInfo properties
        • tableNamestring
        • selectionScriptstring
        • additionalPropertiesobject

          additional properties

    • dataAssetInfoobject
      Required
      Show dataAssetInfo properties
      • idstring
        Required
      • namestring
      • dataStoreInfoobject
        Show dataStoreInfo properties
        • idstring
          Required
        • namestring
        • typestring
    • technicalNamestring
      Required

      minLength = 1, maxLength = 255

    • lastModifiedBystring

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

    • appTypeOverridestring

      Optional override of DataAsset appType.

    • lastModifiedTimestring

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

      format = "date-time"

    • additionalSchemasarray 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
      • anomaliesarray of strings

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

        uniqueItems = true

      • dataFieldsarray of objects
        Required
        Show dataFields properties
        • namestring
          Required

          minLength = 1, maxLength = 255

        • tagsarray of strings

          An array of system tags

          uniqueItems = true

        • aliasstring
        • indexinteger

          format = int32

        • orphanboolean
        • dataTypeobject
          Required
          Show dataType properties
          • typestring
            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"

          • propertiesobject

            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.

            additional properties

          • originalTypestring
        • nullableboolean
        • userTagsarray of objects

          An array of user-supplied tags

          uniqueItems = true

          Show userTags properties
          • idstring

            The id of the tag in Collections

          • namestring

            minLength = 1, maxLength = 128

        • encryptedboolean
        • sensitiveboolean
        • primaryKeyboolean
        • propertiesobject

          additional properties

        • descriptionstring
        • ordinalPositionInKeyinteger

          format = int32

      • schemaNamestring
      • loadOptionsobject

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

        additional properties

      • effectiveDatestring

        format = "date-time"

      • overrideSchemaAnomaliesboolean
    • technicalDescriptionstring

      minLength = 0, maxLength = 1024

    • createdByConnectionIdstring

      The connectionId that created the Dataset. Optional.

400

application/json

The request is in incorrect format.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
      • statusstring
    • traceIdstring

401

application/json

User does not have valid authentication credentials.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
      • statusstring
    • traceIdstring

403

application/json

User does not have access to the resource.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
      • statusstring
    • traceIdstring

404

application/json

Resource does not exist.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
      • statusstring
    • traceIdstring

409

application/json

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

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
      • statusstring
    • traceIdstring

500

application/json

Internal Server Error.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
      • statusstring
    • traceIdstring

503

application/json

Requested service is not available.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
      • statusstring
    • traceIdstring
PUT /v1/data-sets/{data-set-id} 
curl "https://your-tenant.us.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"}'

const https = require('https')
  const data = JSON.stringify({"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"})
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/data-sets/{data-set-id}',
    'method': 'PUT',
    'headers': {
      'Content-type': 'application/json',
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)
  req.write(data)
  

This API is not included yet in qlik-cli

Request

{
  "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"
}

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)
Categories build

Query Parameters

  • dataConnectionIdsarray of strings

    Comma-separated data connection IDs.

  • limitinteger

    Page size limit.

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

  • pageinteger

    default = 0, format = int32, default = 0

  • projectionsarray of strings

    Comma-separated fields to return in the response.

  • sortarray of strings

Path Parameters

  • data-set-idstring
    Required

Responses

200

application/json

Return profiles of data set.

  • application/jsonobject
    Show application/json properties
    • dataarray of objects
      Show data properties
      • metaobject
        Show meta properties
        • statusstring

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

        • messagesarray of strings
        • dataSetIdstring
        • resultTypestring

          Can be one of: "NORMAL""BASIC"

        • connectionIdstring
        • lastLoadTimestring

          format = "date-time"

        • computationEndTimestring

          format = "date-time"

        • computationStartTimestring

          format = "date-time"

      • samplesarray of objects
        Show samples properties
        • namestring
        • recordsarray of objects
          Show records properties
          • valuesarray of strings
        • fieldNamesarray of strings
      • profilesarray of objects
        Show profiles properties
        • namestring
        • sizeInBytesinteger

          format = int64

        • numberOfRowsinteger

          format = int64

        • fieldProfilesarray of objects
          Show fieldProfiles properties
          • namestring
          • tagsarray of strings
          • indexinteger

            format = int32

          • mediannumber

            format = double

          • averagenumber

            format = double

          • dataTypestring

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

          • kurtosisnumber

            format = double

          • skewnessnumber

            format = double

          • fractilesarray of numbers
          • sampleValuesarray of strings
          • technicalNamestring
          • classificationobject
            Show classification properties
            • piiboolean
            • tagsarray of objects
              Show tags properties
              • tagstring
              • scorenumber

                format = double

            • sensitiveboolean
            • obfuscationstring
          • nullValueCountinteger

            format = int64

          • textValueCountinteger

            format = int64

          • zeroValueCountinteger

            format = int64

          • maxNumericValuenumber

            format = double

          • maxStringLengthinteger

            format = int64

          • minNumericValuenumber

            format = double

          • minStringLengthinteger

            format = int64

          • sumStringLengthinteger

            format = int64

          • emptyStringCountinteger

            format = int64

          • sumNumericValuesnumber

            format = double

          • numericValueCountinteger

            format = int64

          • standardDeviationnumber

            format = double

          • distinctValueCountinteger

            format = int64

          • mostFrequentValuesarray of objects
            Show mostFrequentValues properties
            • valuestring
            • frequencyinteger

              format = int64

          • negativeValueCountinteger

            format = int64

          • positiveValueCountinteger

            format = int64

          • averageStringLengthnumber

            format = double

          • frequencyDistributionarray of objects
            Show frequencyDistribution properties
            • binEdgenumber

              format = double

            • frequencyinteger

              format = int64

          • lastSortedStringValuestring
          • firstSortedStringValuestring
          • sumSquaredNumericValuesnumber

            format = double

    • pageinteger

      format = int32

    • limitinteger

      format = int32

    • linksobject
      Show links properties
      • lastobject
        Show last properties
        • hrefstring
      • nextobject
        Show next properties
        • hrefstring
      • prevobject
        Show prev properties
        • hrefstring
      • selfobject
        Show self properties
        • hrefstring
      • firstobject
        Show first properties
        • hrefstring
    • pagesinteger

      format = int32

    • totalinteger

      format = int64

202

application/json

The profile is currently running.

  • application/jsonobject
    Show application/json properties
    • dataarray of objects
      Show data properties
      • metaobject
        Show meta properties
        • statusstring

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

        • messagesarray of strings
        • dataSetIdstring
        • resultTypestring

          Can be one of: "NORMAL""BASIC"

        • connectionIdstring
        • lastLoadTimestring

          format = "date-time"

        • computationEndTimestring

          format = "date-time"

        • computationStartTimestring

          format = "date-time"

      • samplesarray of objects
        Show samples properties
        • namestring
        • recordsarray of objects
          Show records properties
          • valuesarray of strings
        • fieldNamesarray of strings
      • profilesarray of objects
        Show profiles properties
        • namestring
        • sizeInBytesinteger

          format = int64

        • numberOfRowsinteger

          format = int64

        • fieldProfilesarray of objects
          Show fieldProfiles properties
          • namestring
          • tagsarray of strings
          • indexinteger

            format = int32

          • mediannumber

            format = double

          • averagenumber

            format = double

          • dataTypestring

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

          • kurtosisnumber

            format = double

          • skewnessnumber

            format = double

          • fractilesarray of numbers
          • sampleValuesarray of strings
          • technicalNamestring
          • classificationobject
            Show classification properties
            • piiboolean
            • tagsarray of objects
              Show tags properties
              • tagstring
              • scorenumber

                format = double

            • sensitiveboolean
            • obfuscationstring
          • nullValueCountinteger

            format = int64

          • textValueCountinteger

            format = int64

          • zeroValueCountinteger

            format = int64

          • maxNumericValuenumber

            format = double

          • maxStringLengthinteger

            format = int64

          • minNumericValuenumber

            format = double

          • minStringLengthinteger

            format = int64

          • sumStringLengthinteger

            format = int64

          • emptyStringCountinteger

            format = int64

          • sumNumericValuesnumber

            format = double

          • numericValueCountinteger

            format = int64

          • standardDeviationnumber

            format = double

          • distinctValueCountinteger

            format = int64

          • mostFrequentValuesarray of objects
            Show mostFrequentValues properties
            • valuestring
            • frequencyinteger

              format = int64

          • negativeValueCountinteger

            format = int64

          • positiveValueCountinteger

            format = int64

          • averageStringLengthnumber

            format = double

          • frequencyDistributionarray of objects
            Show frequencyDistribution properties
            • binEdgenumber

              format = double

            • frequencyinteger

              format = int64

          • lastSortedStringValuestring
          • firstSortedStringValuestring
          • sumSquaredNumericValuesnumber

            format = double

    • pageinteger

      format = int32

    • limitinteger

      format = int32

    • linksobject
      Show links properties
      • lastobject
        Show last properties
        • hrefstring
      • nextobject
        Show next properties
        • hrefstring
      • prevobject
        Show prev properties
        • hrefstring
      • selfobject
        Show self properties
        • hrefstring
      • firstobject
        Show first properties
        • hrefstring
    • pagesinteger

      format = int32

    • totalinteger

      format = int64

400

application/json

The request is in incorrect format.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
      • statusstring
    • traceIdstring

401

application/json

User does not have valid authentication credentials.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
      • statusstring
    • traceIdstring

403

application/json

User does not have access to the resource.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
      • statusstring
    • traceIdstring

404

application/json

Resource does not exist.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
      • statusstring
    • traceIdstring

409

application/json

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

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
      • statusstring
    • traceIdstring

500

application/json

Internal Server Error.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
      • statusstring
    • traceIdstring

503

application/json

Requested service is not available.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
      • statusstring
    • traceIdstring
GET /v1/data-sets/{data-set-id}/profiles 
curl "https://your-tenant.us.qlikcloud.com/api/v1/data-sets/{data-set-id}/profiles" \
-H "Authorization: Bearer <access_token>"

const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/data-sets/{data-set-id}/profiles',
    'method': 'GET',
    'headers': {
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)
  

This API is not included yet in qlik-cli

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",
              "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
}