Qlik Component

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

Component key: qlik

Description

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

Connections

API Key

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	Notes	Example
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	v34wwyjhxohtob1

OAuth 2.0

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.prismatic.io/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.

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

Actions

Create Data Asset

Save a new data asset. | key: createDataAssets

Input	Notes	Example
App ID	The ID of the app you would like to retrieve.	f5ceaff0-faa1-41c4-a479-03ff004839dc
App Type	Type of the application	An App Type
Connection
Data Asset	The data asset to create or update.
Technical Name	Technical name of the application	Some technical name

---

Create Data Store

Save a new data store. | key: createDataStore

Input	Notes	Example
Connection
Data Store	The data store to create or update.
Technical Name	Technical name of the data store	Some technical name
Type	The Type for the data store.	some-type
URI	The uri for the data store.	https://some-uri.com

---

Create New Data Set

Save new data set. | key: createDataset

Input	Notes	Example
Connection
Data Set	The data set to create or update.
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.	string<qdf:<store-type>:<tenant-guid>:<<uid@/sid@>user/space guid>:<path-to-file>>
Secure QRI	Secure QRI of the application	Some secure QRI
Technical Name	Technical name of the application	Some technical name

---

Create Report

Request a new report generation. | key: createReport

Input	Notes	Example
Connection
Report	The report data to create.

---

Create Space

Creates a space. | key: createSpace

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

---

Delete App

Deletes a specific app. | key: deleteApp

Input	Notes	Example
App ID	The ID of the app you would like to retrieve.	f5ceaff0-faa1-41c4-a479-03ff004839dc
Connection

---

Delete Data Assets

Batch delete data assets by IDs. | key: deleteDataAssets

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

---

Delete Data File

Deletes a specific Data File. | key: deleteDataFile

Input	Notes	Example
Connection
Data File ID	The id of the data file you would like to retrieve.	f5ceaff0-faa1-41c4-a479-03ff004839dc

---

Delete Data Set

Delete data set by ID. | key: deleteDataset

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

---

Delete Data Stores

Batch delete data stores by IDs. | key: deleteDataStores

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

---

Delete Data Stores Assets

Batch delete data stores by IDs. | key: deleteDataStoresAssets

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

---

Delete Space

Deletes a space by ID. | key: deleteSpace

Input	Notes	Example
Connection
Space ID	The ID of the space you would like to delete.	f5ceaff0-faa1-41c4-a479-03ff004839dc

---

Get App

Retrieves information for a specific app. | key: getApp

Input	Notes	Example
App ID	The ID of the app you would like to retrieve.	f5ceaff0-faa1-41c4-a479-03ff004839dc
Connection

---

Get Data Asset

Get data asset by ID. | key: getDataAssets

Input	Notes	Example
Connection
Data Assets ID	The ID of the data set you would like to retrieve.	f5ceaff0-faa1-41c4-a479-03ff004839dc
Projections	Fields name to return in the response.

---

Get Data File

Get descriptive info for the specified data file. | key: getDataFile

Input	Notes	Example
Connection
Data File ID	The id of the data file you would like to retrieve.	f5ceaff0-faa1-41c4-a479-03ff004839dc

---

Get Data Set

Get data set by ID. | key: getDataset

Input	Notes	Example
Connection
Data Set ID	The ID of the data set you would like to retrieve.	f5ceaff0-faa1-41c4-a479-03ff004839dc
Projections	Fields name to return in the response.

---

Get Data Store

Get data store by ID. | key: getDataStore

Input	Notes	Example
Connection
Data Store ID	The ID of the data store you would like to retrieve.	edaeaff0-faa1-41c4-a479-03ff004839dc

---

Get My User

Redirects to retrieve the user resource associated with the JWT claims. | key: getMyUser

Input	Notes	Example
Connection

---

Get Report Request Status

Get report request processing status. | key: getReportRequestStatus

Input	Notes	Example
Connection
Report ID	The ID of the report you would like to retrieve.	f5ceaff0-faa1-41c4-a479-03ff004839dc

---

Get Space

Retrieves a single space by ID. | key: getSpace

Input	Notes	Example
Connection
Space ID	The ID of the space you would like to retrieve.	f5ceaff0-faa1-41c4-a479-03ff004839dc

---

