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:

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

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

Generate API Keys:

Navigate to Management Console > API Keys and select ‘Generate new key’
provide a description and expiration and Save.
Once the key is generated enter the value in to the connection configuration of your Prismatic integration.

Input	Notes	Example
API Key password / Required apiKey	API Key for your Qlik User
Tenant string / Required 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:

Login to Qlik and Navigate to Management Console > OAuth and select ‘Create New’
Set ‘Web’ as the Client type and name the connection
Enter https://oauth2.prismatic.io/callback to the ‘Add redirect URLs” field and select Add
Select ‘Create’ Qlik will generate the client ID and client secret.
Transfer these values to the connection configuration of your Prismatic integration.

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

Actions

Create Data Asset

Save a new data asset. | key: createDataAssets

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

Create Data Store

Save a new data store. | key: createDataStore

Input	Notes	Example
Connection connection / Required connection
Data Store code dataStoreInput	The data store to create or update.
Technical Name string / Required technicalName	Technical name of the data store	Some technical name
Type string / Required type	The Type for the data store.	some-type
URI string / Required 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 connection / Required connection
Data Set code dataSetInput	The data set to create or update.
QRI string / Required 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 string / Required secureQri	Secure QRI of the application	Some secure QRI
Technical Name string / Required technicalName	Technical name of the application	Some technical name

Create Report

Request a new report generation. | key: createReport

Input	Default	Notes
Connection connection / Required connection
Report code reportInput		The report data to create.

Create Space

Creates a space. | key: createSpace

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

Delete App

Deletes a specific app. | key: deleteApp

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

Delete Data Assets

Batch delete data assets by IDs. | key: deleteDataAssets

Input	Notes
Connection connection / Required connection
Data Asset IDs string Value List dataSetIds	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 connection / Required connection
Data File ID string / Required dataFileId	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
Connection connection / Required connection
Data Set IDs string Value List dataSetIds	The IDs of the data sets you would like to delete.

Delete Data Stores

Batch delete data stores by IDs. | key: deleteDataStores

Input	Notes
Connection connection / Required connection
Data Store IDs string Value List dataStoreIds	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
Connection connection / Required connection
Data Asset IDs string Value List dataAssetsIds	The IDs of the data assets you would like to delete.
Data Store IDs string Value List dataStoreIds	The IDs of the data stores you would like to delete.

Delete Space

Deletes a space by ID. | key: deleteSpace

Input	Notes	Example
Connection connection / Required connection
Space ID string / Required spaceId	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 string / Required appId	The ID of the app you would like to retrieve.	f5ceaff0-faa1-41c4-a479-03ff004839dc
Connection connection / Required connection

Get Data Asset

Get data asset by ID. | key: getDataAssets

Input	Notes	Example
Connection connection / Required connection
Data Assets ID string / Required dataAssetsId	The ID of the data set you would like to retrieve.	f5ceaff0-faa1-41c4-a479-03ff004839dc
Projections string Value List 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 connection / Required connection
Data File ID string / Required dataFileId	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 connection / Required connection
Data Set ID string / Required dataSetId	The ID of the data set you would like to retrieve.	f5ceaff0-faa1-41c4-a479-03ff004839dc
Projections string Value List projections	Fields name to return in the response.

Get Data Store

Get data store by ID. | key: getDataStore

Input	Notes	Example
Connection connection / Required connection
Data Store ID string / Required dataStoreId	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
Connection connection / Required connection

Get Report Request Status

Get report request processing status. | key: getReportRequestStatus

