Type Alias AppsAPI

type AppsAPI = {
    clearCache: typeof clearCache;
    copyApp: typeof copyApp;
    countAppReportFilters: typeof countAppReportFilters;
    createApp: typeof createApp;
    createAppReportFilter: typeof createAppReportFilter;
    deleteApp: typeof deleteApp;
    deleteAppMedia: typeof deleteAppMedia;
    deleteAppReportFilter: typeof deleteAppReportFilter;
    deleteAppScript: typeof deleteAppScript;
    exportApp: typeof exportApp;
    getAppDataLineage: typeof getAppDataLineage;
    getAppDataMetadata: typeof getAppDataMetadata;
    getAppEvaluation: typeof getAppEvaluation;
    getAppEvaluationComparison: typeof getAppEvaluationComparison;
    getAppEvaluationComparisonXml: typeof getAppEvaluationComparisonXml;
    getAppEvaluations: typeof getAppEvaluations;
    getAppEvaluationXml: typeof getAppEvaluationXml;
    getAppInfo: typeof getAppInfo;
    getAppInsightAnalyses: typeof getAppInsightAnalyses;
    getAppInsightAnalysisModel: typeof getAppInsightAnalysisModel;
    getAppInsightAnalysisRecommendations: typeof getAppInsightAnalysisRecommendations;
    getAppMedia: typeof getAppMedia;
    getAppMediaList: typeof getAppMediaList;
    getAppReloadLog: typeof getAppReloadLog;
    getAppReloadLogs: typeof getAppReloadLogs;
    getAppReloadMetadata: typeof getAppReloadMetadata;
    getAppReportFilter: typeof getAppReportFilter;
    getAppReportFilters: typeof getAppReportFilters;
    getAppScript: typeof getAppScript;
    getAppScriptHistory: typeof getAppScriptHistory;
    getAppsPrivileges: typeof getAppsPrivileges;
    getAppThumbnail: typeof getAppThumbnail;
    importApp: typeof importApp;
    moveAppToSpace: typeof moveAppToSpace;
    patchAppReportFilter: typeof patchAppReportFilter;
    patchAppScript: typeof patchAppScript;
    publishApp: typeof publishApp;
    queueAppEvaluation: typeof queueAppEvaluation;
    removeAppFromSpace: typeof removeAppFromSpace;
    republishApp: typeof republishApp;
    updateAppInfo: typeof updateAppInfo;
    updateAppObjectOwner: typeof updateAppObjectOwner;
    updateAppOwner: typeof updateAppOwner;
    updateAppScript: typeof updateAppScript;
    uploadAppMedia: typeof uploadAppMedia;
}
Index

Properties

clearCache: typeof clearCache

Clears the cache for apps api requests.

copyApp: typeof copyApp

Copies a specific app.

Identifier of the app.

an object with the body content

CopyAppHttpError

countAppReportFilters: typeof countAppReportFilters

Get the number of filters for the given app and filter types

Qlik Sense app identifier

an object with query parameters

CountAppReportFiltersHttpError

createApp: typeof createApp

Creates a new app.

an object with the body content

CreateAppHttpError

createAppReportFilter: typeof createAppReportFilter

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

CreateAppReportFilterHttpError

deleteApp: typeof deleteApp

Deletes a specific app.

Identifier of the app.

DeleteAppHttpError

deleteAppMedia: typeof deleteAppMedia

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.

DeleteAppMediaHttpError

deleteAppReportFilter: typeof deleteAppReportFilter

Delete a filter

Qlik Sense app identifier

The filter id identifier (bookmarkId).

DeleteAppReportFilterHttpError

deleteAppScript: typeof deleteAppScript

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

DeleteAppScriptHttpError

exportApp: typeof exportApp

Exports a specific app.

Identifier of the app.

an object with query parameters

ExportAppHttpError

getAppDataLineage: typeof getAppDataLineage

Retrieves the lineage for an app. Returns a JSON-formatted array of strings describing the lineage of the app.

Identifier of the app.

GetAppDataLineageHttpError

getAppDataMetadata: typeof getAppDataMetadata

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.

GetAppDataMetadataHttpError

getAppEvaluation: typeof getAppEvaluation

Find an evaluation by a specific id.

Id of the desired evaluation.

an object with query parameters

GetAppEvaluationHttpError

getAppEvaluationComparison: typeof getAppEvaluationComparison

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

GetAppEvaluationComparisonHttpError

