Skip to content

Qlik

Qlik Qlik is a business analytics platform. Use the Qlik component to manage your Data Sets, Assets, and Apps.

Connections

API Key {#apikey}

API keys must first be enabled by an Admin:

  1. Login to Qlik and navigate to Settings> API Keys and enable API keys

Developer privileges must be given to users to use API keys:

  1. Navigate to the Management Console > Users > Edit Roles
  2. Check the box next to ‘Developer’ and save.

Generate API Keys:

  1. Navigate to Management Console > API Keys and select ‘Generate new key’
  2. provide a description and expiration and Save.
  3. Once the key is generated enter the value in to the connection's configuration.
Input Comments Default
API Key API Key for your Qlik User
Tenant The tenant of your Qlik account, the first part of your URL: v34wwyjhxohtob1.us.qlikcloud.com

OAuth 2.0 {#oauth2}

Allows a client application to use an OAuth flow to request user authorization.

To set up OAuth in Qlik:

  1. Login to Qlik and Navigate to Management Console > OAuth and select ‘Create New’
  2. Set ‘Web’ as the Client type and name the connection
  3. Enter https://oauth2.arenasolutions.com/callback to the ‘Add redirect URLs” field and select Add
  4. Select ‘Create’ Qlik will generate the client ID and client secret.
  5. Transfer these values to the connection's configuration.

This connection uses OAuth 2.0, a common authentication mechanism for integrations. Read about how OAuth 2.0 works here.

Input Comments Default
Authorize URL The OAuth 2.0 Authorization URL for Qlik https://.us.qlikcloud.com/oauth/authorize
Token URL The OAuth 2.0 Token URL for Sage https://.us.qlikcloud.com/oauth/token
Scopes Space separated OAuth 2.0 permission scopes for Sage user_default online_access
Client ID Client Identifier of your app for Sage
Client Secret Client Secret of your app for Sage

Actions

Create Data Asset {#createdataassets}

Save a new data asset.

Input Comments Default
Connection
App ID The ID of the app you would like to retrieve.
App Type Type of the application
Technical Name Technical name of the application
Data Asset The data asset to create or update. {
"name": "string",
"tags": [],
"appId": "string",
"ownerId": "string",
"spaceId": "string",
"version": 0,
"tenantId": "string",
"createdBy": "string",
"properties": {},
"createdTime": "2023-10-12T17:32:07.820Z",
"description": "string",
"dataStoreInfo": {
"id": "string",
"name": "string",
"type": "string"
},
"lastModifiedBy": "string",
"lastModifiedTime": "2023-10-12T17:32:07.820Z",
"technicalDescription": "string"
}

Create Data Store {#createdatastore}

Save a new data store.

Input Comments Default
Connection
URI The uri for the data store.
Type The Type for the data store.
Technical Name Technical name of the data store
Data Store The data store to create or update. {
"name": "string",
"tags": [],
"ownerId": "string",
"spaceId": "string",
"version": 0,
"tenantId": "string",
"createdBy": "string",
"properties": {},
"createdTime": "2023-10-12T19:55:20.881Z",
"description": "string",
"lastModifiedBy": "string",
"lastModifiedTime": "2023-10-12T19:55:20.881Z",
"technicalDescription": "string"
}

Create New Data Set {#createdataset}

Save new data set.

Input Comments Default
Connection
QRI 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.
Technical Name Technical name of the application
Secure QRI Secure QRI of the application
Data Set The data set to create or update. {
"tags": [],
"type": "string",
"name": "string",
"schema": {
"anomalies": [],
"dataFields": [
{
"name": "string",
"tags": [],
"alias": "string",
"index": 0,
"orphan": true,
"dataType": {
"type": "DATE",
"properties": {},
"originalType": "string"
},
"nullable": true,
"userTags": [
{
"id": "string",
"name": "string"
}
],
"encrypted": true,
"sensitive": true,
"primaryKey": true,
"properties": {},
"description": "string",
"ordinalPositionInKey": 0
}
],
"schemaName": "string",
"loadOptions": {},
"effectiveDate": "2023-10-11T22:12:27.408Z",
"overrideSchemaAnomalies": true
},
"ownerId": "string",
"spaceId": "string",
"version": 0,
"tenantId": "string",
"createdBy": "string",
"properties": {},
"createdTime": "2023-10-11T22:12:27.408Z",
"description": "string",
"operational": {
"size": 0,
"status": "string",
"endDate": "2023-10-11T22:12:27.408Z",
"location": "string",
"rowCount": 0,
"startDate": "2023-10-11T22:12:27.408Z",
"logMessage": "string",
"tableOwner": "string",
"lastLoadTime": "2023-10-11T22:12:27.408Z",
"contentUpdated": true,
"lastUpdateTime": "2023-10-11T22:12:27.408Z",
"tableConnectionInfo": {
"tableName": "string",
"selectionScript": "string",
"additionalProperties": {}
}
},
"dataAssetInfo": {
"id": "string",
"name": "string",
"dataStoreInfo": {
"id": "string",
"name": "string",
"type": "string"
}
},
"lastModifiedBy": "string",
"classifications": {
"subjectArea": "string",
"personalInformation": [
{
"fieldName": "string",
"tableName": "string",
"fieldAlias": "string"
}
],
"sensitiveInformation": [
{
"fieldName": "string",
"tableName": "string",
"fieldAlias": "string"
}
]
},
"lastModifiedTime": "2023-10-11T22:12:27.408Z",
"additionalSchemas": [
{
"anomalies": [],
"dataFields": [
{
"name": "string",
"tags": [],
"alias": "string",
"index": 0,
"orphan": true,
"dataType": {
"type": "DATE",
"properties": {},
"originalType": "string"
},
"nullable": true,
"userTags": [
{
"id": "string",
"name": "string"
}
],
"encrypted": true,
"sensitive": true,
"primaryKey": true,
"properties": {},
"description": "string",
"ordinalPositionInKey": 0
}
],
"schemaName": "string",
"loadOptions": {},
"effectiveDate": "2023-10-11T22:12:27.408Z",
"overrideSchemaAnomalies": true
}
],
"technicalDescription": "string"
}

Create Report {#createreport}

Request a new report generation.

Input Comments Default
Connection
Report The report data to create. {
"type": "composition-1.0",
"output": {
"type": "pdfcomposition",
"outputId": "composition1",
"pdfCompositionOutput": {
"pdfOutputs": [
{
"size": "A4",
"align": {
"vertical": "middle",
"horizontal": "center"
},
"resizeType": "autofit",
"orientation": "A"
},
{
"size": "A4",
"align": {
"vertical": "middle",
"horizontal": "center"
},
"resizeType": "autofit",
"orientation": "A"
}
]
}
},
"definitions": {
"selectionsByState": {
"sel1": {
"$": [
{
"values": [
{
"text": "Arizona",
"isNumeric": false
}
],
"fieldName": "Region",
"defaultIsNumeric": false
}
]
}
}
},
"compositionTemplates": [
{
"type": "sense-sheet-1.0",
"senseSheetTemplate": {
"appId": "2451e58e-a1b9-4047-abf6-315e91d8a610",
"sheet": {
"id": "5ffe3801-1b6d-439d-a849-84d0748358f1"
},
"selectionsByStateDef": "sel1"
}
},
{
"type": "sense-sheet-1.0",
"senseSheetTemplate": {
"appId": "2451e58e-a1b9-4047-abf6-315e91d8a610",
"sheet": {
"id": "ffrxJyA"
},
"selectionsByStateDef": "sel1"
}
}
]
}

Create Space {#createspace}

Creates a space.

Input Comments Default
Connection
Space Name The name of the space.
Space Description The description of the space. Personal spaces do not have a description.
Type The type of space such as shared, managed, and so on. shared

Delete App {#deleteapp}

Deletes a specific app.

Input Comments Default
Connection
App ID The ID of the app you would like to retrieve.

Delete Data Assets {#deletedataassets}

Batch delete data assets by IDs.

Input Comments Default
Connection
Data Asset IDs The IDs of the data assets you would like to delete.

Delete Data File {#deletedatafile}

Deletes a specific Data File.

Input Comments Default
Connection
Data File ID The id of the data file you would like to retrieve.

Delete Data Set {#deletedataset}

Delete data set by ID.

Input Comments Default
Connection
Data Set IDs The IDs of the data sets you would like to delete.

Delete Data Stores {#deletedatastores}

Batch delete data stores by IDs.

Input Comments Default
Connection
Data Store IDs The IDs of the data stores you would like to delete.

Delete Data Stores Assets {#deletedatastoresassets}

Batch delete data stores by IDs.

Input Comments Default
Connection
Data Store IDs The IDs of the data stores you would like to delete.
Data Asset IDs The IDs of the data assets you would like to delete.

Delete Space {#deletespace}

Deletes a space by ID.

Input Comments Default
Connection
Space ID The ID of the space you would like to delete.

Get App {#getapp}

Retrieves information for a specific app.

Input Comments Default
Connection
App ID The ID of the app you would like to retrieve.

Get Data Asset {#getdataassets}

Get data asset by ID.

Input Comments Default
Connection
Data Assets ID The ID of the data set you would like to retrieve.
Projections Fields name to return in the response.

Get Data File {#getdatafile}

Get descriptive info for the specified data file.

Input Comments Default
Connection
Data File ID The id of the data file you would like to retrieve.

Get Data Set {#getdataset}

Get data set by ID.

Input Comments Default
Connection
Data Set ID The ID of the data set you would like to retrieve.
Projections Fields name to return in the response.

Get Data Store {#getdatastore}

Get data store by ID.

Input Comments Default
Connection
Data Store ID The ID of the data store you would like to retrieve.

Get My User {#getmyuser}

Redirects to retrieve the user resource associated with the JWT claims.

Input Comments Default
Connection

Get Report Request Status {#getreportrequeststatus}

Get report request processing status.

Input Comments Default
Connection
Report ID The ID of the report you would like to retrieve.

Get Space {#getspace}

Retrieves a single space by ID.

Input Comments Default
Connection
Space ID The ID of the space you would like to retrieve.

List Data Files {#listdatafiles}

Get all data files.

Input Comments Default
Connection
Limit If present, the maximum number of data files to return. 20
Page If present, the cursor that starts the page of data that is returned.
Query Params A list of params to send with the request.

List Data Stores {#listdatastores}

Get all data stores.

Input Comments Default
Connection
Limit If present, the maximum number of data files to return. 20
Page If present, the cursor that starts the page of data that is returned.
Projections Fields name to return in the response.
Sort Comma-separated fields and field start with '-' character sorts the result set in descending order.

List Spaces {#listspaces}

Get all Spaces.

Input Comments Default
Connection
Limit If present, the maximum number of data files to return. 20
Sort Comma-separated fields and field start with '-' character sorts the result set in descending order.
Query Params A list of params to send with the request.

List Users {#listusers}

Get all Users.

Input Comments Default
Connection
Limit If present, the maximum number of data files to return. 20
Sort Comma-separated fields and field start with '-' character sorts the result set in descending order.
Query Params A list of params to send with the request.

Raw Request {#rawrequest}

Send raw HTTP request to Qlik

Input Comments Default
Connection
URL Input the path only (/employees), The base URL is already included (https://{tenant}.us.qlikcloud.com/api/v1). For example, to connect to https://{tenant}.us.qlikcloud.com/api/v1/employees, only /employees is entered in this field.
Method The HTTP method to use.
Data The HTTP body payload to send to the URL.
Form Data The Form Data to be sent as a multipart form upload.
File Data File Data to be sent as a multipart form upload.
File Data File Names File names to apply to the file data inputs. Keys must match the file data keys above.
Query Parameter A list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2.
Header A list of headers to send with the request.
Response Type The type of data you expect in the response. You can request json, text, or binary data. json
Timeout The maximum time that a client will await a response to its request
Debug Request Enabling this flag will log out the current request. false
Retry Delay (ms) The delay in milliseconds between retries. 0
Retry On All Errors If true, retries on all erroneous responses regardless of type. false
Max Retry Count The maximum number of retries to attempt. 0
Use Exponential Backoff Specifies whether to use a pre-defined exponential backoff strategy for retries. false

Update Data Asset {#updatedataassets}

Update data asset by ID.

Input Comments Default
Connection
Data Assets ID The ID of the data set you would like to retrieve.
App ID The ID of the app you would like to retrieve.
App Type Type of the application
Technical Name Technical name of the application
Data Asset The data asset to create or update. {
"name": "string",
"tags": [],
"appId": "string",
"ownerId": "string",
"spaceId": "string",
"version": 0,
"tenantId": "string",
"createdBy": "string",
"properties": {},
"createdTime": "2023-10-12T17:32:07.820Z",
"description": "string",
"dataStoreInfo": {
"id": "string",
"name": "string",
"type": "string"
},
"lastModifiedBy": "string",
"lastModifiedTime": "2023-10-12T17:32:07.820Z",
"technicalDescription": "string"
}

Update Data Set {#updatedataset}

Update data set by ID.

Input Comments Default
Connection
Data Set ID The ID of the data set you would like to retrieve.
QRI 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.
Technical Name Technical name of the application
Secure QRI Secure QRI of the application
Data Set The data set to create or update. {
"tags": [],
"type": "string",
"name": "string",
"schema": {
"anomalies": [],
"dataFields": [
{
"name": "string",
"tags": [],
"alias": "string",
"index": 0,
"orphan": true,
"dataType": {
"type": "DATE",
"properties": {},
"originalType": "string"
},
"nullable": true,
"userTags": [
{
"id": "string",
"name": "string"
}
],
"encrypted": true,
"sensitive": true,
"primaryKey": true,
"properties": {},
"description": "string",
"ordinalPositionInKey": 0
}
],
"schemaName": "string",
"loadOptions": {},
"effectiveDate": "2023-10-11T22:12:27.408Z",
"overrideSchemaAnomalies": true
},
"ownerId": "string",
"spaceId": "string",
"version": 0,
"tenantId": "string",
"createdBy": "string",
"properties": {},
"createdTime": "2023-10-11T22:12:27.408Z",
"description": "string",
"operational": {
"size": 0,
"status": "string",
"endDate": "2023-10-11T22:12:27.408Z",
"location": "string",
"rowCount": 0,
"startDate": "2023-10-11T22:12:27.408Z",
"logMessage": "string",
"tableOwner": "string",
"lastLoadTime": "2023-10-11T22:12:27.408Z",
"contentUpdated": true,
"lastUpdateTime": "2023-10-11T22:12:27.408Z",
"tableConnectionInfo": {
"tableName": "string",
"selectionScript": "string",
"additionalProperties": {}
}
},
"dataAssetInfo": {
"id": "string",
"name": "string",
"dataStoreInfo": {
"id": "string",
"name": "string",
"type": "string"
}
},
"lastModifiedBy": "string",
"classifications": {
"subjectArea": "string",
"personalInformation": [
{
"fieldName": "string",
"tableName": "string",
"fieldAlias": "string"
}
],
"sensitiveInformation": [
{
"fieldName": "string",
"tableName": "string",
"fieldAlias": "string"
}
]
},
"lastModifiedTime": "2023-10-11T22:12:27.408Z",
"additionalSchemas": [
{
"anomalies": [],
"dataFields": [
{
"name": "string",
"tags": [],
"alias": "string",
"index": 0,
"orphan": true,
"dataType": {
"type": "DATE",
"properties": {},
"originalType": "string"
},
"nullable": true,
"userTags": [
{
"id": "string",
"name": "string"
}
],
"encrypted": true,
"sensitive": true,
"primaryKey": true,
"properties": {},
"description": "string",
"ordinalPositionInKey": 0
}
],
"schemaName": "string",
"loadOptions": {},
"effectiveDate": "2023-10-11T22:12:27.408Z",
"overrideSchemaAnomalies": true
}
],
"technicalDescription": "string"
}

Update Data Store {#updatedatastore}

Updates the information for a specific Data Store.

Input Comments Default
Connection
Data Store ID The ID of the data store you would like to retrieve.
URI The uri for the data store.
Type The Type for the data store.
Technical Name Technical name of the data store
Data Store The data store to create or update. {
"name": "string",
"tags": [],
"ownerId": "string",
"spaceId": "string",
"version": 0,
"tenantId": "string",
"createdBy": "string",
"properties": {},
"createdTime": "2023-10-12T19:55:20.881Z",
"description": "string",
"lastModifiedBy": "string",
"lastModifiedTime": "2023-10-12T19:55:20.881Z",
"technicalDescription": "string"
}

Updates Space {#updatespace}

Updates a space.

Input Comments Default
Connection
Space ID The ID of the space you would like to retrieve.
Owner ID The user ID of the space owner.
Attribute Name The name of the space.
Attribute Description The description of the space. Personal spaces do not have a description.