Apps
Apps are a core part of Qlik Cloud Analytics, and represent either an Analytics app (Qlik Sense or QlikView application) or a script (headless Qlik Sense application).
Endpoints
- POST/v1/apps
- GET/v1/apps/{appId}
- PUT/v1/apps/{appId}
- DELETE/v1/apps/{appId}
- POST/v1/apps/{appId}/copy
- GET/v1/apps/{appId}/data/lineage
- GET/v1/apps/{appId}/data/metadata
- POST/v1/apps/{appId}/export
- GET/v1/apps/{appId}/insight-analyses
- POST/v1/apps/{appId}/insight-analyses/actions/recommend
- GET/v1/apps/{appId}/insight-analyses/model
- GET/v1/apps/{appId}/media/files/{path}
- PUT/v1/apps/{appId}/media/files/{path}
- DELETE/v1/apps/{appId}/media/files/{path}
- GET/v1/apps/{appId}/media/list/{path}
- GET/v1/apps/{appId}/media/thumbnail
- POST/v1/apps/{appId}/objects/{objectId}/actions/change-owner
- PUT/v1/apps/{appId}/owner
- POST/v1/apps/{appId}/publish
- PUT/v1/apps/{appId}/publish
- GET/v1/apps/{appId}/reloads/logs
- GET/v1/apps/{appId}/reloads/logs/{reloadId}
- GET/v1/apps/{appId}/reloads/metadata/{reloadId}
- GET/v1/apps/{appId}/report-filters
- POST/v1/apps/{appId}/report-filters
- GET/v1/apps/{appId}/report-filters/{id}
- PATCH/v1/apps/{appId}/report-filters/{id}
- DELETE/v1/apps/{appId}/report-filters/{id}
- GET/v1/apps/{appId}/report-filters/actions/count
- GET/v1/apps/{appId}/scripts
- POST/v1/apps/{appId}/scripts
- GET/v1/apps/{appId}/scripts/{id}
- PATCH/v1/apps/{appId}/scripts/{id}
- DELETE/v1/apps/{appId}/scripts/{id}
- PUT/v1/apps/{appId}/space
- DELETE/v1/apps/{appId}/space
- GET/v1/apps/{guid}/evaluations
- POST/v1/apps/{guid}/evaluations
- GET/v1/apps/evaluations/{baseid}/actions/compare/{comparisonid}
- GET/v1/apps/evaluations/{baseid}/actions/compare/{comparisonid}/actions/download
- GET/v1/apps/evaluations/{id}
- GET/v1/apps/evaluations/{id}/actions/download
- POST/v1/apps/import
- GET/v1/apps/privileges
Creates a new app.
Facts
Rate limit | Tier 2 (100 requests per minute) |
Categories | managebuild |
Request Body
Required*/*
Attributes that the user wants to set in new app.
- */*object
*/* properties
- attributesobject
attributes properties
- namestring
The name (title) of the application
- usagestring
Can be one of: "ANALYTICS""DATA_PREPARATION""DATAFLOW_PREP""SINGLE_TABLE_PREP"
- localestring
Set custom locale instead of the system default
- spaceIdstring
The space ID of the application
- descriptionstring
The description of the application
-
-
Responses
200
application/json
OK
Application attributes and user privileges.
- application/jsonobject
Application attributes and user privileges.
application/json properties
- createarray of objects
Object create privileges. Hints to the client what type of objects the user is allowed to create.
create properties
- resourcestring
Type of resource. For example, sheet, story, bookmark, etc.
- canCreateboolean
Is set to true if the user has privileges to create the resource.
-
- attributesobject
App attributes. This structure can also contain extra user-defined attributes.
attributes properties
- idstring
The App ID.
- namestring
App name.
- ownerstringDeprecated
Deprecated. Use the Users API to fetch user metadata.
- usagestring
Can be one of: "ANALYTICS""DATA_PREPARATION""DATAFLOW_PREP""SINGLE_TABLE_PREP"
- customobject
Contains dynamic JSON data specified by the client.
- ownerIdstring
Identifier of the app owner.
- encryptedboolean
If set to true, the app is encrypted.
- publishedboolean
True if the app is published on-prem, distributed in QCS, false if not.
- thumbnailstring
App thumbnail.
- createdDatestring
The date and time when the app was created.
- descriptionstring
App description.
- originAppIdstring
The Origin App ID for published apps.
- publishTimestring
The date and time when the app was published, empty if unpublished.
- dynamicColorstring
The dynamic color of the app.
- modifiedDatestring
The date and time when the app was modified.
- lastReloadTimestring
Date and time of the last reload of the app.
- hasSectionAccessboolean
If set to true, the app has section access configured,
- isDirectQueryModeboolean
True if the app is a Direct Query app, false if not
-
- privilegesarray of strings
Application privileges. Hints to the client what actions the user is allowed to perform. Could be any of:
- read
- create
- update
- delete
- reload
- import
- publish
- duplicate
- export
- exportdata
- change_owner
- change_space
-
curl "https://your-tenant.us.qlikcloud.com/api/v1/apps" \
-X POST \
-H "Content-type: */*" \
-H "Authorization: Bearer <API-key>" \
-d '{"attributes":{"name":"string","locale":"string","spaceId":"string","description":"string"}}'
const https = require('https')
const data = JSON.stringify({"attributes":{"name":"string","locale":"string","spaceId":"string","description":"string"}})
const options = {
'hostname': 'https://your-tenant.us.qlikcloud.com',
'port': 443,
'path': '/api/v1/apps',
'method': 'POST',
'headers': {
'Content-type': '*/*',
'Authorization': 'Bearer <API-key>'
}
}
const req = https.request(options)
req.write(data)
qlik app create \
--attributes-description="string" \
--attributes-locale="string" \
--attributes-name="string" \
--attributes-spaceId="string"
Request
{
"attributes": {
"name": "string",
"locale": "string",
"spaceId": "string",
"description": "string"
}
}
Response
{
"create": [
{
"resource": "string",
"canCreate": true
}
],
"attributes": {
"id": "string",
"name": "string",
"owner": "string",
"custom": {},
"ownerId": "string",
"encrypted": true,
"published": true,
"thumbnail": "string",
"createdDate": "2018-10-30T07:06:22Z",
"description": "string",
"originAppId": "string",
"publishTime": "2018-10-30T07:06:22Z",
"dynamicColor": "string",
"modifiedDate": "2018-10-30T07:06:22Z",
"lastReloadTime": "2018-10-30T07:06:22Z",
"hasSectionAccess": true,
"isDirectQueryMode": true
},
"privileges": [
"string"
]
}
Retrieves information for a specific app.
Facts
Rate limit | Tier 1 (1000 requests per minute) |
Categories | managebuild |
Path Parameters
- appIdstringRequired
Identifier of the app.
Responses
200
application/json
OK
Application attributes and user privileges.
- application/jsonobject
Application attributes and user privileges.
application/json properties
- createarray of objects
- attributesobject
App attributes. This structure can also contain extra user-defined attributes.
attributes properties
- idstring
The App ID.
- namestring
App name.
- ownerstringDeprecated
Deprecated. Use the Users API to fetch user metadata.
- usagestring
Can be one of: "ANALYTICS""DATA_PREPARATION""DATAFLOW_PREP""SINGLE_TABLE_PREP"
- customobject
Contains dynamic JSON data specified by the client.
- ownerIdstring
Identifier of the app owner.
- encryptedboolean
If set to true, the app is encrypted.
- publishedboolean
True if the app is published on-prem, distributed in QCS, false if not.
- thumbnailstring
App thumbnail.
- createdDatestring
The date and time when the app was created.
- descriptionstring
App description.
- originAppIdstring
The Origin App ID for published apps.
- publishTimestring
The date and time when the app was published, empty if unpublished.
- dynamicColorstring
The dynamic color of the app.
- modifiedDatestring
The date and time when the app was modified.
- lastReloadTimestring
Date and time of the last reload of the app.
- hasSectionAccessboolean
If set to true, the app has section access configured,
- isDirectQueryModeboolean
True if the app is a Direct Query app, false if not
-
- privilegesarray of strings
Application privileges. Hints to the client what actions the user is allowed to perform. Could be any of:
- read
- create
- update
- delete
- reload
- import
- publish
- duplicate
- export
- exportdata
- change_owner
- change_space
-
curl "https://your-tenant.us.qlikcloud.com/api/v1/apps/{appId}" \
-H "Authorization: Bearer <API-key>"
const https = require('https')
const data = JSON.stringify("")
const options = {
'hostname': 'https://your-tenant.us.qlikcloud.com',
'port': 443,
'path': '/api/v1/apps/{appId}',
'method': 'GET',
'headers': {
'Authorization': 'Bearer <API-key>'
}
}
const req = https.request(options)
qlik app get <appId>
Response
{
"create": [
{}
],
"attributes": {
"id": "string",
"name": "string",
"owner": "string",
"custom": {},
"ownerId": "string",
"encrypted": true,
"published": true,
"thumbnail": "string",
"createdDate": "2018-10-30T07:06:22Z",
"description": "string",
"originAppId": "string",
"publishTime": "2018-10-30T07:06:22Z",
"dynamicColor": "string",
"modifiedDate": "2018-10-30T07:06:22Z",
"lastReloadTime": "2018-10-30T07:06:22Z",
"hasSectionAccess": true,
"isDirectQueryMode": true
},
"privileges": [
"string"
]
}
Updates the information for a specific app.
Facts
Rate limit | Tier 2 (100 requests per minute) |
Categories | managebuild |
Path Parameters
- appIdstringRequired
Identifier of the app.
Request Body
Required*/*
Attributes that user wants to set.
- */*object
*/* properties
- attributesobject
attributes properties
- namestring
The name (title) of the application.
- descriptionstring
The description of the application.
-
-
Responses
200
application/json
OK
Application attributes and user privileges.
- application/jsonobject
Application attributes and user privileges.
application/json properties
- createarray of objects
- attributesobject
App attributes. This structure can also contain extra user-defined attributes.
attributes properties
- idstring
The App ID.
- namestring
App name.
- ownerstringDeprecated
Deprecated. Use the Users API to fetch user metadata.
- usagestring
Can be one of: "ANALYTICS""DATA_PREPARATION""DATAFLOW_PREP""SINGLE_TABLE_PREP"
- customobject
Contains dynamic JSON data specified by the client.
- ownerIdstring
Identifier of the app owner.
- encryptedboolean
If set to true, the app is encrypted.
- publishedboolean
True if the app is published on-prem, distributed in QCS, false if not.
- thumbnailstring
App thumbnail.
- createdDatestring
The date and time when the app was created.
- descriptionstring
App description.
- originAppIdstring
The Origin App ID for published apps.
- publishTimestring
The date and time when the app was published, empty if unpublished.
- dynamicColorstring
The dynamic color of the app.
- modifiedDatestring
The date and time when the app was modified.
- lastReloadTimestring
Date and time of the last reload of the app.
- hasSectionAccessboolean
If set to true, the app has section access configured,
- isDirectQueryModeboolean
True if the app is a Direct Query app, false if not
-
- privilegesarray of strings
Application privileges. Hints to the client what actions the user is allowed to perform. Could be any of:
- read
- create
- update
- delete
- reload
- import
- publish
- duplicate
- export
- exportdata
- change_owner
- change_space
-
curl "https://your-tenant.us.qlikcloud.com/api/v1/apps/{appId}" \
-X PUT \
-H "Content-type: */*" \
-H "Authorization: Bearer <API-key>" \
-d '{"attributes":{"name":"string","description":"string"}}'
const https = require('https')
const data = JSON.stringify({"attributes":{"name":"string","description":"string"}})
const options = {
'hostname': 'https://your-tenant.us.qlikcloud.com',
'port': 443,
'path': '/api/v1/apps/{appId}',
'method': 'PUT',
'headers': {
'Content-type': '*/*',
'Authorization': 'Bearer <API-key>'
}
}
const req = https.request(options)
req.write(data)
qlik app update <appId> \
--attributes-description="string" \
--attributes-name="string"
Request
{
"attributes": {
"name": "string",
"description": "string"
}
}
Response
{
"create": [
{}
],
"attributes": {
"id": "string",
"name": "string",
"owner": "string",
"custom": {},
"ownerId": "string",
"encrypted": true,
"published": true,
"thumbnail": "string",
"createdDate": "2018-10-30T07:06:22Z",
"description": "string",
"originAppId": "string",
"publishTime": "2018-10-30T07:06:22Z",
"dynamicColor": "string",
"modifiedDate": "2018-10-30T07:06:22Z",
"lastReloadTime": "2018-10-30T07:06:22Z",
"hasSectionAccess": true,
"isDirectQueryMode": true
},
"privileges": [
"string"
]
}
Deletes a specific app.
Facts
Rate limit | Tier 2 (100 requests per minute) |
Categories | managebuild |
Path Parameters
- appIdstringRequired
Identifier of the app.
Responses
200
OK
curl "https://your-tenant.us.qlikcloud.com/api/v1/apps/{appId}" \
-X DELETE \
-H "Authorization: Bearer <API-key>"
const https = require('https')
const data = JSON.stringify("")
const options = {
'hostname': 'https://your-tenant.us.qlikcloud.com',
'port': 443,
'path': '/api/v1/apps/{appId}',
'method': 'DELETE',
'headers': {
'Authorization': 'Bearer <API-key>'
}
}
const req = https.request(options)
qlik app rm <appId>
Copies a specific app.
Facts
Rate limit | Tier 2 (100 requests per minute) |
Categories | managebuild |
Path Parameters
- appIdstringRequired
Identifier of the app.
Request Body
Required*/*
Attributes that should be set in the copy.
- */*object
*/* properties
- attributesobject
attributes properties
- namestring
The name (title) of the application
- usagestring
Can be one of: "ANALYTICS""DATA_PREPARATION""DATAFLOW_PREP""SINGLE_TABLE_PREP"
- localestring
Set custom locale instead of the system default
- spaceIdstring
The space ID of the application
- descriptionstring
The description of the application
-
-
Responses
200
application/json
OK
Application attributes and user privileges.
- application/jsonobject
Application attributes and user privileges.
application/json properties
- createarray of objects
- attributesobject
App attributes. This structure can also contain extra user-defined attributes.
attributes properties
- idstring
The App ID.
- namestring
App name.
- ownerstringDeprecated
Deprecated. Use the Users API to fetch user metadata.
- usagestring
Can be one of: "ANALYTICS""DATA_PREPARATION""DATAFLOW_PREP""SINGLE_TABLE_PREP"
- customobject
Contains dynamic JSON data specified by the client.
- ownerIdstring
Identifier of the app owner.
- encryptedboolean
If set to true, the app is encrypted.
- publishedboolean
True if the app is published on-prem, distributed in QCS, false if not.
- thumbnailstring
App thumbnail.
- createdDatestring
The date and time when the app was created.
- descriptionstring
App description.
- originAppIdstring
The Origin App ID for published apps.
- publishTimestring
The date and time when the app was published, empty if unpublished.
- dynamicColorstring
The dynamic color of the app.
- modifiedDatestring
The date and time when the app was modified.
- lastReloadTimestring
Date and time of the last reload of the app.
- hasSectionAccessboolean
If set to true, the app has section access configured,
- isDirectQueryModeboolean
True if the app is a Direct Query app, false if not
-
- privilegesarray of strings
Application privileges. Hints to the client what actions the user is allowed to perform. Could be any of:
- read
- create
- update
- delete
- reload
- import
- publish
- duplicate
- export
- exportdata
- change_owner
- change_space
-
curl "https://your-tenant.us.qlikcloud.com/api/v1/apps/{appId}/copy" \
-X POST \
-H "Content-type: */*" \
-H "Authorization: Bearer <API-key>" \
-d '{"attributes":{"name":"string","locale":"string","spaceId":"string","description":"string"}}'
const https = require('https')
const data = JSON.stringify({"attributes":{"name":"string","locale":"string","spaceId":"string","description":"string"}})
const options = {
'hostname': 'https://your-tenant.us.qlikcloud.com',
'port': 443,
'path': '/api/v1/apps/{appId}/copy',
'method': 'POST',
'headers': {
'Content-type': '*/*',
'Authorization': 'Bearer <API-key>'
}
}
const req = https.request(options)
req.write(data)
qlik app copy <appId> \
--attributes-description="string" \
--attributes-locale="string" \
--attributes-name="string" \
--attributes-spaceId="string"
Request
{
"attributes": {
"name": "string",
"locale": "string",
"spaceId": "string",
"description": "string"
}
}
Response
{
"create": [
{}
],
"attributes": {
"id": "string",
"name": "string",
"owner": "string",
"custom": {},
"ownerId": "string",
"encrypted": true,
"published": true,
"thumbnail": "string",
"createdDate": "2018-10-30T07:06:22Z",
"description": "string",
"originAppId": "string",
"publishTime": "2018-10-30T07:06:22Z",
"dynamicColor": "string",
"modifiedDate": "2018-10-30T07:06:22Z",
"lastReloadTime": "2018-10-30T07:06:22Z",
"hasSectionAccess": true,
"isDirectQueryMode": true
},
"privileges": [
"string"
]
}
Retrieves the lineage for an app. Returns a JSON-formatted array of strings describing the lineage of the app.
Retrieves the lineage for an app. Returns a JSON-formatted array of strings describing the lineage of the app.
Facts
Rate limit | Tier 1 (1000 requests per minute) |
Categories | managebuild |
Path Parameters
- appIdstringRequired
Identifier of the app.
Responses
200
application/json
OK
- application/jsonarray of objects
application/json properties
- statementstring
The LOAD and SELECT script statements from the data load script.
- discriminatorstring
A string indicating the origin of the data:
- [filename]: the data comes from a local file.
- INLINE: the data is entered inline in the load script.
- RESIDENT: the data comes from a resident table. The table name is listed.
- AUTOGENERATE: the data is generated from the load script (no external table of data source).
- Provider: the data comes from a data connection. The connector source name is listed.
- [webfile]: the data comes from a web-based file.
- STORE: path to QVD or TXT file where data is stored.
- EXTENSION: the data comes from a Server Side Extension (SSE).
-
curl "https://your-tenant.us.qlikcloud.com/api/v1/apps/{appId}/data/lineage" \
-H "Authorization: Bearer <API-key>"
const https = require('https')
const data = JSON.stringify("")
const options = {
'hostname': 'https://your-tenant.us.qlikcloud.com',
'port': 443,
'path': '/api/v1/apps/{appId}/data/lineage',
'method': 'GET',
'headers': {
'Authorization': 'Bearer <API-key>'
}
}
const req = https.request(options)
qlik app data lineage \
--appId="string"
Response
[
{
"statement": "string",
"discriminator": "string"
}
]
Retrieves the data model and reload statistics metadata of an app. An empty metadata structure is returned if the metadata is not available in the app.
Retrieves the data model and reload statistics metadata of an app. An empty metadata structure is returned if the metadata is not available in the app.
Facts
Rate limit | Tier 1 (1000 requests per minute) |
Categories | managebuild |
Path Parameters
- appIdstringRequired
Identifier of the app.
Responses
200
application/json
OK
- application/jsonobject
application/json properties
- usagestring
Can be one of: "ANALYTICS""DATA_PREPARATION""DATAFLOW_PREP""SINGLE_TABLE_PREP"
- fieldsarray of objects
List of field descriptions.
fields properties
- hashstring
Hash of the data in the field. If the data in a reload is the same, the hash will be consistent.
- namestring
Name of the field.
- tagsarray of strings
Gives information on a field. For example, it can return the type of the field. Examples: key, text, ASCII.
- commentstring
Field comment.
- cardinalinteger
Number of distinct field values.
- byte_sizeinteger
Static RAM memory used in bytes.
- is_hiddenboolean
If set to true, the field is hidden. The default value is false.
- is_lockedboolean
If set to true, the field is locked. The default value is false.
- is_systemboolean
If set to true, the field is a system field. The default value is false.
- is_numericboolean
Is set to true if the value is a numeric. The default value is false.
- src_tablesarray of strings
List of table names.
- is_semanticboolean
If set to true, the field is semantic. The default value is false.
- total_countinteger
Total number of field values.
- distinct_onlyboolean
If set to true, only distinct field values are shown. The default value is false.
- always_one_selectedboolean
If set to true, the field has one and only one selection (not 0 and not more than 1). If this property is set to true, the field cannot be cleared anymore and no more selections can be performed in that field. The default value is false.
-
- tablesarray of objects
List of table descriptions.
tables properties
- namestring
Name of the table.
- commentstring
Table comment.
- is_looseboolean
If set to true, the table is loose due to circular connection. The default value is false.
- byte_sizeinteger
Static RAM memory used in bytes.
- is_systemboolean
If set to true, the table is a system table. The default value is false.
- no_of_rowsinteger
Number of rows.
- is_semanticboolean
If set to true, the table is semantic. The default value is false.
- no_of_fieldsinteger
Number of fields.
- no_of_key_fieldsinteger
Number of key fields.
-
- reload_metaobject
reload_meta properties
- hardwareobject
hardware properties
- total_memoryinteger
RAM available.
- logical_coresinteger
Number of logical cores available.
-
- cpu_time_spent_msinteger
Number of CPU milliseconds it took to reload the app.
- peak_memory_bytesinteger
Maximum number of bytes used during reload of the app.
- fullReloadPeakMemoryBytesinteger
Maximum number of bytes used during full reload of the app.
- partialReloadPeakMemoryBytesinteger
Maximum number of bytes used during partial reload of the app.
-
- static_byte_sizeinteger
Static memory usage for the app.
- has_section_accessboolean
If set to true, the app has section access configured.
- is_direct_query_modeboolean
- tables_profiling_dataarray of objects
Profiling data of the tables in the app.
tables_profiling_data properties
- NoOfRowsinteger
Number of rows in the table.
- FieldProfilingarray of objects
Field values profiling info
FieldProfiling properties
- Maxnumber
Maximum value of numerical values. NaN otherwise.
- Minnumber
Minimum value of numerical values. NaN otherwise.
- Stdnumber
Standard deviation of numerical values. NaN otherwise.
- Sumnumber
Sum of all numerical values. NaN otherwise.
- Namestring
Name of the field.
- Sum2number
Squared sum of all numerical values. NaN otherwise.
- Mediannumber
Median of all numerical values. NaN otherwise.
- Averagenumber
Average of all numerical values. NaN otherwise.
- Kurtosisnumber
Kurtosis of the numerical values. NaN otherwise.
- Skewnessnumber
Skewness of the numerical values. NaN otherwise.
- FieldTagsarray of strings
List of tags related to the field.
- Fractilesarray of numbers
The .01, .05, .1, .25, .5, .75, .9, .95, .99 fractiles. Array of NaN otherwise.
- NegValuesinteger
Number of negative values
- PosValuesinteger
Number of positive values
- LastSortedstring
For textual values the last sorted string.
- NullValuesinteger
Number of null values
- TextValuesinteger
Number of textual values
- ZeroValuesinteger
Number of zero values for numerical values
- FirstSortedstring
For textual values the first sorted string.
- AvgStringLennumber
Average string length of textual values. 0 otherwise.
- EmptyStringsinteger
Number of empty strings
- MaxStringLeninteger
Maximum string length of textual values. 0 otherwise.
- MinStringLeninteger
Minimum string length of textual values. 0 otherwise.
- MostFrequentarray of objects
Three most frequent values and their frequencies
MostFrequent properties
- Symbolobject
Symbol properties
- Textstring
String value of the symbol. This parameter is optional and present only if Symbol is a string.
- Numbernumber
Numeric value of the symbol. NaN otherwise.
-
- Frequencyinteger
Frequency of the above symbol in the field
-
- NumberFormatobject
Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.
Formatting mechanism
The formatting mechanism depends on the type set in qType, as shown below:
In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.Type is DATE, TIME, TIMESTAMP or INTERVAL
The following applies:
- If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
- If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
- The properties qDec , qThou , qnDec , qUseThou are not used.
Type is INTEGER
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .
Type is REAL
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
- If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
- If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
Type is FIX
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
Type is MONEY
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
- If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).
Type is ASCII
No formatting, qFmt is ignored.
NumberFormat properties
- Decstring
Defines the decimal separator. Example: .
- Fmtstring
Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.
- Thoustring
Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
- Typestring
Can be one of: "U""A""I""R""F""M""D""T""TS""IV"
- nDecinteger
Number of decimals. Default is 10.
- UseThouinteger
Defines whether or not a thousands separator must be used. Default is 0.
- SumStringLeninteger
Sum of all characters in strings in the field
- NumericValuesinteger
Number of numeric values
- DistinctValuesinteger
Number of distinct values
- DistinctTextValuesinteger
Number of distinct text values
- DistinctNumericValuesinteger
Number of distinct numeric values
- FrequencyDistributionobject
FrequencyDistribution properties
- BinsEdgesarray of numbers
Bins edges.
- Frequenciesarray of integers
Bins frequencies.
- NumberOfBinsinteger
Number of bins.
-
-
-
-
curl "https://your-tenant.us.qlikcloud.com/api/v1/apps/{appId}/data/metadata" \
-H "Authorization: Bearer <API-key>"
const https = require('https')
const data = JSON.stringify("")
const options = {
'hostname': 'https://your-tenant.us.qlikcloud.com',
'port': 443,
'path': '/api/v1/apps/{appId}/data/metadata',
'method': 'GET',
'headers': {
'Authorization': 'Bearer <API-key>'
}
}
const req = https.request(options)
qlik app data metadata \
--appId="string"
Response
{
"fields": [
{
"hash": "string",
"name": "string",
"tags": [
"string"
],
"comment": "string",
"cardinal": 42,
"byte_size": 42,
"is_hidden": true,
"is_locked": true,
"is_system": true,
"is_numeric": true,
"src_tables": [
"string"
],
"is_semantic": true,
"total_count": 42,
"distinct_only": true,
"always_one_selected": true
}
],
"tables": [
{
"name": "string",
"comment": "string",
"is_loose": true,
"byte_size": 42,
"is_system": true,
"no_of_rows": 42,
"is_semantic": true,
"no_of_fields": 42,
"no_of_key_fields": 42
}
],
"reload_meta": {
"hardware": {
"total_memory": 42,
"logical_cores": 42
},
"cpu_time_spent_ms": 42,
"peak_memory_bytes": 42,
"fullReloadPeakMemoryBytes": 42,
"partialReloadPeakMemoryBytes": 42
},
"static_byte_size": 42,
"has_section_access": true,
"is_direct_query_mode": true,
"tables_profiling_data": [
{
"NoOfRows": 42,
"FieldProfiling": [
{
"Max": 42,
"Min": 42,
"Std": 42,
"Sum": 42,
"Name": "string",
"Sum2": 42,
"Median": 42,
"Average": 42,
"Kurtosis": 42,
"Skewness": 42,
"FieldTags": [
"string"
],
"Fractiles": [
42
],
"NegValues": 42,
"PosValues": 42,
"LastSorted": "string",
"NullValues": 42,
"TextValues": 42,
"ZeroValues": 42,
"FirstSorted": "string",
"AvgStringLen": 42,
"EmptyStrings": 42,
"MaxStringLen": 42,
"MinStringLen": 42,
"MostFrequent": [
{
"Symbol": {
"Text": "string",
"Number": 42
},
"Frequency": 42
}
],
"NumberFormat": {
"Dec": "string",
"Fmt": "string",
"Thou": "string",
"nDec": 10,
"UseThou": 0
},
"SumStringLen": 42,
"NumericValues": 42,
"DistinctValues": 42,
"DistinctTextValues": 42,
"DistinctNumericValues": 42,
"FrequencyDistribution": {
"BinsEdges": [
42
],
"Frequencies": [
42
],
"NumberOfBins": 42
}
}
]
}
]
}
Exports a specific app.
Facts
Rate limit | Tier 2 (100 requests per minute) |
Categories | managebuild |
Query Parameters
- NoDataboolean
The flag indicating if only object contents should be exported.
Path Parameters
- appIdstringRequired
Identifier of the app.
Responses
201
Created
400
Bad request
403
Forbidden
404
Not Found
curl "https://your-tenant.us.qlikcloud.com/api/v1/apps/{appId}/export" \
-X POST \
-H "Authorization: Bearer <API-key>"
const https = require('https')
const data = JSON.stringify("")
const options = {
'hostname': 'https://your-tenant.us.qlikcloud.com',
'port': 443,
'path': '/api/v1/apps/{appId}/export',
'method': 'POST',
'headers': {
'Authorization': 'Bearer <API-key>'
}
}
const req = https.request(options)
qlik app export <appId>
Returns information about supported analyses for the app's data model. Lists available analysis types, along with minimum and maximum number of dimensions, measures, and fields.
Facts
Rate limit | Tier 1 (1000 requests per minute) |
Categories | managebuild |
Header Parameters
- accept-languagestring
language specified as an ISO-639-1 code. Defaults to 'en' (English).
Path Parameters
- appIdstringRequired
Qlik Sense app identifier
Responses
200
application/json
The request is successfully processed and information about supported analyses is returned.
- application/jsonobject
application/json properties
- dataarray of objects
data properties
- idstring
- compositionsarray of objects
compositions properties
- dimsobject
Upper and lower bounds for items of specific classification types
dims properties
- maxnumber
- minnumber
-
- geosobject
Upper and lower bounds for items of specific classification types
geos properties
- maxnumber
- minnumber
-
- msrsobject
Upper and lower bounds for items of specific classification types
msrs properties
- maxnumber
- minnumber
-
- itemsobject
Upper and lower bounds for items of specific classification types
items properties
- maxnumber
- minnumber
-
- temporalsobject
Upper and lower bounds for items of specific classification types
temporals properties
- maxnumber
- minnumber
-
- descriptionobject
description properties
- longstring
- shortstring
-
-
- supportsMasterItemsboolean
If analysis can work with master items (default is true)
- requiresAutoCalendarPeriodboolean
Used for period-specific analyses to indicate the defined or available calendar period must be of type autoCalendar
- requiresDefinedAnalysisPeriodboolean
Used for period-specific analyses to indicate the measure must be associated with one or more analysis periods
- requiresAvailableAnalysisPeriodboolean
Used for period-specific analyses to indicate the temporal dimension must be associated with one or more analysis periods
-
- linksobject
links properties
- nextobject
next properties
- hrefstring
-
- prevobject
prev properties
- hrefstring
-
- selfobject
self properties
- hrefstring
-
-
-
400
application/json
Bad request. The payload is not formed correctly.
- application/jsonobject
application/json properties
- errorsarray of objects
-
401
application/json
User is not authorized
- application/jsonobject
application/json properties
- errorsarray of objects
-
404
application/json
Not found
- application/jsonobject
application/json properties
- errorsarray of objects
-
422
application/json
Unprocessable entity. The payload contains fields that are invalid, such as too long of a query.
- application/jsonobject
application/json properties
- errorsarray of objects
-
500
application/json
Internal server error
- application/jsonobject
application/json properties
- errorsarray of objects
-
curl "https://your-tenant.us.qlikcloud.com/api/v1/apps/{appId}/insight-analyses" \
-H "Authorization: Bearer <API-key>"
const https = require('https')
const data = JSON.stringify("")
const options = {
'hostname': 'https://your-tenant.us.qlikcloud.com',
'port': 443,
'path': '/api/v1/apps/{appId}/insight-analyses',
'method': 'GET',
'headers': {
'Authorization': 'Bearer <API-key>'
}
}
const req = https.request(options)
qlik app insight-analyse ls <appId>
Response
{
"data": [
{
"id": "string",
"compositions": [
{
"dims": {
"max": 42,
"min": 42
},
"geos": {
"max": 42,
"min": 42
},
"msrs": {
"max": 42,
"min": 42
},
"items": {
"max": 42,
"min": 42
},
"temporals": {
"max": 42,
"min": 42
},
"description": {
"long": "string",
"short": "string"
}
}
],
"supportsMasterItems": true,
"requiresAutoCalendarPeriod": true,
"requiresDefinedAnalysisPeriod": true,
"requiresAvailableAnalysisPeriod": true
}
],
"links": {
"next": {
"href": "http://example.com"
},
"prev": {
"href": "http://example.com"
},
"self": {
"href": "http://example.com"
}
}
}
Returns analysis recommendations in response to a natural language question, a set of fields and master items, or a set of fields and master items with an optional target analysis.
Facts
Rate limit | Tier 2 (100 requests per minute) |
Categories | managebuild |
Header Parameters
- accept-languagestring
language specified as an ISO-639-1 code. Defaults to 'en' (English).
Path Parameters
- appIdstringRequired
Qlik Sense app identifier
Request Body
Requiredapplication/json
Request payload can be of two types, using natural language query or consist of fields or master items and optional target analysis. In below examples, consider sales as a master item and product as field, so to get recommendations using sales and product, you can utilize below three approaches, also you can set language parameter in headers as part of accept-language. Examples: ``` { 'text': 'show me sales by product' } ``` ``` { 'fields': [ { 'name': 'product' } ], 'libItems': [ { libId: 'NwQfJ' } ] } ``` ``` { 'fields': [ { 'name': 'product' } ], 'libItems': [ { 'libId': 'NwQfJ' } ], 'targetAnalysis': { 'id': 'rank-rank' } } ```
- application/jsonobject
Request payload can be of two types, using natural language query or consist of fields or master items and optional target analysis. In below examples, consider sales as a master item and product as field, so to get recommendations using sales and product, you can utilize below three approaches, also you can set language parameter in headers as part of accept-language. Examples:
{ 'text': 'show me sales by product' }
{ 'fields': [ { 'name': 'product' } ], 'libItems': [ { libId: 'NwQfJ' } ] }
{ 'fields': [ { 'name': 'product' } ], 'libItems': [ { 'libId': 'NwQfJ' } ], 'targetAnalysis': { 'id': 'rank-rank' } }
One of:- RecommendNaturalLangQueryobject
RecommendNaturalLangQuery properties
- textstringRequired
The NL query.
-
- RecommendItemsobject
RecommendItems properties
- fieldsarray of objects
structure for providing fields in recommendation request, user can retrieve the fields using insight-analyses/model endpoint
fields properties
- namestring
- overridesobject
overrides properties
- classificationsarray of strings
- defaultAggregationstring
-
-
- libItemsarray of objects
structure for providing master items in recommendation request, user can retrieve the libId of master item using insight-analyses/model endpoint
libItems properties
- libIdstring
- overridesobject
overrides properties
- formatobject
format properties
- qDecstring
- qFmtstring
- qThoustring
- qTypestring
- qnDecnumber
- qUseThounumber
-
-
-
- targetAnalysisobject
targetAnalysis properties
- idstring
id of the target analysis, returned by the GET insight-analyses endpoint
-
-
-
Responses
200
application/json
The request is successfully processed and recommendations are returned.
- application/jsonobject
application/json properties
- dataarray of objects
data properties
- nluInfoarray of objects
Contains break down of the asked question in the form of tokens with their classification.
nluInfo properties
- rolestring
Role of the token or phrase from query
Can be one of: "dimension""measure""date"
- textstring
Matching token or phrase from query
- typestring
Type of token from query
Can be one of: "field""filter""master_dimension""master_measure""custom_analysis"
- fieldNamestring
Qlik sense application field selected for given token or phrase
- fieldValuestring
Filter value found from query
-
- recAnalysesarray of objectsRequired
recAnalyses properties
- optionsobject
(chart options + hypercube definition)
- analysisobject
analysis properties
- titlestring
- analysisstring
Can be one of: "breakdown""changePoint""comparison""contribution""correlation""fact""mutualInfo""rank""spike""trend""values"
- analysisGroupstring
Can be one of: "anomaly""brekadown""comparison""correl""fact""list""mutualInfo""rank"
-
- chartTypestring
Chart type given to current recommendation
Can be one of: "barchart""combochart""distributionplot""kpi""linechart""map""scatterplot""table"
- relevancenumber
percentage of selected items in the analysis to the overall items passed to the endpoint
- partsarray of objects
-
-
-
400
application/json
Bad request. The payload is not formed correctly.
- application/jsonobject
application/json properties
- errorsarray of objects
-
401
application/json
User is not authorized
- application/jsonobject
application/json properties
- errorsarray of objects
-
404
application/json
Not found
- application/jsonobject
application/json properties
- errorsarray of objects
-
409
application/json
Invalid Business Logic
- application/jsonobject
application/json properties
- errorsarray of objects
-
422
application/json
Unprocessable entity. The payload contains fields that are invalid, such as too long of a query.
- application/jsonobject
application/json properties
- errorsarray of objects
-
500
application/json
Internal server error
- application/jsonobject
application/json properties
- errorsarray of objects
-
curl "https://your-tenant.us.qlikcloud.com/api/v1/apps/{appId}/insight-analyses/actions/recommend" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer <API-key>" \
-d '{"text":"string"}'
const https = require('https')
const data = JSON.stringify({"text":"string"})
const options = {
'hostname': 'https://your-tenant.us.qlikcloud.com',
'port': 443,
'path': '/api/v1/apps/{appId}/insight-analyses/actions/recommend',
'method': 'POST',
'headers': {
'Content-type': 'application/json',
'Authorization': 'Bearer <API-key>'
}
}
const req = https.request(options)
req.write(data)
qlik app insight-analyse recommend recommenditems <appId>
Request
{
"text": "string"
}
Response
{
"data": [
{
"nluInfo": [
{
"role": "dimension",
"text": "string",
"type": "field",
"fieldName": "string",
"fieldValue": "string"
}
],
"recAnalyses": [
{
"options": {},
"analysis": {
"title": "string",
"analysis": "breakdown",
"analysisGroup": "anomaly"
},
"chartType": "barchart",
"relevance": 42,
"parts": [
{}
]
}
]
}
]
}
Returns information about model used to make analysis recommendations. Lists all fields and master items in the logical model, along with an indication of the validity of the logical model if the default is not used.
Facts
Rate limit | Tier 1 (1000 requests per minute) |
Categories | managebuild |
Path Parameters
- appIdstringRequired
Qlik Sense app identifier
Responses
200
application/json
The request is successfully processed and information about model is returned.
- application/jsonobject
application/json properties
- dataarray of objects
data properties
- fieldsarray of objects
fields properties
- namestring
populated only for fields
- isHiddenboolean
whether the field is hidden in business logic
- classificationsarray of strings
classification defines the default role that attribute can play in an analysis
Values may be any of: "dimension""measure""temporal""city""address""boolean""country""date""email""geographical""geoPoint""geoPolygon""hour""latitude""monetary""ordinal""percentage""postalCode""quarter""stateProvince""timestamp""week""weekDay""year""yearDay"
- simplifiedClassificationsarray of strings
Values may be any of: "dimension""measure""temporal""geographical"
-
- masterItemsarray of objects
masterItems properties
- libIdstring
only available for master items
- captionstring
- isHiddenboolean
whether the master item is hidden in business logic
- classificationsarray of strings
classification defines the default role that attribute can play in an analysis
Values may be any of: "dimension""measure""temporal""city""address""boolean""country""date""email""geographical""geoPoint""geoPolygon""hour""latitude""monetary""ordinal""percentage""postalCode""quarter""stateProvince""timestamp""week""weekDay""year""yearDay"
- simplifiedClassificationsarray of strings
Values may be any of: "dimension""measure""temporal""geographical"
-
- isLogicalModelEnabledboolean
if the analysis model is constructed based on a user-defined business-logic (as opposed to a default one)
- isDefinedLogicalModelValidboolean
set only if previous property is true, to indicate if the business logic passes validation
-
- linksobject
links properties
- nextobject
next properties
- hrefstring
-
- prevobject
prev properties
- hrefstring
-
- selfobject
self properties
- hrefstring
-
-
-
400
application/json
Bad request. The payload is not formed correctly.
- application/jsonobject
application/json properties
- errorsarray of objects
-
401
application/json
User is not authorized
- application/jsonobject
application/json properties
- errorsarray of objects
-
404
application/json
Not found
- application/jsonobject
application/json properties
- errorsarray of objects
-
409
application/json
Invalid Business Logic
- application/jsonobject
application/json properties
- errorsarray of objects
-
422
application/json
Unprocessable entity. The payload contains fields that are invalid, such as too long of a query.
- application/jsonobject
application/json properties
- errorsarray of objects
-
500
application/json
Internal server error
- application/jsonobject
application/json properties
- errorsarray of objects
-
curl "https://your-tenant.us.qlikcloud.com/api/v1/apps/{appId}/insight-analyses/model" \
-H "Authorization: Bearer <API-key>"
const https = require('https')
const data = JSON.stringify("")
const options = {
'hostname': 'https://your-tenant.us.qlikcloud.com',
'port': 443,
'path': '/api/v1/apps/{appId}/insight-analyses/model',
'method': 'GET',
'headers': {
'Authorization': 'Bearer <API-key>'
}
}
const req = https.request(options)
qlik app insight-analyse model <appId>
Response
{
"data": [
{
"fields": [
{
"name": "string",
"isHidden": false,
"classifications": [
"dimension"
],
"simplifiedClassifications": [
"dimension"
]
}
],
"masterItems": [
{
"libId": "string",
"caption": "string",
"isHidden": false,
"classifications": [
"dimension"
],
"simplifiedClassifications": [
"dimension"
]
}
],
"isLogicalModelEnabled": true,
"isDefinedLogicalModelValid": true
}
],
"links": {
"next": {
"href": "http://example.com"
},
"prev": {
"href": "http://example.com"
},
"self": {
"href": "http://example.com"
}
}
}
Gets media content from file. Returns a stream of bytes containing the media file content on success, or error if file is not found.
Gets media content from file. Returns a stream of bytes containing the media file content on success, or error if file is not found.
Facts
Rate limit | Tier 1 (1000 requests per minute) |
Categories | managebuild |
Path Parameters
- appIdstringRequired
Unique application identifier.
- pathstringRequired
Path to file content.
Responses
200
application/octet-stream
OK
- application/octet-streamstring
403
Forbidden
404
Not Found
curl "https://your-tenant.us.qlikcloud.com/api/v1/apps/{appId}/media/files/{path}" \
-H "Authorization: Bearer <API-key>" \
-o "output-file"
const https = require('https')
const data = JSON.stringify("")
const options = {
'hostname': 'https://your-tenant.us.qlikcloud.com',
'port': 443,
'path': '/api/v1/apps/{appId}/media/files/{path}',
'method': 'GET',
'headers': {
'Authorization': 'Bearer <API-key>'
}
}
const req = https.request(options)
qlik app media file get <path> \
--appId="string" \
> output-file
Stores the media content file. Returns OK if the bytes containing the media file content were successfully stored, or error in case of failure, lack of permission or file already exists on the supplied path.
Stores the media content file. Returns OK if the bytes containing the media file content were successfully stored, or error in case of failure, lack of permission or file already exists on the supplied path.
Facts
Rate limit | Tier 2 (100 requests per minute) |
Categories | managebuild |
Path Parameters
- appIdstringRequired
Unique application identifier.
- pathstringRequired
Path to file content.
Request Body
Requiredapplication/octet-stream
- application/octet-streamstring
Responses
200
OK
403
Forbidden
404
Not Found
curl "https://your-tenant.us.qlikcloud.com/api/v1/apps/{appId}/media/files/{path}" \
-X PUT \
-H "Content-type: application/octet-stream" \
-H "Authorization: Bearer <API-key>" \
--data-binary' \
'"@/path/to/file"
const https = require('https')
const data = JSON.stringify("string")
const options = {
'hostname': 'https://your-tenant.us.qlikcloud.com',
'port': 443,
'path': '/api/v1/apps/{appId}/media/files/{path}',
'method': 'PUT',
'headers': {
'Content-type': 'application/octet-stream',
'Authorization': 'Bearer <API-key>'
}
}
const req = https.request(options)
req.write(streamData)
qlik app media file update <path> \
--appId="string"
Request
"string"
Deletes a media content file or complete directory. Returns OK if the bytes containing the media file (or the complete content of a directory) were successfully deleted, or error in case of failure or lack of permission.
Deletes a media content file or complete directory. Returns OK if the bytes containing the media file (or the complete content of a directory) were successfully deleted, or error in case of failure or lack of permission.
Facts
Rate limit | Tier 2 (100 requests per minute) |
Categories | managebuild |
Path Parameters
- appIdstringRequired
Unique application identifier.
- pathstringRequired
Path to file content.
Responses
200
OK
403
Forbidden
404
Not Found
curl "https://your-tenant.us.qlikcloud.com/api/v1/apps/{appId}/media/files/{path}" \
-X DELETE \
-H "Authorization: Bearer <API-key>"
const https = require('https')
const data = JSON.stringify("")
const options = {
'hostname': 'https://your-tenant.us.qlikcloud.com',
'port': 443,
'path': '/api/v1/apps/{appId}/media/files/{path}',
'method': 'DELETE',
'headers': {
'Authorization': 'Bearer <API-key>'
}
}
const req = https.request(options)
qlik app media file rm <path> \
--appId="string"
Lists media content. Returns a JSON formatted array of strings describing the available media content or error if the optional path supplied is not found.
Lists media content. Returns a JSON formatted array of strings describing the available media content or error if the optional path supplied is not found.
Facts
Rate limit | Tier 1 (1000 requests per minute) |
Categories | managebuild |
Query Parameters
- showstring
Optional. List output can include files and folders in different ways:
- Not recursive, default if show option is not supplied or incorrectly specified, results in output with files and empty directories for the path specified only.
- Recursive(r), use ?show=r or ?show=recursive, results in a recursive output with files, all empty folders are excluded.
- All(a), use ?show=a or ?show=all, results in a recursive output with files and empty directories.
Path Parameters
- appIdstringRequired
Unique application identifier.
- pathstringRequired
The path to sub folder with static content relative to the root folder. Use empty path to access the root folder.
Responses
200
application/json
OK
- application/jsonobject
application/json properties
- dataarray of objects
Content list items.
data properties
- idstring
Unique content identifier.
- linkstring
Unique content link.
- namestring
Content name.
- typestring
Content type.
-
- librarystring
Content library name.
- subpathstring
Content library relative listing path. Empty in case of root listed or representing actual subpath listed.
-
403
Forbidden
404
Not Found
curl "https://your-tenant.us.qlikcloud.com/api/v1/apps/{appId}/media/list/{path}" \
-H "Authorization: Bearer <API-key>"
const https = require('https')
const data = JSON.stringify("")
const options = {
'hostname': 'https://your-tenant.us.qlikcloud.com',
'port': 443,
'path': '/api/v1/apps/{appId}/media/list/{path}',
'method': 'GET',
'headers': {
'Authorization': 'Bearer <API-key>'
}
}
const req = https.request(options)
qlik app media list get <path> \
--appId="string"
Response
{
"data": [
{
"id": "string",
"link": "string",
"name": "string",
"type": "string"
}
],
"library": "string",
"subpath": "string"
}
Gets media content from file currently used as application thumbnail. Returns a stream of bytes containing the media file content on success, or error if file is not found. The image selected as thumbnail is only updated when application is saved.
Gets media content from file currently used as application thumbnail. Returns a stream of bytes containing the media file content on success, or error if file is not found. The image selected as thumbnail is only updated when application is saved.
Facts
Rate limit | Tier 1 (1000 requests per minute) |
Categories | managebuild |
Path Parameters
- appIdstringRequired
Unique application identifier.
Responses
200
application/octet-stream
OK
- application/octet-streamstring
403
Forbidden
404
Not Found
curl "https://your-tenant.us.qlikcloud.com/api/v1/apps/{appId}/media/thumbnail" \
-H "Authorization: Bearer <API-key>" \
-o "output-file"
const https = require('https')
const data = JSON.stringify("")
const options = {
'hostname': 'https://your-tenant.us.qlikcloud.com',
'port': 443,
'path': '/api/v1/apps/{appId}/media/thumbnail',
'method': 'GET',
'headers': {
'Authorization': 'Bearer <API-key>'
}
}
const req = https.request(options)
qlik app media thumbnail \
--appId="string" \
> output-file
Sets owner on an app object. The user must be the owner of the object.
Facts
Rate limit | Tier 2 (100 requests per minute) |
Categories | managebuild |
Path Parameters
- appIdstringRequired
Identifier of the app.
- objectIdstringRequired
Identifier of the object.
Request Body
Required*/*
New owner.
- */*object
*/* properties
- ownerIdstring
-
Responses
200
application/json
OK
Application object attributes and user privileges.
- application/jsonobject
Application object attributes and user privileges.
application/json properties
- attributesobject
App object attributes. This structure can also contain extra user-defined attributes.
attributes properties
- idstring
The object Id.
- namestring
Object name.
- ownerIdstring
The object owner's Id.
- approvedboolean
True if the object is approved.
- createdAtstring
The date and time when the object was created.
- updatedAtstring
The date and time when the object was modified.
- objectTypestring
The type of the object.
- descriptionstring
Object description.
- genericTypestring
Can be one of: "genericObject""genericBookmark""genericMeasure""genericDimension""genericVariable"
- publishedAtstring
The date and time when the object was published, empty if unpublished.
-
- privilegesarray of strings
Application object privileges. Hints to the client what actions the user is allowed to perform. Could be any of:
- read
- create
- update
- delete
- publish
- exportdata
- change_owner
-
400
Bad request
404
Not Found
curl "https://your-tenant.us.qlikcloud.com/api/v1/apps/{appId}/objects/{objectId}/actions/change-owner" \
-X POST \
-H "Content-type: */*" \
-H "Authorization: Bearer <API-key>" \
-d '{"ownerId":"string"}'
const https = require('https')
const data = JSON.stringify({"ownerId":"string"})
const options = {
'hostname': 'https://your-tenant.us.qlikcloud.com',
'port': 443,
'path': '/api/v1/apps/{appId}/objects/{objectId}/actions/change-owner',
'method': 'POST',
'headers': {
'Content-type': '*/*',
'Authorization': 'Bearer <API-key>'
}
}
const req = https.request(options)
req.write(data)
qlik app object change-owner \
--appId="string" \
--objectId="string" \
--ownerId="string"
Request
{
"ownerId": "string"
}
Response
{
"attributes": {
"id": "string",
"name": "string",
"ownerId": "string",
"approved": true,
"createdAt": "2018-10-30T07:06:22Z",
"updatedAt": "2018-10-30T07:06:22Z",
"objectType": "string",
"description": "string",
"publishedAt": "2018-10-30T07:06:22Z"
},
"privileges": [
"string"
]
}
Changes owner of the app.
Facts
Rate limit | Tier 2 (100 requests per minute) |
Categories | managebuild |
Path Parameters
- appIdstringRequired
Identifier of the app.
Request Body
Required*/*
New owner.
- */*object
*/* properties
- ownerIdstring
-
Responses
200
application/json
OK
Application attributes and user privileges.
- application/jsonobject
Application attributes and user privileges.
application/json properties
- createarray of objects
- attributesobject
App attributes. This structure can also contain extra user-defined attributes.
attributes properties
- idstring
The App ID.
- namestring
App name.
- ownerstringDeprecated
Deprecated. Use the Users API to fetch user metadata.
- usagestring
Can be one of: "ANALYTICS""DATA_PREPARATION""DATAFLOW_PREP""SINGLE_TABLE_PREP"
- customobject
Contains dynamic JSON data specified by the client.
- ownerIdstring
Identifier of the app owner.
- encryptedboolean
If set to true, the app is encrypted.
- publishedboolean
True if the app is published on-prem, distributed in QCS, false if not.
- thumbnailstring
App thumbnail.
- createdDatestring
The date and time when the app was created.
- descriptionstring
App description.
- originAppIdstring
The Origin App ID for published apps.
- publishTimestring
The date and time when the app was published, empty if unpublished.
- dynamicColorstring
The dynamic color of the app.
- modifiedDatestring
The date and time when the app was modified.
- lastReloadTimestring
Date and time of the last reload of the app.
- hasSectionAccessboolean
If set to true, the app has section access configured,
- isDirectQueryModeboolean
True if the app is a Direct Query app, false if not
-
- privilegesarray of strings
Application privileges. Hints to the client what actions the user is allowed to perform. Could be any of:
- read
- create
- update
- delete
- reload
- import
- publish
- duplicate
- export
- exportdata
- change_owner
- change_space
-
403
Forbidden
404
Not Found
curl "https://your-tenant.us.qlikcloud.com/api/v1/apps/{appId}/owner" \
-X PUT \
-H "Content-type: */*" \
-H "Authorization: Bearer <API-key>" \
-d '{"ownerId":"string"}'
const https = require('https')
const data = JSON.stringify({"ownerId":"string"})
const options = {
'hostname': 'https://your-tenant.us.qlikcloud.com',
'port': 443,
'path': '/api/v1/apps/{appId}/owner',
'method': 'PUT',
'headers': {
'Content-type': '*/*',
'Authorization': 'Bearer <API-key>'
}
}
const req = https.request(options)
req.write(data)
qlik app owner <appId> \
--ownerId="string"
Request
{
"ownerId": "string"
}
Response
{
"create": [
{}
],
"attributes": {
"id": "string",
"name": "string",
"owner": "string",
"custom": {},
"ownerId": "string",
"encrypted": true,
"published": true,
"thumbnail": "string",
"createdDate": "2018-10-30T07:06:22Z",
"description": "string",
"originAppId": "string",
"publishTime": "2018-10-30T07:06:22Z",
"dynamicColor": "string",
"modifiedDate": "2018-10-30T07:06:22Z",
"lastReloadTime": "2018-10-30T07:06:22Z",
"hasSectionAccess": true,
"isDirectQueryMode": true
},
"privileges": [
"string"
]
}
Publishes a specific app to a managed space.
Facts
Rate limit | Tier 2 (100 requests per minute) |
Categories | managebuild |
Path Parameters
- appIdstringRequired
Identifier of the app.
Request Body
Required*/*
Publish information for the app.
- */*object
*/* properties
- datastring
Can be one of: "source""target"
- moveAppboolean
The original is moved instead of copied. The current published state of all objects is kept.
- spaceIdstring
The managed space ID where the app will be published.
- attributesobject
attributes properties
- namestring
The name (title) of the application.
- descriptionstring
The description of the application.
-
- originAppIdstring
If app is moved, originAppId needs to be provided.
-
Responses
200
application/json
OK
Application attributes and user privileges.
- application/jsonobject
Application attributes and user privileges.
application/json properties
- createarray of objects
- attributesobject
App attributes. This structure can also contain extra user-defined attributes.
attributes properties
- idstring
The App ID.
- namestring
App name.
- ownerstringDeprecated
Deprecated. Use the Users API to fetch user metadata.
- usagestring
Can be one of: "ANALYTICS""DATA_PREPARATION""DATAFLOW_PREP""SINGLE_TABLE_PREP"
- customobject
Contains dynamic JSON data specified by the client.
- ownerIdstring
Identifier of the app owner.
- encryptedboolean
If set to true, the app is encrypted.
- publishedboolean
True if the app is published on-prem, distributed in QCS, false if not.
- thumbnailstring
App thumbnail.
- createdDatestring
The date and time when the app was created.
- descriptionstring
App description.
- originAppIdstring
The Origin App ID for published apps.
- publishTimestring
The date and time when the app was published, empty if unpublished.
- dynamicColorstring
The dynamic color of the app.
- modifiedDatestring
The date and time when the app was modified.
- lastReloadTimestring
Date and time of the last reload of the app.
- hasSectionAccessboolean
If set to true, the app has section access configured,
- isDirectQueryModeboolean
True if the app is a Direct Query app, false if not
-
- privilegesarray of strings
Application privileges. Hints to the client what actions the user is allowed to perform. Could be any of:
- read
- create
- update
- delete
- reload
- import
- publish
- duplicate
- export
- exportdata
- change_owner
- change_space
-
curl "https://your-tenant.us.qlikcloud.com/api/v1/apps/{appId}/publish" \
-X POST \
-H "Content-type: */*" \
-H "Authorization: Bearer <API-key>" \
-d '{"moveApp":false,"spaceId":"string","attributes":{"name":"string","description":"string"},"originAppId":"string"}'
const https = require('https')
const data = JSON.stringify({"moveApp":false,"spaceId":"string","attributes":{"name":"string","description":"string"},"originAppId":"string"})
const options = {
'hostname': 'https://your-tenant.us.qlikcloud.com',
'port': 443,
'path': '/api/v1/apps/{appId}/publish',
'method': 'POST',
'headers': {
'Content-type': '*/*',
'Authorization': 'Bearer <API-key>'
}
}
const req = https.request(options)
req.write(data)
qlik app publish create <appId> \
--attributes-description="string" \
--attributes-name="string" \
--originAppId="string" \
--spaceId="string"
Request
{
"moveApp": false,
"spaceId": "string",
"attributes": {
"name": "string",
"description": "string"
},
"originAppId": "string"
}
Response
{
"create": [
{}
],
"attributes": {
"id": "string",
"name": "string",
"owner": "string",
"custom": {},
"ownerId": "string",
"encrypted": true,
"published": true,
"thumbnail": "string",
"createdDate": "2018-10-30T07:06:22Z",
"description": "string",
"originAppId": "string",
"publishTime": "2018-10-30T07:06:22Z",
"dynamicColor": "string",
"modifiedDate": "2018-10-30T07:06:22Z",
"lastReloadTime": "2018-10-30T07:06:22Z",
"hasSectionAccess": true,
"isDirectQueryMode": true
},
"privileges": [
"string"
]
}
Republishes a published app to a managed space.
Facts
Rate limit | Tier 2 (100 requests per minute) |
Categories | managebuild |
Path Parameters
- appIdstringRequired
Identifier of the app.
Request Body
Required*/*
Republish information for the app.
- */*object
*/* properties
- datastring
Can be one of: "source""target"
- targetIdstring
The target ID to be republished.
- attributesobject
attributes properties
- namestring
The name (title) of the application.
- descriptionstring
The description of the application.
-
- checkOriginAppIdboolean
Validate that source app is same as originally published.
-
Responses
200
application/json
OK
Application attributes and user privileges.
- application/jsonobject
Application attributes and user privileges.
application/json properties
- createarray of objects
- attributesobject
App attributes. This structure can also contain extra user-defined attributes.
attributes properties
- idstring
The App ID.
- namestring
App name.
- ownerstringDeprecated
Deprecated. Use the Users API to fetch user metadata.
- usagestring
Can be one of: "ANALYTICS""DATA_PREPARATION""DATAFLOW_PREP""SINGLE_TABLE_PREP"
- customobject
Contains dynamic JSON data specified by the client.
- ownerIdstring
Identifier of the app owner.
- encryptedboolean
If set to true, the app is encrypted.
- publishedboolean
True if the app is published on-prem, distributed in QCS, false if not.
- thumbnailstring
App thumbnail.
- createdDatestring
The date and time when the app was created.
- descriptionstring
App description.
- originAppIdstring
The Origin App ID for published apps.
- publishTimestring
The date and time when the app was published, empty if unpublished.
- dynamicColorstring
The dynamic color of the app.
- modifiedDatestring
The date and time when the app was modified.
- lastReloadTimestring
Date and time of the last reload of the app.
- hasSectionAccessboolean
If set to true, the app has section access configured,
- isDirectQueryModeboolean
True if the app is a Direct Query app, false if not
-
- privilegesarray of strings
Application privileges. Hints to the client what actions the user is allowed to perform. Could be any of:
- read
- create
- update
- delete
- reload
- import
- publish
- duplicate
- export
- exportdata
- change_owner
- change_space
-
curl "https://your-tenant.us.qlikcloud.com/api/v1/apps/{appId}/publish" \
-X PUT \
-H "Content-type: */*" \
-H "Authorization: Bearer <API-key>" \
-d '{"targetId":"string","attributes":{"name":"string","description":"string"},"checkOriginAppId":true}'
const https = require('https')
const data = JSON.stringify({"targetId":"string","attributes":{"name":"string","description":"string"},"checkOriginAppId":true})
const options = {
'hostname': 'https://your-tenant.us.qlikcloud.com',
'port': 443,
'path': '/api/v1/apps/{appId}/publish',
'method': 'PUT',
'headers': {
'Content-type': '*/*',
'Authorization': 'Bearer <API-key>'
}
}
const req = https.request(options)
req.write(data)
qlik app publish update <appId> \
--attributes-description="string" \
--attributes-name="string" \
--checkOriginAppId=true \
--targetId="string"
Request
{
"targetId": "string",
"attributes": {
"name": "string",
"description": "string"
},
"checkOriginAppId": true
}
Response
{
"create": [
{}
],
"attributes": {
"id": "string",
"name": "string",
"owner": "string",
"custom": {},
"ownerId": "string",
"encrypted": true,
"published": true,
"thumbnail": "string",
"createdDate": "2018-10-30T07:06:22Z",
"description": "string",
"originAppId": "string",
"publishTime": "2018-10-30T07:06:22Z",
"dynamicColor": "string",
"modifiedDate": "2018-10-30T07:06:22Z",
"lastReloadTime": "2018-10-30T07:06:22Z",
"hasSectionAccess": true,
"isDirectQueryMode": true
},
"privileges": [
"string"
]
}
Retrieves the metadata about all script logs stored for an app. Returns an array of ScriptLogMeta objects.
Retrieves the metadata about all script logs stored for an app. Returns an array of ScriptLogMeta objects.
Facts
Rate limit | Tier 1 (1000 requests per minute) |
Categories | managebuild |
Path Parameters
- appIdstringRequired
Identifier of the app.
Responses
200
application/json
OK
- application/jsonobject
application/json properties
- dataarray of objects
Array of scriptLogMeta.
data properties
- linksobject
links properties
- logstring
Provides a link to download the log file.
-
- endTimestring
Time when reload ended.
- successboolean
True if the reload was successful.
- durationinteger
Duration of reload (ms).
- reloadIdstring
Reload identifier.
-
-
curl "https://your-tenant.us.qlikcloud.com/api/v1/apps/{appId}/reloads/logs" \
-H "Authorization: Bearer <API-key>"
const https = require('https')
const data = JSON.stringify("")
const options = {
'hostname': 'https://your-tenant.us.qlikcloud.com',
'port': 443,
'path': '/api/v1/apps/{appId}/reloads/logs',
'method': 'GET',
'headers': {
'Authorization': 'Bearer <API-key>'
}
}
const req = https.request(options)
This API is not included yet in qlik-cli
Response
{
"data": [
{
"links": {
"log": "string"
},
"endTime": "2018-10-30T07:06:22Z",
"success": true,
"duration": 42,
"reloadId": "string"
}
]
}
Retrieves the log of a specific reload. Returns the log as "text/plain; charset=UTF-8".
Facts
Rate limit | Tier 1 (1000 requests per minute) |
Categories | managebuild |
Path Parameters
- appIdstringRequired
Identifier of the app.
- reloadIdstringRequired
Identifier of the reload.
Responses
200
application/octet-stream
OK
- application/octet-streamstring
curl "https://your-tenant.us.qlikcloud.com/api/v1/apps/{appId}/reloads/logs/{reloadId}" \
-H "Authorization: Bearer <API-key>" \
-o "output-file"
const https = require('https')
const data = JSON.stringify("")
const options = {
'hostname': 'https://your-tenant.us.qlikcloud.com',
'port': 443,
'path': '/api/v1/apps/{appId}/reloads/logs/{reloadId}',
'method': 'GET',
'headers': {
'Authorization': 'Bearer <API-key>'
}
}
const req = https.request(options)
This API is not included yet in qlik-cli
Retrieves the app reload metadata list. Reload metadata contains reload information, including reload id, duration, endtime and lineage load info.
Retrieves the app reload metadata list. Reload metadata contains reload information, including reload id, duration, endtime and lineage load info.
Facts
Rate limit | Tier 1 (1000 requests per minute) |
Categories | managebuild |
Query Parameters
- includeSkipStoreReloadsboolean
Include metadata for reloads ran with SkipStore flag set to true. Default: false
- limitstring
Maximum number of records to return from this request. Default: 100
Path Parameters
- appIdstringRequired
Identifier of the app
- reloadIdstringRequired
Identifier of the reload. Use empty reloadId to get all reloads.
Responses
200
application/json
OK
- application/jsonobject
application/json properties
- dataarray of objects
Array of ReloadMeta.
data properties
- endTimestring
Time when reload ended.
- successboolean
true if the reload was successful.
- durationinteger
Duration of reload (ms).
- reloadIdstring
Reload identifier.
- rowLimitinteger
If greater than or equal 0, defines max number of rows loaded from a data source.
- appDbHashstring
A Base64-encoded hash value of the new app database.
- skipStoreboolean
Set to true to skip Store statements. The default value is false.
- storeHashstring
A Base64-encoded hash value of all fields stored via the store statements.
- statementsarray of objects
List of external loaded or stored statements.
statements properties
- qristring
Resource Identifier.
- typestring
Type of statement, e.g. Store/Load.
- labelstring
Label of the resource level node in lineage.
- dataSizeinteger
Data loaded from the network (bytes).
- durationinteger
Duration of data generation (ms).
- nbrOfRowsinteger
Number of rows loaded.
- tableNamestring
Name of the source table in lineage.
- connectionstring
The connecton name.
- nbrOfFieldsinteger
Number of fields loaded.
- connectionIdstring
Connection ID.
- partialReloadOperationstring
Partial load operation. e.g. add/replace/update/merge. n/a when not in partial load mode.
-
- accessDbHashstring
A Base64-encoded hash value of the new section access database.
- includeFilesarray of objects
Files brought into the script via include/mustInclude macros.
includeFiles properties
- qristring
File QRI resource identifier.
- pathstring
File location within the connection.
- connectionstring
The connection name.
-
- loadFilesBytesinteger
- isPartialReloadboolean
True if the reload is a partial reload.
- storeFilesBytesinteger
- loadExternalBytesinteger
- loadDataFilesBytesinteger
- storeDataFilesBytesinteger
-
-
curl "https://your-tenant.us.qlikcloud.com/api/v1/apps/{appId}/reloads/metadata/{reloadId}" \
-H "Authorization: Bearer <API-key>"
const https = require('https')
const data = JSON.stringify("")
const options = {
'hostname': 'https://your-tenant.us.qlikcloud.com',
'port': 443,
'path': '/api/v1/apps/{appId}/reloads/metadata/{reloadId}',
'method': 'GET',
'headers': {
'Authorization': 'Bearer <API-key>'
}
}
const req = https.request(options)
This API is not included yet in qlik-cli
Response
{
"data": [
{
"endTime": "2018-10-30T07:06:22Z",
"success": true,
"duration": 42,
"reloadId": "string",
"rowLimit": -1,
"appDbHash": "string",
"skipStore": false,
"storeHash": "string",
"statements": [
{
"qri": "string",
"type": "string",
"label": "string",
"dataSize": 42,
"duration": 42,
"nbrOfRows": 42,
"tableName": "string",
"connection": "string",
"nbrOfFields": 42,
"connectionId": "string",
"partialReloadOperation": "string"
}
],
"accessDbHash": "string",
"includeFiles": [
{
"qri": "string",
"path": "string",
"connection": "string"
}
],
"loadFilesBytes": 42,
"isPartialReload": true,
"storeFilesBytes": 42,
"loadExternalBytes": 42,
"loadDataFilesBytes": 42,
"storeDataFilesBytes": 42
}
]
}
List all filters that are present in the given app. Filters allow to reduce the app data visible in a report output. Each filter can contain definitions on one or multiple fields.
Facts
Rate limit | Tier 1 (1000 requests per minute) |
Categories | build |
Query Parameters
- filterTypesarray of stringsRequired
The filter type (REP, SUB). REP stands for report bookmark, SUB for subscription bookmark.
Values may be any of: "REP""SUB"
- filterstring
The advanced filtering to use for the query. Refer to RFC 7644 for the syntax. Cannot be combined with any of the fields marked as deprecated. All conditional statements within this query parameter are case insensitive. The following fields support the
co
(contains) operator:name
,description
The following fields support theeq
(equals) operator:ownerId
Example: (name co "query1" or description co "query2") and ownerId eq "123" - limitinteger
Limit the returned result set
- pagestring
If present, the cursor that starts the page of data that is returned.
- sortarray of strings
Sorting parameters.
Values may be any of: "+ownerId""-ownerId""-name""+name""+description""-description""+createdAt""-createdAt""+updatedAt""-updatedAt"
Path Parameters
- appIdstringRequired
Qlik Sense app identifier
Responses
200
application/json
The filters have been successfully returned.
- application/jsonobject
application/json properties
- dataarray of objectsRequired
a list of filters containing all the filters properties (like name,description...) except the filter definition (like FilterV1_0)
data properties
- idstring
The filter ID (bookmarkId)
- namestring
The filter name.
- ownerIdstring
The user that owns the filter, if missing the same as the request user.
- createdAtstring
- updatedAtstring
- filterTypestring
Can be one of: "REP""SUB"
- filterV1_0object
filterV1_0 properties
- variablesarray of objects
The filter variables.
variables properties
- namestringRequired
- valuestring
- evaluateboolean
-
- fieldsByStateobject
Map of fields to apply by state. Maximum number of states allowed is 125. Maximum number of fields allowed is 125 and maximum number of overall field values allowed is 150000.
-
- descriptionstring
The filter description.
- filterVersionstring
Can be one of: "filter-1.0""filter-2.0"
-
- linksobjectRequired
links properties
- nextobjectRequired
next properties
- hrefstring
-
- prevobjectRequired
prev properties
- hrefstring
-
- selfobjectRequired
self properties
- hrefstring
-
-
-
400
application/json
Bad request. Malformed syntax, errors in params.
Errors occured during the Filter creation.
- application/jsonobject
Errors occured during the Filter creation.
application/json properties
- errorsarray of objectsRequired
Error occured during the Filter creation.
errors properties
- codestringRequired
The unique code for the error
- "REP-400000" Bad request. The server could not understand the request due to invalid syntax.
- "REP-400008" Selections error.
- "REP-400015" Bad request in enigma request. The patch value has invalid JSON format.
- "REP-401000" Unauthorized. The client must authenticate itself to get the requested response.
- "REP-401001" Unauthorized, bad JWT.
- "REP-403000" Forbidden. The client does not have access rights to the content.
- "REP-403001" App forbidden, the user does not have read permission on the app.
- "REP-403002" Chart type not supported.
- "REP-404000" Not found. The server can not find the requested resource.
- "REP-409043" Filter name conflict. The filter name must be unique.
- "REP-429000" Too many request. The user has sent too many requests in a given amount of time ("rate limiting").
- "REP-429012" Exceeded max session tenant quota. A tenant has opened too many different sessions at the same time.
- "REP-429016" Exceeded max session tenant quota per day.
- "REP-500000" Fail to resolve resource.
- "REP-503005" Engine unavailable, qix-sessions error no engines available.
- "REP-503013" Session unavailable. The engine session used to create the report is unavailable.
- "REP-504042" Context deadline exceeded applying selections of the Filter.
- "REP-500031" Error creating bookmark.
- "REP-404032" Bookmark not found after creating the bookmark.
- "REP-500033" Error destroying bookmark.
- "REP-404033" Bookmark not found destroying the bookmark.
- "REP-409043" Dupliacate bookmark name.
- "REP-429034" Filters quota exceeded.
- "REP-400044" Missing or renamed field.
- "REP-403049" Report filter access not allowed.
- titlestringRequired
A summary in english explaining what went wrong.
-
-
401
application/json
Unauthorized, JWT invalid or not provided.
Errors occured during the Filter creation.
- application/jsonobject
Errors occured during the Filter creation.
application/json properties
- errorsarray of objectsRequired
-
403
application/json
Forbidden, user lacks sufficient permissions to access the resource.
Errors occured during the Filter creation.
- application/jsonobject
Errors occured during the Filter creation.
application/json properties
- errorsarray of objectsRequired
-
404
application/json
Not found.
Errors occured during the Filter creation.
- application/jsonobject
Errors occured during the Filter creation.
application/json properties
- errorsarray of objectsRequired
-
429
application/json
Too many request. Indicates the user has sent too many requests in a given amount of time, aka "rate limiting".
Errors occured during the Filter creation.
- application/jsonobject
Errors occured during the Filter creation.
application/json properties
- errorsarray of objectsRequired
-
500
application/json
Internal server error.
Errors occured during the Filter creation.
- application/jsonobject
Errors occured during the Filter creation.
application/json properties
- errorsarray of objectsRequired
-
curl "https://your-tenant.us.qlikcloud.com/api/v1/apps/{appId}/report-filters" \
-H "Authorization: Bearer <API-key>"
const https = require('https')
const data = JSON.stringify("")
const options = {
'hostname': 'https://your-tenant.us.qlikcloud.com',
'port': 443,
'path': '/api/v1/apps/{appId}/report-filters',
'method': 'GET',
'headers': {
'Authorization': 'Bearer <API-key>'
}
}
const req = https.request(options)
This API is not included yet in qlik-cli
Response
{
"data": [
{
"id": "c61841ac-7b35-4434-aa74-4421f10fc68e",
"name": "Filter 1",
"ownerId": "649173fbc8ffcfde27412b99",
"createdAt": "2023-08-09T08:19:37.577Z",
"updatedAt": "2023-08-09T08:19:37.577Z",
"filterType": "REP",
"filterV1_0": {
"fieldsByState": {
"$": [
{
"name": "Country",
"values": [
{
"valueType": "string",
"valueAsText": "1-Argentina"
},
{
"valueType": "string",
"valueAsText": "4-Brazil"
}
],
"overrideValues": false,
"selectExcluded": false
},
{
"name": "Order number",
"values": [
{
"valueType": "number",
"valueAsText": "61300",
"valueAsNumber": 61300
}
],
"overrideValues": false,
"selectExcluded": false
}
]
}
},
"description": "This is the filter description",
"filterVersion": "filter-1.0"
}
],
"links": {
"next": {
"href": "https://tenant.qlik-cloud.com:443/api/v1/apps/816e23e1-03d2-446b-8721-cdee6b5e59cf/report-filters?filter=&filterTypes=REP&filterTypes=REP&limit=20&page=0&sort=%2Bname"
},
"prev": {
"href": "https://tenant.qlik-cloud.com:443/api/v1/apps/816e23e1-03d2-446b-8721-cdee6b5e59cf/report-filters?filter=&filterTypes=REP&filterTypes=REP&limit=20&page=0&sort=%2Bname"
},
"self": {
"href": "https://tenant.qlik-cloud.com:443/api/v1/apps/816e23e1-03d2-446b-8721-cdee6b5e59cf/report-filters?filter=&filterTypes=REP&filterTypes=REP&limit=20&page=0&sort=%2Bname"
}
}
}
Creates a new report filter which is used to re-apply selections, variables, patches to an engine session.
Facts
Rate limit | Tier 2 (100 requests per minute) |
Categories | build |
Path Parameters
- appIdstringRequired
Qlik Sense app identifier
Request Body
Requiredapplication/json
The filter definition.
- application/jsonobject
application/json properties
- namestringRequired
The filter name.
- appIdstring
The App ID.
- ownerIdstring
The user that owns the filter, if missing the same as the request user.
- filterTypestringRequired
Can be one of: "REP""SUB"
- filterV1_0object
filterV1_0 properties
- variablesarray of objects
- fieldsByStateobject
Map of fields to apply by state. Maximum number of states allowed is 125. Maximum number of fields allowed is 125 and maximum number of overall field values allowed is 150000.
-
- descriptionstring
The filter description.
- filterVersionstringRequired
Can be one of: "filter-1.0""filter-2.0"
-
Responses
201
application/json
The filter has been successfully created.
- application/jsonobject
application/json properties
- idstring
The filter ID (bookmarkId).
- namestring
The filter name.
- ownerIdstring
The user that owns the filter, if missing the same as the request user.
- createdAtstring
- updatedAtstring
- filterTypestring
Can be one of: "REP""SUB"
- filterV1_0object
filterV1_0 properties
- variablesarray of objects
- fieldsByStateobject
Map of fields to apply by state. Maximum number of states allowed is 125. Maximum number of fields allowed is 125 and maximum number of overall field values allowed is 150000.
-
- descriptionstring
The filter description.
- filterVersionstring
Can be one of: "filter-1.0""filter-2.0"
-
400
application/json
Bad request, malformed syntax, errors in params or the report request is not valid.
Errors occured during the Filter creation.
- application/jsonobject
Errors occured during the Filter creation.
application/json properties
- errorsarray of objectsRequired
-
401
application/json
Unauthorized, JWT invalid or not provided.
Errors occured during the Filter creation.
- application/jsonobject
Errors occured during the Filter creation.
application/json properties
- errorsarray of objectsRequired
-
403
application/json
Forbidden, user lacks sufficient permissions to access the resource.
Errors occured during the Filter creation.
- application/jsonobject
Errors occured during the Filter creation.
application/json properties
- errorsarray of objectsRequired
-
404
application/json
Not found.
Errors occured during the Filter creation.
- application/jsonobject
Errors occured during the Filter creation.
application/json properties
- errorsarray of objectsRequired
-
409
application/json
Filter name conflict.
Errors occured during the Filter creation.
- application/jsonobject
Errors occured during the Filter creation.
application/json properties
- errorsarray of objectsRequired
-
429
application/json
Too many request. Indicates the user has sent too many requests in a given amount of time, aka "rate limiting".
Errors occured during the Filter creation.
- application/jsonobject
Errors occured during the Filter creation.
application/json properties
- errorsarray of objectsRequired
-
500
application/json
Internal server error.
Errors occured during the Filter creation.
- application/jsonobject
Errors occured during the Filter creation.
application/json properties
- errorsarray of objectsRequired
-
curl "https://your-tenant.us.qlikcloud.com/api/v1/apps/{appId}/report-filters" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer <API-key>" \
-d '{"name":"Filter sample","filterType":"REP","filterV1_0":{"fieldsByState":{"$":[{"name":"Country","values":[{"valueType":"string","valueAsText":"1-Argentina"},{"valueType":"string","valueAsText":"4-Brazil"}],"overrideValues":false,"selectExcluded":false},{"name":"Order number","values":[{"valueType":"number","valueAsText":"61300","valueAsNumber":61300}],"overrideValues":false,"selectExcluded":false}]}},"description":"this is a filter sample","filterVersion":"filter-1.0"}'
const https = require('https')
const data = JSON.stringify({"name":"Filter sample","filterType":"REP","filterV1_0":{"fieldsByState":{"$":[{"name":"Country","values":[{"valueType":"string","valueAsText":"1-Argentina"},{"valueType":"string","valueAsText":"4-Brazil"}],"overrideValues":false,"selectExcluded":false},{"name":"Order number","values":[{"valueType":"number","valueAsText":"61300","valueAsNumber":61300}],"overrideValues":false,"selectExcluded":false}]}},"description":"this is a filter sample","filterVersion":"filter-1.0"})
const options = {
'hostname': 'https://your-tenant.us.qlikcloud.com',
'port': 443,
'path': '/api/v1/apps/{appId}/report-filters',
'method': 'POST',
'headers': {
'Content-type': 'application/json',
'Authorization': 'Bearer <API-key>'
}
}
const req = https.request(options)
req.write(data)
This API is not included yet in qlik-cli
Request
{
"name": "Filter sample",
"filterType": "REP",
"filterV1_0": {
"fieldsByState": {
"$": [
{
"name": "Country",
"values": [
{
"valueType": "string",
"valueAsText": "1-Argentina"
},
{
"valueType": "string",
"valueAsText": "4-Brazil"
}
],
"overrideValues": false,
"selectExcluded": false
},
{
"name": "Order number",
"values": [
{
"valueType": "number",
"valueAsText": "61300",
"valueAsNumber": 61300
}
],
"overrideValues": false,
"selectExcluded": false
}
]
}
},
"description": "this is a filter sample",
"filterVersion": "filter-1.0"
}
Response
{
"id": "c61841ac-7b35-4434-aa74-4421f10fc68e",
"name": "Filter 1",
"ownerId": "649173fbc8ffcfde27412b99",
"createdAt": "2023-08-09T08:19:37.577Z",
"updatedAt": "2023-08-09T08:19:37.577Z",
"filterType": "REP",
"filterV1_0": {
"fieldsByState": {
"$": [
{
"name": "Country",
"values": [
{
"valueType": "string",
"valueAsText": "1-Argentina"
},
{
"valueType": "string",
"valueAsText": "4-Brazil"
}
],
"overrideValues": false,
"selectExcluded": false
},
{
"name": "Order number",
"values": [
{
"valueType": "number",
"valueAsText": "61300",
"valueAsNumber": 61300
}
],
"overrideValues": false,
"selectExcluded": false
}
]
}
},
"description": "This is the filter description",
"filterVersion": "filter-1.0"
}
Facts
Rate limit | Tier 1 (1000 requests per minute) |
Categories | build |
Path Parameters
- appIdstringRequired
Qlik Sense app identifier
- idstringRequired
The filter id identifier (bookmarkId).
Responses
200
application/json
The filter has been successfully returned.
- application/jsonobject
application/json properties
- idstring
The filter ID (bookmarkId).
- namestring
The filter name.
- ownerIdstring
The user that owns the filter, if missing the same as the request user.
- createdAtstring
- updatedAtstring
- filterTypestring
Can be one of: "REP""SUB"
- filterV1_0object
filterV1_0 properties
- variablesarray of objects
- fieldsByStateobject
Map of fields to apply by state. Maximum number of states allowed is 125. Maximum number of fields allowed is 125 and maximum number of overall field values allowed is 150000.
-
- descriptionstring
The filter description.
- filterVersionstring
Can be one of: "filter-1.0""filter-2.0"
-
400
application/json
Bad request. Malformed syntax, errors in params.
Errors occured during the Filter creation.
- application/jsonobject
Errors occured during the Filter creation.
application/json properties
- errorsarray of objectsRequired
-
401
application/json
Unauthorized, JWT invalid or not provided.
Errors occured during the Filter creation.
- application/jsonobject
Errors occured during the Filter creation.
application/json properties
- errorsarray of objectsRequired
-
403
application/json
Forbidden, user lacks sufficient permissions to access the resource.
Errors occured during the Filter creation.
- application/jsonobject
Errors occured during the Filter creation.
application/json properties
- errorsarray of objectsRequired
-
404
application/json
Not found.
Errors occured during the Filter creation.
- application/jsonobject
Errors occured during the Filter creation.
application/json properties
- errorsarray of objectsRequired
-
429
application/json
Too many request. Indicates the user has sent too many requests in a given amount of time, aka "rate limiting".
Errors occured during the Filter creation.
- application/jsonobject
Errors occured during the Filter creation.
application/json properties
- errorsarray of objectsRequired
-
500
application/json
Internal server error.
Errors occured during the Filter creation.
- application/jsonobject
Errors occured during the Filter creation.
application/json properties
- errorsarray of objectsRequired
-
curl "https://your-tenant.us.qlikcloud.com/api/v1/apps/{appId}/report-filters/{id}" \
-H "Authorization: Bearer <API-key>"
const https = require('https')
const data = JSON.stringify("")
const options = {
'hostname': 'https://your-tenant.us.qlikcloud.com',
'port': 443,
'path': '/api/v1/apps/{appId}/report-filters/{id}',
'method': 'GET',
'headers': {
'Authorization': 'Bearer <API-key>'
}
}
const req = https.request(options)
This API is not included yet in qlik-cli
Response
{
"id": "c61841ac-7b35-4434-aa74-4421f10fc68e",
"name": "Filter 1",
"ownerId": "649173fbc8ffcfde27412b99",
"createdAt": "2023-08-09T08:19:37.577Z",
"updatedAt": "2023-08-09T08:19:37.577Z",
"filterType": "REP",
"filterV1_0": {
"fieldsByState": {
"$": [
{
"name": "Country",
"values": [
{
"valueType": "string",
"valueAsText": "1-Argentina"
},
{
"valueType": "string",
"valueAsText": "4-Brazil"
}
],
"overrideValues": false,
"selectExcluded": false
},
{
"name": "Order number",
"values": [
{
"valueType": "number",
"valueAsText": "61300",
"valueAsNumber": 61300
}
],
"overrideValues": false,
"selectExcluded": false
}
]
}
},
"description": "This is the filter description",
"filterVersion": "filter-1.0"
}
Facts
Rate limit | Tier 2 (100 requests per minute) |
Categories | build |
Path Parameters
- appIdstringRequired
Qlik Sense app identifier
- idstringRequired
The filter id identifier (bookmarkId).
Request Body
Requiredapplication/json
The filter definition that will replace the existing one.
- application/jsonarray of objects
application/json properties
- opstringRequired
operation (replace).
Can be one of: "replace"
- pathstringRequired
A JSON Pointer path (/).
Can be one of: "/filter"
- valueobjectRequired
The value to be used for this operation. The properties that cannot be patched include id, filterType, appId
value properties
- Filterobject
Filter properties
- namestring
The filter name.
- ownerIdstring
The user that owns the filter, if missing the same as the request user.
- filterV1_0object
filterV1_0 properties
- variablesarray of objects
- fieldsByStateobject
Map of fields to apply by state. Maximum number of states allowed is 125. Maximum number of fields allowed is 125 and maximum number of overall field values allowed is 150000.
-
- descriptionstring
The filter description.
- filterVersionstring
Can be one of: "filter-1.0""filter-2.0"
-
-
-
Responses
204
The filter has been successfully patched.
400
application/json
Bad request. Malformed syntax, errors in params.
Errors occured during the Filter creation.
- application/jsonobject
Errors occured during the Filter creation.
application/json properties
- errorsarray of objectsRequired
-
401
application/json
Unauthorized, JWT invalid or not provided.
Errors occured during the Filter creation.
- application/jsonobject
Errors occured during the Filter creation.
application/json properties
- errorsarray of objectsRequired
-
403
application/json
Forbidden, user lacks sufficient permissions to access the resource.
Errors occured during the Filter creation.
- application/jsonobject
Errors occured during the Filter creation.
application/json properties
- errorsarray of objectsRequired
-
404
application/json
Not found.
Errors occured during the Filter creation.
- application/jsonobject
Errors occured during the Filter creation.
application/json properties
- errorsarray of objectsRequired
-
409
application/json
Filter name conflict. A filter with the same name already exists.
Errors occured during the Filter creation.
- application/jsonobject
Errors occured during the Filter creation.
application/json properties
- errorsarray of objectsRequired
-
429
application/json
Too many request. Indicates the user has sent too many requests in a given amount of time, aka "rate limiting".
Errors occured during the Filter creation.
- application/jsonobject
Errors occured during the Filter creation.
application/json properties
- errorsarray of objectsRequired
-
500
application/json
Internal server error.
Errors occured during the Filter creation.
- application/jsonobject
Errors occured during the Filter creation.
application/json properties
- errorsarray of objectsRequired
-
curl "https://your-tenant.us.qlikcloud.com/api/v1/apps/{appId}/report-filters/{id}" \
-X PATCH \
-H "Content-type: application/json" \
-H "Authorization: Bearer <API-key>" \
-d '[{"op":"replace","path":"/filter","value":{"Filter":{"name":"Filter 1","ownerId":"649173fbc8ffcfde27412b99","filterV1_0":{"fieldsByState":{"$":[{"name":"Country","values":[{"valueType":"string","valueAsText":"1-Argentina"},{"valueType":"string","valueAsText":"4-Brazil"}],"overrideValues":false,"selectExcluded":false},{"name":"Order number","values":[{"valueType":"number","valueAsText":"61300","valueAsNumber":61300}],"overrideValues":false,"selectExcluded":false}]}},"description":"This is the filter description","filterVersion":"filter-1.0"}}}]'
const https = require('https')
const data = JSON.stringify([{"op":"replace","path":"/filter","value":{"Filter":{"name":"Filter 1","ownerId":"649173fbc8ffcfde27412b99","filterV1_0":{"fieldsByState":{"$":[{"name":"Country","values":[{"valueType":"string","valueAsText":"1-Argentina"},{"valueType":"string","valueAsText":"4-Brazil"}],"overrideValues":false,"selectExcluded":false},{"name":"Order number","values":[{"valueType":"number","valueAsText":"61300","valueAsNumber":61300}],"overrideValues":false,"selectExcluded":false}]}},"description":"This is the filter description","filterVersion":"filter-1.0"}}}])
const options = {
'hostname': 'https://your-tenant.us.qlikcloud.com',
'port': 443,
'path': '/api/v1/apps/{appId}/report-filters/{id}',
'method': 'PATCH',
'headers': {
'Content-type': 'application/json',
'Authorization': 'Bearer <API-key>'
}
}
const req = https.request(options)
req.write(data)
This API is not included yet in qlik-cli
Request
[
{
"op": "replace",
"path": "/filter",
"value": {
"Filter": {
"name": "Filter 1",
"ownerId": "649173fbc8ffcfde27412b99",
"filterV1_0": {
"fieldsByState": {
"$": [
{
"name": "Country",
"values": [
{
"valueType": "string",
"valueAsText": "1-Argentina"
},
{
"valueType": "string",
"valueAsText": "4-Brazil"
}
],
"overrideValues": false,
"selectExcluded": false
},
{
"name": "Order number",
"values": [
{
"valueType": "number",
"valueAsText": "61300",
"valueAsNumber": 61300
}
],
"overrideValues": false,
"selectExcluded": false
}
]
}
},
"description": "This is the filter description",
"filterVersion": "filter-1.0"
}
}
}
]
Facts
Rate limit | Tier 2 (100 requests per minute) |
Categories | build |
Path Parameters
- appIdstringRequired
Qlik Sense app identifier
- idstringRequired
The filter id identifier (bookmarkId).
Responses
204
The filter has been successfully deleted.
400
application/json
Bad request. Malformed syntax, errors in params.
Errors occured during the Filter creation.
- application/jsonobject
Errors occured during the Filter creation.
application/json properties
- errorsarray of objectsRequired
-
401
application/json
Unauthorized, JWT invalid or not provided.
Errors occured during the Filter creation.
- application/jsonobject
Errors occured during the Filter creation.
application/json properties
- errorsarray of objectsRequired
-
403
application/json
Forbidden, user lacks sufficient permissions to access the resource.
Errors occured during the Filter creation.
- application/jsonobject
Errors occured during the Filter creation.
application/json properties
- errorsarray of objectsRequired
-
404
application/json
Not found.
Errors occured during the Filter creation.
- application/jsonobject
Errors occured during the Filter creation.
application/json properties
- errorsarray of objectsRequired
-
429
application/json
Too many request. Indicates the user has sent too many requests in a given amount of time, aka "rate limiting".
Errors occured during the Filter creation.
- application/jsonobject
Errors occured during the Filter creation.
application/json properties
- errorsarray of objectsRequired
-
500
application/json
Internal server error.
Errors occured during the Filter creation.
- application/jsonobject
Errors occured during the Filter creation.
application/json properties
- errorsarray of objectsRequired
-
curl "https://your-tenant.us.qlikcloud.com/api/v1/apps/{appId}/report-filters/{id}" \
-X DELETE \
-H "Authorization: Bearer <API-key>"
const https = require('https')
const data = JSON.stringify("")
const options = {
'hostname': 'https://your-tenant.us.qlikcloud.com',
'port': 443,
'path': '/api/v1/apps/{appId}/report-filters/{id}',
'method': 'DELETE',
'headers': {
'Authorization': 'Bearer <API-key>'
}
}
const req = https.request(options)
This API is not included yet in qlik-cli
Facts
Rate limit | Tier 1 (1000 requests per minute) |
Categories | build |
Query Parameters
- filterTypesarray of stringsRequired
The filter type (REP, SUB). REP stands for report bookmark, SUB for subscription bookmark.
Values may be any of: "REP""SUB"
Path Parameters
- appIdstringRequired
Qlik Sense app identifier
Responses
200
application/json
The count of filters.
- application/jsonobject
application/json properties
- totalnumber
The total number of filters.
-
400
application/json
Bad request. Malformed syntax, errors in params.
Errors occured during the Filter creation.
- application/jsonobject
Errors occured during the Filter creation.
application/json properties
- errorsarray of objectsRequired
-
401
application/json
Unauthorized, JWT invalid or not provided.
Errors occured during the Filter creation.
- application/jsonobject
Errors occured during the Filter creation.
application/json properties
- errorsarray of objectsRequired
-
403
application/json
Forbidden, user lacks sufficient permissions to access the resource.
Errors occured during the Filter creation.
- application/jsonobject
Errors occured during the Filter creation.
application/json properties
- errorsarray of objectsRequired
-
404
application/json
Not found.
Errors occured during the Filter creation.
- application/jsonobject
Errors occured during the Filter creation.
application/json properties
- errorsarray of objectsRequired
-
429
application/json
Too many request. Indicates the user has sent too many requests in a given amount of time, aka "rate limiting".
Errors occured during the Filter creation.
- application/jsonobject
Errors occured during the Filter creation.
application/json properties
- errorsarray of objectsRequired
-
500
application/json
Internal server error.
Errors occured during the Filter creation.
- application/jsonobject
Errors occured during the Filter creation.
application/json properties
- errorsarray of objectsRequired
-
curl "https://your-tenant.us.qlikcloud.com/api/v1/apps/{appId}/report-filters/actions/count" \
-H "Authorization: Bearer <API-key>"
const https = require('https')
const data = JSON.stringify("")
const options = {
'hostname': 'https://your-tenant.us.qlikcloud.com',
'port': 443,
'path': '/api/v1/apps/{appId}/report-filters/actions/count',
'method': 'GET',
'headers': {
'Authorization': 'Bearer <API-key>'
}
}
const req = https.request(options)
This API is not included yet in qlik-cli
Response
{
"total": 20
}
Retrieves the script history for an app. Returns information about the saved versions of the script in a list sorted with latest first.
Retrieves the script history for an app. Returns information about the saved versions of the script in a list sorted with latest first.
Facts
Rate limit | Tier 1 (1000 requests per minute) |
Categories | managebuild |
Query Parameters
- filterstring
A scim filter expression defining which script versions should be retrieved. Filterable fields are:
- ScriptId
- ModifiedTime
- ModifierId
- limitstring
Maximum number of records to return from this request.
- pagestring
Opaque definition of which page of the result set to return. Returned from a previous call using the same filter. Not yet supported.
Path Parameters
- appIdstringRequired
Identifier of the app.
Responses
200
application/json
OK
- application/jsonobject
application/json properties
- linksobject
links properties
- nextobject
next properties
- hrefstring
-
- prevobject
prev properties
- hrefstring
-
-
- scriptsarray of objects
Script versions metadata.
scripts properties
- sizeinteger
Script size.
- scriptIdstring
Script id.
- modifierIdstring
User last modifying script version.
- modifiedTimestring
Script version last modification time.
- versionMessagestring
Description of this script version
-
-
curl "https://your-tenant.us.qlikcloud.com/api/v1/apps/{appId}/scripts" \
-H "Authorization: Bearer <API-key>"
const https = require('https')
const data = JSON.stringify("")
const options = {
'hostname': 'https://your-tenant.us.qlikcloud.com',
'port': 443,
'path': '/api/v1/apps/{appId}/scripts',
'method': 'GET',
'headers': {
'Authorization': 'Bearer <API-key>'
}
}
const req = https.request(options)
qlik app script version ls \
--appId="string"
Response
{
"links": {
"next": {
"href": "string"
},
"prev": {
"href": "string"
}
},
"scripts": [
{
"size": 42,
"scriptId": "string",
"modifierId": "string",
"modifiedTime": "string",
"versionMessage": "string"
}
]
}
Sets script for an app.
Facts
Rate limit | Tier 2 (100 requests per minute) |
Categories | managebuild |
Path Parameters
- appIdstringRequired
Identifier of the app.
Request Body
Required*/*
The script to set.
- */*object
*/* properties
- scriptstring
Script text.
- versionMessagestring
Description of this script version
-
Responses
200
OK
curl "https://your-tenant.us.qlikcloud.com/api/v1/apps/{appId}/scripts" \
-X POST \
-H "Content-type: */*" \
-H "Authorization: Bearer <API-key>" \
-d '{"script":"string","versionMessage":"string"}'
const https = require('https')
const data = JSON.stringify({"script":"string","versionMessage":"string"})
const options = {
'hostname': 'https://your-tenant.us.qlikcloud.com',
'port': 443,
'path': '/api/v1/apps/{appId}/scripts',
'method': 'POST',
'headers': {
'Content-type': '*/*',
'Authorization': 'Bearer <API-key>'
}
}
const req = https.request(options)
req.write(data)
qlik app script version create \
--appId="string" \
--script="string" \
--versionMessage="string"
Request
{
"script": "string",
"versionMessage": "string"
}
Retrieves a version of the script for an app. Returns the script text.
Facts
Rate limit | Tier 1 (1000 requests per minute) |
Categories | managebuild |
Path Parameters
- appIdstringRequired
Identifier of the app.
- idstringRequired
Identifier of the script version, or 'current' for retrieving the current version.
Responses
200
application/json
OK
- application/jsonobject
application/json properties
- scriptstring
Script text.
- versionMessagestring
Description of this script version
-
curl "https://your-tenant.us.qlikcloud.com/api/v1/apps/{appId}/scripts/{id}" \
-H "Authorization: Bearer <API-key>"
const https = require('https')
const data = JSON.stringify("")
const options = {
'hostname': 'https://your-tenant.us.qlikcloud.com',
'port': 443,
'path': '/api/v1/apps/{appId}/scripts/{id}',
'method': 'GET',
'headers': {
'Authorization': 'Bearer <API-key>'
}
}
const req = https.request(options)
This API is not included yet in qlik-cli
Response
{
"script": "string",
"versionMessage": "string"
}
Updates a specific version of the script for an app.
Facts
Rate limit | Tier 2 (100 requests per minute) |
Categories | managebuild |
Path Parameters
- appIdstringRequired
Identifier of the app.
- idstringRequired
Identifier of the script version.
Request Body
Required*/*
Array of patches for the object ScriptVersion.
- */*array of objects
*/* properties
- Opstring
Can be one of: "add""remove""replace"
- Pathstring
Path to the property to add, remove or replace.
- Valuestring
This parameter is not used in a remove operation. Corresponds to the value of the property to add or to the new value of the property to update. Examples: "false", "2", ""New title""
-
Responses
200
OK
curl "https://your-tenant.us.qlikcloud.com/api/v1/apps/{appId}/scripts/{id}" \
-X PATCH \
-H "Content-type: */*" \
-H "Authorization: Bearer <API-key>" \
-d '[{"Path":"string","Value":"string"}]'
const https = require('https')
const data = JSON.stringify([{"Path":"string","Value":"string"}])
const options = {
'hostname': 'https://your-tenant.us.qlikcloud.com',
'port': 443,
'path': '/api/v1/apps/{appId}/scripts/{id}',
'method': 'PATCH',
'headers': {
'Content-type': '*/*',
'Authorization': 'Bearer <API-key>'
}
}
const req = https.request(options)
req.write(data)
This API is not included yet in qlik-cli
Request
[
{
"Path": "string",
"Value": "string"
}
]
Deletes a specific version of the script for an app. Fails if the supplied id is the current version.
Deletes a specific version of the script for an app. Fails if the supplied id is the current version.
Facts
Rate limit | Tier 2 (100 requests per minute) |
Categories | managebuild |
Path Parameters
- appIdstringRequired
Identifier of the app.
- idstringRequired
Identifier of the script version
Responses
200
OK
curl "https://your-tenant.us.qlikcloud.com/api/v1/apps/{appId}/scripts/{id}" \
-X DELETE \
-H "Authorization: Bearer <API-key>"
const https = require('https')
const data = JSON.stringify("")
const options = {
'hostname': 'https://your-tenant.us.qlikcloud.com',
'port': 443,
'path': '/api/v1/apps/{appId}/scripts/{id}',
'method': 'DELETE',
'headers': {
'Authorization': 'Bearer <API-key>'
}
}
const req = https.request(options)
This API is not included yet in qlik-cli
Sets space on a specific app.
Facts
Rate limit | Tier 2 (100 requests per minute) |
Categories | managebuild |
Path Parameters
- appIdstringRequired
Identifier of the app.
Request Body
Required*/*
New space.
- */*object
*/* properties
- spaceIdstring
-
Responses
200
application/json
OK
Application attributes and user privileges.
- application/jsonobject
Application attributes and user privileges.
application/json properties
- createarray of objects
- attributesobject
App attributes. This structure can also contain extra user-defined attributes.
attributes properties
- idstring
The App ID.
- namestring
App name.
- ownerstringDeprecated
Deprecated. Use the Users API to fetch user metadata.
- usagestring
Can be one of: "ANALYTICS""DATA_PREPARATION""DATAFLOW_PREP""SINGLE_TABLE_PREP"
- customobject
Contains dynamic JSON data specified by the client.
- ownerIdstring
Identifier of the app owner.
- encryptedboolean
If set to true, the app is encrypted.
- publishedboolean
True if the app is published on-prem, distributed in QCS, false if not.
- thumbnailstring
App thumbnail.
- createdDatestring
The date and time when the app was created.
- descriptionstring
App description.
- originAppIdstring
The Origin App ID for published apps.
- publishTimestring
The date and time when the app was published, empty if unpublished.
- dynamicColorstring
The dynamic color of the app.
- modifiedDatestring
The date and time when the app was modified.
- lastReloadTimestring
Date and time of the last reload of the app.
- hasSectionAccessboolean
If set to true, the app has section access configured,
- isDirectQueryModeboolean
True if the app is a Direct Query app, false if not
-
- privilegesarray of strings
Application privileges. Hints to the client what actions the user is allowed to perform. Could be any of:
- read
- create
- update
- delete
- reload
- import
- publish
- duplicate
- export
- exportdata
- change_owner
- change_space
-
curl "https://your-tenant.us.qlikcloud.com/api/v1/apps/{appId}/space" \
-X PUT \
-H "Content-type: */*" \
-H "Authorization: Bearer <API-key>" \
-d '{"spaceId":"string"}'
const https = require('https')
const data = JSON.stringify({"spaceId":"string"})
const options = {
'hostname': 'https://your-tenant.us.qlikcloud.com',
'port': 443,
'path': '/api/v1/apps/{appId}/space',
'method': 'PUT',
'headers': {
'Content-type': '*/*',
'Authorization': 'Bearer <API-key>'
}
}
const req = https.request(options)
req.write(data)
qlik app space update <appId> \
--spaceId="string"
Request
{
"spaceId": "string"
}
Response
{
"create": [
{}
],
"attributes": {
"id": "string",
"name": "string",
"owner": "string",
"custom": {},
"ownerId": "string",
"encrypted": true,
"published": true,
"thumbnail": "string",
"createdDate": "2018-10-30T07:06:22Z",
"description": "string",
"originAppId": "string",
"publishTime": "2018-10-30T07:06:22Z",
"dynamicColor": "string",
"modifiedDate": "2018-10-30T07:06:22Z",
"lastReloadTime": "2018-10-30T07:06:22Z",
"hasSectionAccess": true,
"isDirectQueryMode": true
},
"privileges": [
"string"
]
}
Removes space from a specific app.
Facts
Rate limit | Tier 2 (100 requests per minute) |
Categories | managebuild |
Path Parameters
- appIdstringRequired
Identifier of the app.
Responses
200
application/json
OK
Application attributes and user privileges.
- application/jsonobject
Application attributes and user privileges.
application/json properties
- createarray of objects
- attributesobject
App attributes. This structure can also contain extra user-defined attributes.
attributes properties
- idstring
The App ID.
- namestring
App name.
- ownerstringDeprecated
Deprecated. Use the Users API to fetch user metadata.
- usagestring
Can be one of: "ANALYTICS""DATA_PREPARATION""DATAFLOW_PREP""SINGLE_TABLE_PREP"
- customobject
Contains dynamic JSON data specified by the client.
- ownerIdstring
Identifier of the app owner.
- encryptedboolean
If set to true, the app is encrypted.
- publishedboolean
True if the app is published on-prem, distributed in QCS, false if not.
- thumbnailstring
App thumbnail.
- createdDatestring
The date and time when the app was created.
- descriptionstring
App description.
- originAppIdstring
The Origin App ID for published apps.
- publishTimestring
The date and time when the app was published, empty if unpublished.
- dynamicColorstring
The dynamic color of the app.
- modifiedDatestring
The date and time when the app was modified.
- lastReloadTimestring
Date and time of the last reload of the app.
- hasSectionAccessboolean
If set to true, the app has section access configured,
- isDirectQueryModeboolean
True if the app is a Direct Query app, false if not
-
- privilegesarray of strings
Application privileges. Hints to the client what actions the user is allowed to perform. Could be any of:
- read
- create
- update
- delete
- reload
- import
- publish
- duplicate
- export
- exportdata
- change_owner
- change_space
-
curl "https://your-tenant.us.qlikcloud.com/api/v1/apps/{appId}/space" \
-X DELETE \
-H "Authorization: Bearer <API-key>"
const https = require('https')
const data = JSON.stringify("")
const options = {
'hostname': 'https://your-tenant.us.qlikcloud.com',
'port': 443,
'path': '/api/v1/apps/{appId}/space',
'method': 'DELETE',
'headers': {
'Authorization': 'Bearer <API-key>'
}
}
const req = https.request(options)
qlik app space rm <appId>
Response
{
"create": [
{}
],
"attributes": {
"id": "string",
"name": "string",
"owner": "string",
"custom": {},
"ownerId": "string",
"encrypted": true,
"published": true,
"thumbnail": "string",
"createdDate": "2018-10-30T07:06:22Z",
"description": "string",
"originAppId": "string",
"publishTime": "2018-10-30T07:06:22Z",
"dynamicColor": "string",
"modifiedDate": "2018-10-30T07:06:22Z",
"lastReloadTime": "2018-10-30T07:06:22Z",
"hasSectionAccess": true,
"isDirectQueryMode": true
},
"privileges": [
"string"
]
}
Find all evaluations for an app GUID. Supports paging via next, prev which are sent in the response body
Facts
Rate limit | Tier 1 (1000 requests per minute) |
Categories | managebuild |
Query Parameters
- allboolean
Get the full data of the evaluation
- fileModeboolean
Add file transfer headers to response
- formatstring
Specify output format, currently supported are 'json' and 'xml'
- limitinteger
Number of results to return per page.
- nextstring
The app evaluation id to get next page from
- prevstring
The app evaluation id to get previous page from
- sortstring
Property to sort list on
Path Parameters
- guidstringRequired