Clears the cache for apps api requests.
Copies a specific app.
Copies a specific app.
Identifier of the app.
an object with the body content
Optional
options: ApiCallOptionsGet the number of filters for the given app and filter types
Get the number of filters for the given app and filter types
Qlik Sense app identifier
an object with query parameters
The filter type (REP, SUB). REP stands for report bookmark, SUB for subscription bookmark.
Optional
options: ApiCallOptionsCreates a new app.
Creates a new app.
an object with the body content
Optional
options: ApiCallOptionsCreates a new report filter which is used to re-apply selections, variables, patches to an engine session.
Creates a new report filter which is used to re-apply selections, variables, patches to an engine session.
Qlik Sense app identifier
an object with the body content
Optional
options: ApiCallOptionsDeletes a specific app.
Deletes a specific app.
Identifier of the app.
Optional
options: ApiCallOptionsDeletes 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.
Unique application identifier.
Path to file content.
Optional
options: ApiCallOptionsDelete a filter
Delete a filter
Qlik Sense app identifier
The filter id identifier (bookmarkId).
Optional
options: ApiCallOptionsDeletes 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.
Identifier of the app.
Identifier of the script version
Optional
options: ApiCallOptionsExports a specific app.
Exports a specific app.
Identifier of the app.
an object with query parameters
Optional
NoData?: booleanThe flag indicating if only object contents should be exported.
Optional
options: ApiCallOptionsRetrieves 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.
Identifier of the app.
Optional
options: ApiCallOptionsRetrieves 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.
Identifier of the app.
Optional
options: ApiCallOptionsFind an evaluation by a specific id.
Find an evaluation by a specific id.
Id of the desired evaluation.
an object with query parameters
Optional
all?: booleanGet the full data of the evaluation
Optional
format?: stringSpecify output format, currently supported are 'json' and 'xml'
Optional
options: ApiCallOptionsAccepts two evaluation ids and returns a comparison denoting the differences between the two.
Accepts two evaluation ids and returns a comparison denoting the differences between the two.
Id of the baseline evaluation
Id of the comparison evaluation
an object with query parameters
Optional
all?: booleanGet the full list of comparisons including non-significant diffs
Optional
format?: stringSpecify output format, currently supported are 'json' and 'xml'
Optional
options: ApiCallOptionsAccepts two evaluation ids and downloads a log, in XML format, denoting the differences between the two.
Accepts two evaluation ids and downloads a log, in XML format, denoting the differences between the two.
Id of the baseline evaluation
Id of the comparison evaluation
Optional
options: ApiCallOptionsFind all evaluations for an app GUID. Supports paging via next, prev which are sent in the response body
Find all evaluations for an app GUID. Supports paging via next, prev which are sent in the response body
The app guid.
an object with query parameters
Optional
all?: booleanGet the full data of the evaluation
Optional
fileMode?: booleanAdd file transfer headers to response
Optional
format?: stringSpecify output format, currently supported are 'json' and 'xml'
Optional
limit?: numberNumber of results to return per page.
Optional
next?: stringThe app evaluation id to get next page from
Optional
prev?: stringThe app evaluation id to get previous page from
Optional
sort?: stringProperty to sort list on
Optional
options: ApiCallOptionsFind and download an evaluation log by a specific evaluation id.
Find and download an evaluation log by a specific evaluation id.
Id of the desired evaluation.
Optional
options: ApiCallOptionsRetrieves information for a specific app.
Retrieves information for a specific app.
Identifier of the app.
Optional
options: ApiCallOptionsReturns 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.
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.
Qlik Sense app identifier
Optional
options: ApiCallOptionsReturns 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.
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.
Qlik Sense app identifier
Optional
options: ApiCallOptionsReturns 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.
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.
Qlik Sense app identifier
an object with the body content
Optional
options: ApiCallOptionsGets 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.
Unique application identifier.
Path to file content.
Optional
options: ApiCallOptionsLists 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.
Unique application identifier.
The path to sub folder with static content relative to the root folder. Use empty path to access the root folder.
an object with query parameters
Optional
show?: stringOptional. List output can include files and folders in different ways:
Optional
options: ApiCallOptionsRetrieves the log of a specific reload. Returns the log as "text/plain; charset=UTF-8".
Retrieves the log of a specific reload. Returns the log as "text/plain; charset=UTF-8".
Identifier of the app.
Identifier of the reload.
Optional
options: ApiCallOptionsRetrieves 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.
Identifier of the app.
Optional
options: ApiCallOptionsRetrieves 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.
Identifier of the app
Identifier of the reload. Use empty reloadId to get all reloads.
an object with query parameters
Optional
includeSkipStoreReloads?: booleanInclude metadata for reloads ran with SkipStore flag set to true. Default: false
Optional
limit?: stringMaximum number of records to return from this request. Default: 100
Optional
options: ApiCallOptionsGet a filter
Get a filter
Qlik Sense app identifier
The filter id identifier (bookmarkId).
Optional
options: ApiCallOptionsList 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.
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.
Qlik Sense app identifier
an object with query parameters
Optional
filter?: stringThe 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 the eq
(equals) operator: ownerId
Example:
(name co "query1" or description co "query2") and ownerId eq "123"
The filter type (REP, SUB). REP stands for report bookmark, SUB for subscription bookmark.
Optional
limit?: numberLimit the returned result set
Optional
page?: stringIf present, the cursor that starts the page of data that is returned.
Optional
sort?: (Sorting parameters.
Optional
options: ApiCallOptionsRetrieves a version of the script for an app. Returns the script text.
Retrieves a version of the script for an app. Returns the script text.
Identifier of the app.
Identifier of the script version, or 'current' for retrieving the current version.
Optional
options: ApiCallOptionsRetrieves 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.
Identifier of the app.
an object with query parameters
Optional
filter?: stringA scim filter expression defining which script versions should be retrieved. Filterable fields are:
Optional
limit?: stringMaximum number of records to return from this request.
Optional
page?: stringOpaque definition of which page of the result set to return. Returned from a previous call using the same filter. Not yet supported.
Optional
options: ApiCallOptionsGets the app privileges for the current user, such as create app and import app. Empty means that the current user has no app privileges.
Gets the app privileges for the current user, such as create app and import app. Empty means that the current user has no app privileges.
Optional
options: ApiCallOptionsGets 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.
Unique application identifier.
Optional
options: ApiCallOptionsImports an app into the system.
Imports an app into the system.
an object with query parameters
Optional
appId?: stringThe app ID of the target app when source is qvw file.
Optional
fallbackName?: stringThe name of the target app when source does not have a specified name, applicable if source is qvw file.
Optional
fileId?: stringThe file ID to be downloaded from Temporary Content Service (TCS) and used during import.
Optional
mode?: stringThe import mode. In new
mode (default), the source app will be imported as a new app.
autoreplace
mode is an internal mode only and is not permitted for external use.One of:
Optional
name?: stringThe name of the target app.
Optional
NoData?: booleanIf NoData is true, the data of the existing app will be kept as is, otherwise it will be replaced by the new incoming data.
Optional
spaceId?: stringThe space ID of the target app.
an object with the body content
Optional
options: ApiCallOptionsSets space on a specific app.
Sets space on a specific app.
Identifier of the app.
an object with the body content
Optional
options: ApiCallOptionsUpdate a filter
Update a filter
Qlik Sense app identifier
The filter id identifier (bookmarkId).
an object with the body content
Optional
options: ApiCallOptionsUpdates a specific version of the script for an app.
Updates a specific version of the script for an app.
Identifier of the app.
Identifier of the script version.
an object with the body content
Optional
options: ApiCallOptionsPublishes a specific app to a managed space.
Publishes a specific app to a managed space.
Identifier of the app.
an object with the body content
Optional
options: ApiCallOptionsQueue an app evaluation by its app guid.
Queue an app evaluation by its app guid.
Guid of the app.
Optional
options: ApiCallOptionsRemoves space from a specific app.
Removes space from a specific app.
Identifier of the app.
Optional
options: ApiCallOptionsRepublishes a published app to a managed space.
Republishes a published app to a managed space.
Identifier of the app.
an object with the body content
Optional
options: ApiCallOptionsUpdates the information for a specific app.
Updates the information for a specific app.
Identifier of the app.
an object with the body content
Optional
options: ApiCallOptionsSets owner on an app object. The user must be the owner of the object.
Sets owner on an app object. The user must be the owner of the object.
Identifier of the app.
Identifier of the object.
an object with the body content
Optional
options: ApiCallOptionsChanges owner of the app.
Changes owner of the app.
Identifier of the app.
an object with the body content
Optional
options: ApiCallOptionsSets script for an app.
Sets script for an app.
Identifier of the app.
an object with the body content
Optional
options: ApiCallOptionsStores 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.
Unique application identifier.
Path to file content.
an object with the body content
Optional
options: ApiCallOptions
Clears the cache for apps api requests.