Input	Notes	Example
Connection connection / Required connection
Report ID string / Required reportId	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 connection / Required connection
Space ID string / Required spaceId	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	Default	Notes	Example
Connection connection / Required connection
Limit string limit	20	If present, the maximum number of data files to return.	20
Page string page		If present, the cursor that starts the page of data that is returned.	asdasl123posidcs
Query Params string Key Value List paramsInputFields		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	Default	Notes	Example
Connection connection / Required connection
Limit string limit	20	If present, the maximum number of data files to return.	20
Page string page		If present, the cursor that starts the page of data that is returned.	asdasl123posidcs
Projections string Value List projections		Fields name to return in the response.
Sort string Value List 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	Default	Notes	Example
Connection connection / Required connection
Limit string limit	20	If present, the maximum number of data files to return.	20
Query Params string Key Value List paramsInputFields		A list of params to send with the request.	appId=f5ceaff0-faa1-41c4-a479-03ff004839dc
Sort string Value List 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	Default	Notes	Example
Connection connection / Required connection
Limit string limit	20	If present, the maximum number of data files to return.	20
Query Params string Key Value List paramsInputFields		A list of params to send with the request.	appId=f5ceaff0-faa1-41c4-a479-03ff004839dc
Sort string Value List 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	Default	Notes	Example
Connection connection / Required connection
Data string data		The HTTP body payload to send to the URL.	{"exampleKey": "Example Data"}
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
File Data string Key Value List fileData		File Data to be sent as a multipart form upload.	[{key: "example.txt", value: "My File Contents"}]
File Data File Names string Key Value List fileDataFileNames		File names to apply to the file data inputs. Keys must match the file data keys above.
Form Data string Key Value List formData		The Form Data to be sent as a multipart form upload.	[{"key": "Example Key", "value": new Buffer("Hello World")}]
Header string Key Value List headers		A list of headers to send with the request.	User-Agent: curl/7.64.1
Max Retry Count string maxRetries	0	The maximum number of retries to attempt.
Method string / Required method		The HTTP method to use.
Query Parameter string Key Value List queryParams		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 string / Required responseType	json	The type of data you expect in the response. You can request json, text, or binary data.
Retry On All Errors boolean retryAllErrors	false	If true, retries on all erroneous responses regardless of type.
Retry Delay (ms) string retryDelayMS	0	The delay in milliseconds between retries.
Timeout string timeout		The maximum time that a client will await a response to its request	2000
URL string / Required 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 boolean useExponentialBackoff	false	Specifies whether to use a pre-defined exponential backoff strategy for retries.

Update Data Asset

Update data asset by ID. | key: updateDataAssets

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

Update Data Set

Update data set by ID. | key: updateDataset

Input	Notes	Example
Connection connection / Required connection
Data Set ID string / Required dataSetId	The ID of the data set you would like to retrieve.	f5ceaff0-faa1-41c4-a479-03ff004839dc
Data Set code dataSetInput	The data set to create or update.
QRI string / Required 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 string / Required secureQri	Secure QRI of the application	Some secure QRI
Technical Name string / Required technicalName	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 connection / Required connection
Data Store ID string / Required dataStoreId	The ID of the data store you would like to retrieve.	edaeaff0-faa1-41c4-a479-03ff004839dc
Data Store code dataStoreInput	The data store to create or update.
Technical Name string / Required technicalName	Technical name of the data store	Some technical name
Type string / Required type	The Type for the data store.	some-type
URI string / Required uri	The uri for the data store.	https://some-uri.com

Updates Space

Updates a space. | key: updateSpace

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

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

Description​

Connections​

API Key​

OAuth 2.0​

Actions​

Create Data Asset​

Create Data Store​

Create New Data Set​

Create Report​

Create Space​

Delete App​

Delete Data Assets​

Delete Data File​

Delete Data Set​

Delete Data Stores​

Delete Data Stores Assets​

Delete Space​

Get App​

Get Data Asset​

Get Data File​

Get Data Set​

Get Data Store​

Get My User​

Get Report Request Status​

Get Space​

List Data Files​

List Data Stores​

List Spaces​

List Users​

Raw Request​

Update Data Asset​

Update Data Set​

Update Data Store​

Updates Space​

Description

Connections

API Key

OAuth 2.0

Actions

Create Data Asset

Create Data Store

Create New Data Set

Create Report

Create Space

Delete App

Delete Data Assets

Delete Data File

Delete Data Set

Delete Data Stores

Delete Data Stores Assets

Delete Space

Get App

Get Data Asset

Get Data File

Get Data Set

Get Data Store

Get My User

Get Report Request Status

Get Space

List Data Files

List Data Stores

List Spaces

List Users

Raw Request

Update Data Asset

Update Data Set

Update Data Store

Updates Space