List Data Files

Get all data files. | key: listDatafiles

Input	Notes	Example
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.	asdasl123posidcs
Query Params	A list of params to send with the request.	appId=f5ceaff0-faa1-41c4-a479-03ff004839dc

---

List Data Stores

Get all data stores. | key: listDataStores

Input	Notes	Example
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.	asdasl123posidcs
Projections	Fields name to return in the response.
Sort	Comma-separated fields and field start with '-' character sorts the result set in descending order.	name,-createdTime

---

List Spaces

Get all Spaces. | key: listSpaces

Input	Notes	Example
Connection
Limit	If present, the maximum number of data files to return.	20
Query Params	A list of params to send with the request.	appId=f5ceaff0-faa1-41c4-a479-03ff004839dc
Sort	Comma-separated fields and field start with '-' character sorts the result set in descending order.	name,-createdTime

---

List Users

Get all Users. | key: listUsers

Input	Notes	Example
Connection
Limit	If present, the maximum number of data files to return.	20
Query Params	A list of params to send with the request.	appId=f5ceaff0-faa1-41c4-a479-03ff004839dc
Sort	Comma-separated fields and field start with '-' character sorts the result set in descending order.	name,-createdTime

---

Raw Request

Send raw HTTP request to Qlik | key: rawRequest

Input	Notes	Example
Connection
Data	The HTTP body payload to send to the URL.	{"exampleKey": "Example Data"}
Debug Request	Enabling this flag will log out the current request.	false
File Data	File Data to be sent as a multipart form upload.	[{key: "example.txt", value: "My File Contents"}]
File Data File Names	File names to apply to the file data inputs. Keys must match the file data keys above.
Form Data	The Form Data to be sent as a multipart form upload.	[{"key": "Example Key", "value": new Buffer("Hello World")}]
Header	A list of headers to send with the request.	User-Agent: curl/7.64.1
Max Retry Count	The maximum number of retries to attempt.	0
Method	The HTTP method to use.
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.
Response Type	The type of data you expect in the response. You can request json, text, or binary data.	json
Retry On All Errors	If true, retries on all erroneous responses regardless of type.	false
Retry Delay (ms)	The delay in milliseconds between retries.	0
Timeout	The maximum time that a client will await a response to its request	2000
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.	/employees
Use Exponential Backoff	Specifies whether to use a pre-defined exponential backoff strategy for retries.	false

---

Update Data Asset

Update data asset by ID. | key: updateDataAssets

Input	Notes	Example
App ID	The ID of the app you would like to retrieve.	f5ceaff0-faa1-41c4-a479-03ff004839dc
App Type	Type of the application	An App Type
Connection
Data Asset	The data asset to create or update.
Data Assets ID	The ID of the data set you would like to retrieve.	f5ceaff0-faa1-41c4-a479-03ff004839dc
Technical Name	Technical name of the application	Some technical name

---

Update Data Set

Update data set by ID. | key: updateDataset

Input	Notes	Example
Connection
Data Set ID	The ID of the data set you would like to retrieve.	f5ceaff0-faa1-41c4-a479-03ff004839dc
Data Set	The data set to create or update.
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.	string<qdf:<store-type>:<tenant-guid>:<<uid@/sid@>user/space guid>:<path-to-file>>
Secure QRI	Secure QRI of the application	Some secure QRI
Technical Name	Technical name of the application	Some technical name

---

Update Data Store

Updates the information for a specific Data Store. | key: updateDataStore

Input	Notes	Example
Connection
Data Store ID	The ID of the data store you would like to retrieve.	edaeaff0-faa1-41c4-a479-03ff004839dc
Data Store	The data store to create or update.
Technical Name	Technical name of the data store	Some technical name
Type	The Type for the data store.	some-type
URI	The uri for the data store.	https://some-uri.com

---

Updates Space

Updates a space. | key: updateSpace

Input	Notes	Example
Connection
Attribute Description	The description of the space. Personal spaces do not have a description.	An attribute description.
Attribute Name	The name of the space.	An attribute name.
Owner ID	The user ID of the space owner.	f5ceaff0-faa1-41c4-a479-03ff004839dc
Space ID	The ID of the space you would like to retrieve.	f5ceaff0-faa1-41c4-a479-03ff004839dc

---