getAppEvaluationComparisonXml: typeof getAppEvaluationComparisonXml

Accepts two evaluation ids and downloads a log, in XML format, denoting the differences between the two.

getAppEvaluationComparisonXml(
"abcdefghijklmnopq",
"abcdefghijklmnopq"
)

Id of the baseline evaluation

Id of the comparison evaluation

GetAppEvaluationComparisonXmlHttpError

getAppEvaluations: typeof getAppEvaluations

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

GetAppEvaluationsHttpError

getAppEvaluationXml: typeof getAppEvaluationXml

Find and download an evaluation log by a specific evaluation id.

getAppEvaluationXml(
"abcdefghijklmnopq"
)

Id of the desired evaluation.

GetAppEvaluationXmlHttpError

getAppInfo: typeof getAppInfo

Retrieves information for a specific app.

Identifier of the app.

GetAppInfoHttpError

getAppInsightAnalyses: typeof getAppInsightAnalyses

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

GetAppInsightAnalysesHttpError

getAppInsightAnalysisModel: typeof getAppInsightAnalysisModel

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

GetAppInsightAnalysisModelHttpError

getAppInsightAnalysisRecommendations: typeof getAppInsightAnalysisRecommendations

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

GetAppInsightAnalysisRecommendationsHttpError

getAppMedia: typeof getAppMedia

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.

GetAppMediaHttpError

getAppMediaList: typeof getAppMediaList

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

GetAppMediaListHttpError

getAppReloadLog: typeof getAppReloadLog

Retrieves the log of a specific reload. Returns the log as "text/plain; charset=UTF-8".

Identifier of the app.

Identifier of the reload.

GetAppReloadLogHttpError

getAppReloadLogs: typeof getAppReloadLogs

Retrieves the metadata about all script logs stored for an app. Returns an array of ScriptLogMeta objects.

Identifier of the app.

GetAppReloadLogsHttpError

getAppReloadMetadata: typeof getAppReloadMetadata

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

GetAppReloadMetadataHttpError

getAppReportFilter: typeof getAppReportFilter

Get a filter

Qlik Sense app identifier

The filter id identifier (bookmarkId).

GetAppReportFilterHttpError

getAppReportFilters: typeof getAppReportFilters

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

GetAppReportFiltersHttpError

getAppScript: typeof getAppScript

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.

GetAppScriptHttpError

getAppScriptHistory: typeof getAppScriptHistory

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

GetAppScriptHistoryHttpError

getAppsPrivileges: typeof getAppsPrivileges

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.

GetAppsPrivilegesHttpError

getAppThumbnail: typeof getAppThumbnail

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.

GetAppThumbnailHttpError

importApp: typeof importApp

Imports an app into the system.

an object with query parameters

an object with the body content

ImportAppHttpError

moveAppToSpace: typeof moveAppToSpace

Sets space on a specific app.

Identifier of the app.

an object with the body content

MoveAppToSpaceHttpError

patchAppReportFilter: typeof patchAppReportFilter

Update a filter

Qlik Sense app identifier

The filter id identifier (bookmarkId).

an object with the body content

PatchAppReportFilterHttpError

patchAppScript: typeof patchAppScript

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

PatchAppScriptHttpError

publishApp: typeof publishApp

Publishes a specific app to a managed space.

Identifier of the app.

an object with the body content

PublishAppHttpError

queueAppEvaluation: typeof queueAppEvaluation

Queue an app evaluation by its app guid.

queueAppEvaluation(
"abcdefghijklmnopq"
)

Guid of the app.

QueueAppEvaluationHttpError

removeAppFromSpace: typeof removeAppFromSpace

Removes space from a specific app.

Identifier of the app.

RemoveAppFromSpaceHttpError

republishApp: typeof republishApp

Republishes a published app to a managed space.

Identifier of the app.

an object with the body content

RepublishAppHttpError

updateAppInfo: typeof updateAppInfo

Updates the information for a specific app.

Identifier of the app.

an object with the body content

UpdateAppInfoHttpError

updateAppObjectOwner: typeof updateAppObjectOwner

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

UpdateAppObjectOwnerHttpError

updateAppOwner: typeof updateAppOwner

Changes owner of the app.

Identifier of the app.

an object with the body content

UpdateAppOwnerHttpError

updateAppScript: typeof updateAppScript

Sets script for an app.

Identifier of the app.

an object with the body content

UpdateAppScriptHttpError

uploadAppMedia: typeof uploadAppMedia

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

UploadAppMediaHttpError