Interface AppsAPI

interface AppsAPI {
    clearCache: () => void;
    copyApp: (
        appId: string,
        body: CreateApp,
        options?: ApiCallOptions,
    ) => Promise<CopyAppHttpResponse>;
    countAppReportFilters: (
        appId: string,
        query: { filterTypes: ("REP" | "SUB")[] },
        options?: ApiCallOptions,
    ) => Promise<CountAppReportFiltersHttpResponse>;
    createApp: (
        body: CreateApp,
        options?: ApiCallOptions,
    ) => Promise<CreateAppHttpResponse>;
    createAppReportFilter: (
        appId: string,
        body: FilterRequest,
        options?: ApiCallOptions,
    ) => Promise<CreateAppReportFilterHttpResponse>;
    deleteApp: (
        appId: string,
        options?: ApiCallOptions,
    ) => Promise<DeleteAppHttpResponse>;
    deleteAppMedia: (
        appId: string,
        path: string,
        options?: ApiCallOptions,
    ) => Promise<DeleteAppMediaHttpResponse>;
    deleteAppReportFilter: (
        appId: string,
        id: string,
        options?: ApiCallOptions,
    ) => Promise<DeleteAppReportFilterHttpResponse>;
    deleteAppScript: (
        appId: string,
        id: string,
        options?: ApiCallOptions,
    ) => Promise<DeleteAppScriptHttpResponse>;
    exportApp: (
        appId: string,
        query: { NoData?: boolean },
        options?: ApiCallOptions,
    ) => Promise<ExportAppHttpResponse>;
    getAppDataLineage: (
        appId: string,
        options?: ApiCallOptions,
    ) => Promise<GetAppDataLineageHttpResponse>;
    getAppDataMetadata: (
        appId: string,
        options?: ApiCallOptions,
    ) => Promise<GetAppDataMetadataHttpResponse>;
    getAppEvaluation: (
        id: string,
        query: { all?: boolean; format?: string },
        options?: ApiCallOptions,
    ) => Promise<GetAppEvaluationHttpResponse>;
    getAppEvaluationComparison: (
        baseid: string,
        comparisonid: string,
        query: { all?: boolean; format?: string },
        options?: ApiCallOptions,
    ) => Promise<GetAppEvaluationComparisonHttpResponse>;
    getAppEvaluationComparisonXml: (
        baseid: string,
        comparisonid: string,
        options?: ApiCallOptions,
    ) => Promise<GetAppEvaluationComparisonXmlHttpResponse>;
    getAppEvaluations: (
        guid: string,
        query: {
            all?: boolean;
            fileMode?: boolean;
            format?: string;
            limit?: number;
            next?: string;
            prev?: string;
            sort?: string;
        },
        options?: ApiCallOptions,
    ) => Promise<GetAppEvaluationsHttpResponse>;
    getAppEvaluationXml: (
        id: string,
        options?: ApiCallOptions,
    ) => Promise<GetAppEvaluationXmlHttpResponse>;
    getAppInfo: (
        appId: string,
        options?: ApiCallOptions,
    ) => Promise<GetAppInfoHttpResponse>;
    getAppInsightAnalyses: (
        appId: string,
        options?: ApiCallOptions,
    ) => Promise<GetAppInsightAnalysesHttpResponse>;
    getAppInsightAnalysisModel: (
        appId: string,
        options?: ApiCallOptions,
    ) => Promise<GetAppInsightAnalysisModelHttpResponse>;
    getAppInsightAnalysisRecommendations: (
        appId: string,
        body: AnalysisRecommendRequest,
        options?: ApiCallOptions,
    ) => Promise<GetAppInsightAnalysisRecommendationsHttpResponse>;
    getAppMedia: (
        appId: string,
        path: string,
        options?: ApiCallOptions,
    ) => Promise<GetAppMediaHttpResponse>;
    getAppMediaList: (
        appId: string,
        path: string,
        query: { show?: string },
        options?: ApiCallOptions,
    ) => Promise<GetAppMediaListHttpResponse>;
    getAppReloadLog: (
        appId: string,
        reloadId: string,
        options?: ApiCallOptions,
    ) => Promise<GetAppReloadLogHttpResponse>;
    getAppReloadLogs: (
        appId: string,
        options?: ApiCallOptions,
    ) => Promise<GetAppReloadLogsHttpResponse>;
    getAppReloadMetadata: (
        appId: string,
        reloadId: string,
        query: { includeSkipStoreReloads?: boolean; limit?: string },
        options?: ApiCallOptions,
    ) => Promise<GetAppReloadMetadataHttpResponse>;
    getAppReportFilter: (
        appId: string,
        id: string,
        options?: ApiCallOptions,
    ) => Promise<GetAppReportFilterHttpResponse>;
    getAppReportFilters: (
        appId: string,
        query: {
            filter?: string;
            filterTypes: ("REP" | "SUB")[];
            limit?: number;
            page?: string;
            sort?: (
                | "+description"
                | "-description"
                | "+ownerId"
                | "-ownerId"
                | "-name"
                | "+name"
                | "+createdAt"
                | "-createdAt"
                | "+updatedAt"
                | "-updatedAt"
            )[];
        },
        options?: ApiCallOptions,
    ) => Promise<GetAppReportFiltersHttpResponse>;
    getAppScript: (
        appId: string,
        id: string,
        options?: ApiCallOptions,
    ) => Promise<GetAppScriptHttpResponse>;
    getAppScriptHistory: (
        appId: string,
        query: { filter?: string; limit?: string; page?: string },
        options?: ApiCallOptions,
    ) => Promise<GetAppScriptHistoryHttpResponse>;
    getAppsPrivileges: (
        options?: ApiCallOptions,
    ) => Promise<GetAppsPrivilegesHttpResponse>;
    getAppThumbnail: (
        appId: string,
        options?: ApiCallOptions,
    ) => Promise<GetAppThumbnailHttpResponse>;
    importApp: (
        query: {
            appId?: string;
            fallbackName?: string;
            fileId?: string;
            mode?: string;
            name?: string;
            NoData?: boolean;
            spaceId?: string;
        },
        body: BodyInit,
        options?: ApiCallOptions,
    ) => Promise<ImportAppHttpResponse>;
    moveAppToSpace: (
        appId: string,
        body: UpdateSpace,
        options?: ApiCallOptions,
    ) => Promise<MoveAppToSpaceHttpResponse>;
    patchAppReportFilter: (
        appId: string,
        id: string,
        body: PatchFilter,
        options?: ApiCallOptions,
    ) => Promise<PatchAppReportFilterHttpResponse>;
    patchAppScript: (
        appId: string,
        id: string,
        body: NxPatch[],
        options?: ApiCallOptions,
    ) => Promise<PatchAppScriptHttpResponse>;
    publishApp: (
        appId: string,
        body: PublishApp,
        options?: ApiCallOptions,
    ) => Promise<PublishAppHttpResponse>;
    queueAppEvaluation: (
        guid: string,
        options?: ApiCallOptions,
    ) => Promise<QueueAppEvaluationHttpResponse>;
    removeAppFromSpace: (
        appId: string,
        options?: ApiCallOptions,
    ) => Promise<RemoveAppFromSpaceHttpResponse>;
    republishApp: (
        appId: string,
        body: RepublishApp,
        options?: ApiCallOptions,
    ) => Promise<RepublishAppHttpResponse>;
    updateAppInfo: (
        appId: string,
        body: UpdateApp,
        options?: ApiCallOptions,
    ) => Promise<UpdateAppInfoHttpResponse>;
    updateAppObjectOwner: (
        appId: string,
        objectId: string,
        body: UpdateOwner,
        options?: ApiCallOptions,
    ) => Promise<UpdateAppObjectOwnerHttpResponse>;
    updateAppOwner: (
        appId: string,
        body: UpdateOwner,
        options?: ApiCallOptions,
    ) => Promise<UpdateAppOwnerHttpResponse>;
    updateAppScript: (
        appId: string,
        body: ScriptVersion,
        options?: ApiCallOptions,
    ) => Promise<UpdateAppScriptHttpResponse>;
    uploadAppMedia: (
        appId: string,
        path: string,
        body: BodyInit,
        options?: ApiCallOptions,
    ) => Promise<UploadAppMediaHttpResponse>;
}
Index

Properties

clearCache: () => void

Clears the cache for apps api requests.

Type declaration

    • (): void
    • Clears the cache for apps api requests.

      Returns void

copyApp: (
    appId: string,
    body: CreateApp,
    options?: ApiCallOptions,
) => Promise<CopyAppHttpResponse>

Copies a specific app.

Type declaration

Identifier of the app.

an object with the body content

CopyAppHttpError

countAppReportFilters: (
    appId: string,
    query: { filterTypes: ("REP" | "SUB")[] },
    options?: ApiCallOptions,
) => Promise<CountAppReportFiltersHttpResponse>

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

Type declaration

    • (
          appId: string,
          query: { filterTypes: ("REP" | "SUB")[] },
          options?: ApiCallOptions,
      ): Promise<CountAppReportFiltersHttpResponse>
    • Get the number of filters for the given app and filter types

      Parameters

      • appId: string

        Qlik Sense app identifier

      • query: { filterTypes: ("REP" | "SUB")[] }

        an object with query parameters

        • filterTypes: ("REP" | "SUB")[]

          The filter type (REP, SUB). REP stands for report bookmark, SUB for subscription bookmark.

      • Optionaloptions: ApiCallOptions

      Returns Promise<CountAppReportFiltersHttpResponse>

      CountAppReportFiltersHttpError

Qlik Sense app identifier

an object with query parameters

CountAppReportFiltersHttpError

createApp: (
    body: CreateApp,
    options?: ApiCallOptions,
) => Promise<CreateAppHttpResponse>

Creates a new app.

Type declaration

an object with the body content

CreateAppHttpError

createAppReportFilter: (
    appId: string,
    body: FilterRequest,
    options?: ApiCallOptions,
) => Promise<CreateAppReportFilterHttpResponse>

Creates a new report filter which is used to re-apply selections, variables, patches to an engine session.

Type declaration

Qlik Sense app identifier

an object with the body content

CreateAppReportFilterHttpError

deleteApp: (
    appId: string,
    options?: ApiCallOptions,
) => Promise<DeleteAppHttpResponse>

Deletes a specific app.

Type declaration

Identifier of the app.

DeleteAppHttpError

deleteAppMedia: (
    appId: string,
    path: string,
    options?: ApiCallOptions,
) => Promise<DeleteAppMediaHttpResponse>

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.

Type declaration

    • (
          appId: string,
          path: string,
          options?: ApiCallOptions,
      ): Promise<DeleteAppMediaHttpResponse>
    • 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.

      Parameters

      • appId: string

        Unique application identifier.

      • path: string

        Path to file content.

      • Optionaloptions: ApiCallOptions

      Returns Promise<DeleteAppMediaHttpResponse>

      DeleteAppMediaHttpError

Unique application identifier.

Path to file content.

DeleteAppMediaHttpError

deleteAppReportFilter: (
    appId: string,
    id: string,
    options?: ApiCallOptions,
) => Promise<DeleteAppReportFilterHttpResponse>

Delete a filter

Type declaration

Qlik Sense app identifier

The filter id identifier (bookmarkId).

DeleteAppReportFilterHttpError

deleteAppScript: (
    appId: string,
    id: string,
    options?: ApiCallOptions,
) => Promise<DeleteAppScriptHttpResponse>

Deletes a specific version of the script for an app. Fails if the supplied id is the current version.

Type declaration

    • (
          appId: string,
          id: string,
          options?: ApiCallOptions,
      ): Promise<DeleteAppScriptHttpResponse>
    • Deletes a specific version of the script for an app. Fails if the supplied id is the current version.

      Parameters

      • appId: string

        Identifier of the app.

      • id: string

        Identifier of the script version

      • Optionaloptions: ApiCallOptions

      Returns Promise<DeleteAppScriptHttpResponse>

      DeleteAppScriptHttpError

Identifier of the app.

Identifier of the script version

DeleteAppScriptHttpError

exportApp: (
    appId: string,
    query: { NoData?: boolean },
    options?: ApiCallOptions,
) => Promise<ExportAppHttpResponse>

Exports a specific app.

Type declaration

    • (
          appId: string,
          query: { NoData?: boolean },
          options?: ApiCallOptions,
      ): Promise<ExportAppHttpResponse>
    • Exports a specific app.

      Parameters

      • appId: string

        Identifier of the app.

      • query: { NoData?: boolean }

        an object with query parameters

        • OptionalNoData?: boolean

          The flag indicating if only object contents should be exported.

      • Optionaloptions: ApiCallOptions

      Returns Promise<ExportAppHttpResponse>

      ExportAppHttpError

Identifier of the app.

an object with query parameters

ExportAppHttpError

getAppDataLineage: (
    appId: string,
    options?: ApiCallOptions,
) => Promise<GetAppDataLineageHttpResponse>

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

Type declaration

Identifier of the app.

GetAppDataLineageHttpError

getAppDataMetadata: (
    appId: string,
    options?: ApiCallOptions,
) => Promise<GetAppDataMetadataHttpResponse>

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.

Type declaration

Identifier of the app.

GetAppDataMetadataHttpError

getAppEvaluation: (
    id: string,
    query: { all?: boolean; format?: string },
    options?: ApiCallOptions,
) => Promise<GetAppEvaluationHttpResponse>

Find an evaluation by a specific id.

Type declaration

    • (
          id: string,
          query: { all?: boolean; format?: string },
          options?: ApiCallOptions,
      ): Promise<GetAppEvaluationHttpResponse>
    • Find an evaluation by a specific id.

      Parameters

      • id: string

        Id of the desired evaluation.

      • query: { all?: boolean; format?: string }

        an object with query parameters

        • Optionalall?: boolean

          Get the full data of the evaluation

        • Optionalformat?: string

          Specify output format, currently supported are 'json' and 'xml'

      • Optionaloptions: ApiCallOptions

      Returns Promise<GetAppEvaluationHttpResponse>

      GetAppEvaluationHttpError

Id of the desired evaluation.

an object with query parameters

GetAppEvaluationHttpError

getAppEvaluationComparison: (
    baseid: string,
    comparisonid: string,
    query: { all?: boolean; format?: string },
    options?: ApiCallOptions,
) => Promise<GetAppEvaluationComparisonHttpResponse>

Accepts two evaluation ids and returns a comparison denoting the differences between the two.

Type declaration

    • (
          baseid: string,
          comparisonid: string,
          query: { all?: boolean; format?: string },
          options?: ApiCallOptions,
      ): Promise<GetAppEvaluationComparisonHttpResponse>
    • Accepts two evaluation ids and returns a comparison denoting the differences between the two.

      Parameters

      • baseid: string

        Id of the baseline evaluation

      • comparisonid: string

        Id of the comparison evaluation

      • query: { all?: boolean; format?: string }

        an object with query parameters

        • Optionalall?: boolean

          Get the full list of comparisons including non-significant diffs

        • Optionalformat?: string

          Specify output format, currently supported are 'json' and 'xml'

      • Optionaloptions: ApiCallOptions

      Returns Promise<GetAppEvaluationComparisonHttpResponse>

      GetAppEvaluationComparisonHttpError

Id of the baseline evaluation

Id of the comparison evaluation

an object with query parameters

GetAppEvaluationComparisonHttpError

getAppEvaluationComparisonXml: (
    baseid: string,
    comparisonid: string,
    options?: ApiCallOptions,
) => Promise<GetAppEvaluationComparisonXmlHttpResponse>

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

Type declaration

    • (
          baseid: string,
          comparisonid: string,
          options?: ApiCallOptions,
      ): Promise<GetAppEvaluationComparisonXmlHttpResponse>
    • Accepts two evaluation ids and downloads a log, in XML format, denoting the differences between the two.

      Parameters

      • baseid: string

        Id of the baseline evaluation

      • comparisonid: string

        Id of the comparison evaluation

      • Optionaloptions: ApiCallOptions

      Returns Promise<GetAppEvaluationComparisonXmlHttpResponse>

      getAppEvaluationComparisonXml(
      "abcdefghijklmnopq",
      "abcdefghijklmnopq"
      )

      GetAppEvaluationComparisonXmlHttpError

getAppEvaluationComparisonXml(
"abcdefghijklmnopq",
"abcdefghijklmnopq"
)

Id of the baseline evaluation

Id of the comparison evaluation

GetAppEvaluationComparisonXmlHttpError

getAppEvaluations: (
    guid: string,
    query: {
        all?: boolean;
        fileMode?: boolean;
        format?: string;
        limit?: number;
        next?: string;
        prev?: string;
        sort?: string;
    },
    options?: ApiCallOptions,
) => Promise<GetAppEvaluationsHttpResponse>

Find all evaluations for an app GUID. Supports paging via next, prev which are sent in the response body

Type declaration

    • (
          guid: string,
          query: {
              all?: boolean;
              fileMode?: boolean;
              format?: string;
              limit?: number;
              next?: string;
              prev?: string;
              sort?: string;
          },
          options?: ApiCallOptions,
      ): Promise<GetAppEvaluationsHttpResponse>
    • Find all evaluations for an app GUID. Supports paging via next, prev which are sent in the response body

      Parameters

      • guid: string

        The app guid.

      • query: {
            all?: boolean;
            fileMode?: boolean;
            format?: string;
            limit?: number;
            next?: string;
            prev?: string;
            sort?: string;
        }

        an object with query parameters

        • Optionalall?: boolean

          Get the full data of the evaluation

        • OptionalfileMode?: boolean

          Add file transfer headers to response

        • Optionalformat?: string

          Specify output format, currently supported are 'json' and 'xml'

        • Optionallimit?: number

          Number of results to return per page.

        • Optionalnext?: string

          The app evaluation id to get next page from

        • Optionalprev?: string

          The app evaluation id to get previous page from

        • Optionalsort?: string

          Property to sort list on

      • Optionaloptions: ApiCallOptions

      Returns Promise<GetAppEvaluationsHttpResponse>

      GetAppEvaluationsHttpError

The app guid.

an object with query parameters

GetAppEvaluationsHttpError

getAppEvaluationXml: (
    id: string,
    options?: ApiCallOptions,
) => Promise<GetAppEvaluationXmlHttpResponse>

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

Type declaration

getAppEvaluationXml(
"abcdefghijklmnopq"
)

Id of the desired evaluation.

GetAppEvaluationXmlHttpError

getAppInfo: (
    appId: string,
    options?: ApiCallOptions,
) => Promise<GetAppInfoHttpResponse>

Retrieves information for a specific app.

Type declaration

Identifier of the app.

GetAppInfoHttpError

getAppInsightAnalyses: (
    appId: string,
    options?: ApiCallOptions,
) => Promise<GetAppInsightAnalysesHttpResponse>

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.

Type declaration

Qlik Sense app identifier

GetAppInsightAnalysesHttpError

getAppInsightAnalysisModel: (
    appId: string,
    options?: ApiCallOptions,
) => Promise<GetAppInsightAnalysisModelHttpResponse>

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.

Type declaration

Qlik Sense app identifier

GetAppInsightAnalysisModelHttpError

getAppInsightAnalysisRecommendations: (
    appId: string,
    body: AnalysisRecommendRequest,
    options?: ApiCallOptions,
) => Promise<GetAppInsightAnalysisRecommendationsHttpResponse>

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.

Type declaration

Qlik Sense app identifier

an object with the body content

GetAppInsightAnalysisRecommendationsHttpError

getAppMedia: (
    appId: string,
    path: string,
    options?: ApiCallOptions,
) => Promise<GetAppMediaHttpResponse>

Gets media content from file. Returns a stream of bytes containing the media file content on success, or error if file is not found.

Type declaration

    • (
          appId: string,
          path: string,
          options?: ApiCallOptions,
      ): Promise<GetAppMediaHttpResponse>
    • Gets media content from file. Returns a stream of bytes containing the media file content on success, or error if file is not found.

      Parameters

      • appId: string

        Unique application identifier.

      • path: string

        Path to file content.

      • Optionaloptions: ApiCallOptions

      Returns Promise<GetAppMediaHttpResponse>

      GetAppMediaHttpError

Unique application identifier.

Path to file content.

GetAppMediaHttpError

getAppMediaList: (
    appId: string,
    path: string,
    query: { show?: string },
    options?: ApiCallOptions,
) => Promise<GetAppMediaListHttpResponse>

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.

Type declaration

    • (
          appId: string,
          path: string,
          query: { show?: string },
          options?: ApiCallOptions,
      ): Promise<GetAppMediaListHttpResponse>
    • 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.

      Parameters

      • appId: string

        Unique application identifier.

      • path: string

        The path to sub folder with static content relative to the root folder. Use empty path to access the root folder.

      • query: { show?: string }

        an object with query parameters

        • Optionalshow?: string

          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.
      • Optionaloptions: ApiCallOptions

      Returns Promise<GetAppMediaListHttpResponse>

      GetAppMediaListHttpError

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: (
    appId: string,
    reloadId: string,
    options?: ApiCallOptions,
) => Promise<GetAppReloadLogHttpResponse>

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

Type declaration

Identifier of the app.

Identifier of the reload.

GetAppReloadLogHttpError

getAppReloadLogs: (
    appId: string,
    options?: ApiCallOptions,
) => Promise<GetAppReloadLogsHttpResponse>

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

Type declaration

Identifier of the app.

GetAppReloadLogsHttpError

getAppReloadMetadata: (
    appId: string,
    reloadId: string,
    query: { includeSkipStoreReloads?: boolean; limit?: string },
    options?: ApiCallOptions,
) => Promise<GetAppReloadMetadataHttpResponse>

Retrieves the app reload metadata list. Reload metadata contains reload information, including reload id, duration, endtime and lineage load info.

Type declaration

    • (
          appId: string,
          reloadId: string,
          query: { includeSkipStoreReloads?: boolean; limit?: string },
          options?: ApiCallOptions,
      ): Promise<GetAppReloadMetadataHttpResponse>
    • Retrieves the app reload metadata list. Reload metadata contains reload information, including reload id, duration, endtime and lineage load info.

      Parameters

      • appId: string

        Identifier of the app

      • reloadId: string

        Identifier of the reload. Use empty reloadId to get all reloads.

      • query: { includeSkipStoreReloads?: boolean; limit?: string }

        an object with query parameters

        • OptionalincludeSkipStoreReloads?: boolean

          Include metadata for reloads ran with SkipStore flag set to true. Default: false

        • Optionallimit?: string

          Maximum number of records to return from this request. Default: 100

      • Optionaloptions: ApiCallOptions

      Returns Promise<GetAppReloadMetadataHttpResponse>

      GetAppReloadMetadataHttpError

Identifier of the app

Identifier of the reload. Use empty reloadId to get all reloads.

an object with query parameters

GetAppReloadMetadataHttpError

getAppReportFilter: (
    appId: string,
    id: string,
    options?: ApiCallOptions,
) => Promise<GetAppReportFilterHttpResponse>

Get a filter

Type declaration

Qlik Sense app identifier

The filter id identifier (bookmarkId).

GetAppReportFilterHttpError

getAppReportFilters: (
    appId: string,
    query: {
        filter?: string;
        filterTypes: ("REP" | "SUB")[];
        limit?: number;
        page?: string;
        sort?: (
            | "+description"
            | "-description"
            | "+ownerId"
            | "-ownerId"
            | "-name"
            | "+name"
            | "+createdAt"
            | "-createdAt"
            | "+updatedAt"
            | "-updatedAt"
        )[];
    },
    options?: ApiCallOptions,
) => Promise<GetAppReportFiltersHttpResponse>

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.

Type declaration

    • (
          appId: string,
          query: {
              filter?: string;
              filterTypes: ("REP" | "SUB")[];
              limit?: number;
              page?: string;
              sort?: (
                  | "+description"
                  | "-description"
                  | "+ownerId"
                  | "-ownerId"
                  | "-name"
                  | "+name"
                  | "+createdAt"
                  | "-createdAt"
                  | "+updatedAt"
                  | "-updatedAt"
              )[];
          },
          options?: ApiCallOptions,
      ): Promise<GetAppReportFiltersHttpResponse>
    • 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.

      Parameters

      • appId: string

        Qlik Sense app identifier

      • query: {
            filter?: string;
            filterTypes: ("REP" | "SUB")[];
            limit?: number;
            page?: string;
            sort?: (
                | "+description"
                | "-description"
                | "+ownerId"
                | "-ownerId"
                | "-name"
                | "+name"
                | "+createdAt"
                | "-createdAt"
                | "+updatedAt"
                | "-updatedAt"
            )[];
        }

        an object with query parameters

        • Optionalfilter?: string

          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 the eq (equals) operator: ownerId Example: (name co "query1" or description co "query2") and ownerId eq "123"

        • filterTypes: ("REP" | "SUB")[]

          The filter type (REP, SUB). REP stands for report bookmark, SUB for subscription bookmark.

        • Optionallimit?: number

          Limit the returned result set

        • Optionalpage?: string

          If present, the cursor that starts the page of data that is returned.

        • Optionalsort?: (
              | "+description"
              | "-description"
              | "+ownerId"
              | "-ownerId"
              | "-name"
              | "+name"
              | "+createdAt"
              | "-createdAt"
              | "+updatedAt"
              | "-updatedAt"
          )[]

          Sorting parameters.

      • Optionaloptions: ApiCallOptions

      Returns Promise<GetAppReportFiltersHttpResponse>

      GetAppReportFiltersHttpError

Qlik Sense app identifier

an object with query parameters

GetAppReportFiltersHttpError

getAppScript: (
    appId: string,
    id: string,
    options?: ApiCallOptions,
) => Promise<GetAppScriptHttpResponse>

Retrieves a version of the script for an app. Returns the script text.

Type declaration

    • (
          appId: string,
          id: string,
          options?: ApiCallOptions,
      ): Promise<GetAppScriptHttpResponse>
    • Retrieves a version of the script for an app. Returns the script text.

      Parameters

      • appId: string

        Identifier of the app.

      • id: string

        Identifier of the script version, or 'current' for retrieving the current version.

      • Optionaloptions: ApiCallOptions

      Returns Promise<GetAppScriptHttpResponse>

      GetAppScriptHttpError

Identifier of the app.

Identifier of the script version, or 'current' for retrieving the current version.

GetAppScriptHttpError

getAppScriptHistory: (
    appId: string,
    query: { filter?: string; limit?: string; page?: string },
    options?: ApiCallOptions,
) => Promise<GetAppScriptHistoryHttpResponse>

Retrieves the script history for an app. Returns information about the saved versions of the script in a list sorted with latest first.

Type declaration

    • (
          appId: string,
          query: { filter?: string; limit?: string; page?: string },
          options?: ApiCallOptions,
      ): Promise<GetAppScriptHistoryHttpResponse>
    • Retrieves the script history for an app. Returns information about the saved versions of the script in a list sorted with latest first.

      Parameters

      • appId: string

        Identifier of the app.

      • query: { filter?: string; limit?: string; page?: string }

        an object with query parameters

        • Optionalfilter?: string

          A scim filter expression defining which script versions should be retrieved. Filterable fields are:

          • ScriptId
          • ModifiedTime
          • ModifierId
        • Optionallimit?: string

          Maximum number of records to return from this request.

        • Optionalpage?: string

          Opaque definition of which page of the result set to return. Returned from a previous call using the same filter. Not yet supported.

      • Optionaloptions: ApiCallOptions

      Returns Promise<GetAppScriptHistoryHttpResponse>

      GetAppScriptHistoryHttpError

Identifier of the app.

an object with query parameters

GetAppScriptHistoryHttpError

getAppsPrivileges: (
    options?: ApiCallOptions,
) => Promise<GetAppsPrivilegesHttpResponse>

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.

Type declaration

GetAppsPrivilegesHttpError

getAppThumbnail: (
    appId: string,
    options?: ApiCallOptions,
) => Promise<GetAppThumbnailHttpResponse>

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.

Type declaration

    • (appId: string, options?: ApiCallOptions): Promise<GetAppThumbnailHttpResponse>
    • 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.

      Parameters

      • appId: string

        Unique application identifier.

      • Optionaloptions: ApiCallOptions

      Returns Promise<GetAppThumbnailHttpResponse>

      GetAppThumbnailHttpError

Unique application identifier.

GetAppThumbnailHttpError

importApp: (
    query: {
        appId?: string;
        fallbackName?: string;
        fileId?: string;
        mode?: string;
        name?: string;
        NoData?: boolean;
        spaceId?: string;
    },
    body: BodyInit,
    options?: ApiCallOptions,
) => Promise<ImportAppHttpResponse>

Imports an app into the system.

Type declaration

    • (
          query: {
              appId?: string;
              fallbackName?: string;
              fileId?: string;
              mode?: string;
              name?: string;
              NoData?: boolean;
              spaceId?: string;
          },
          body: BodyInit,
          options?: ApiCallOptions,
      ): Promise<ImportAppHttpResponse>
    • Imports an app into the system.

      Parameters

      • query: {
            appId?: string;
            fallbackName?: string;
            fileId?: string;
            mode?: string;
            name?: string;
            NoData?: boolean;
            spaceId?: string;
        }

        an object with query parameters

        • OptionalappId?: string

          The app ID of the target app when source is qvw file.

        • OptionalfallbackName?: string

          The name of the target app when source does not have a specified name, applicable if source is qvw file.

        • OptionalfileId?: string

          The file ID to be downloaded from Temporary Content Service (TCS) and used during import.

        • Optionalmode?: string

          The import mode. In new mode (default), the source app will be imported as a new app.

          The autoreplace mode is an internal mode only and is not permitted for external use.

          One of:

          • NEW
          • AUTOREPLACE
        • Optionalname?: string

          The name of the target app.

        • OptionalNoData?: boolean

          If NoData is true, the data of the existing app will be kept as is, otherwise it will be replaced by the new incoming data.

        • OptionalspaceId?: string

          The space ID of the target app.

      • body: BodyInit

        an object with the body content

      • Optionaloptions: ApiCallOptions

      Returns Promise<ImportAppHttpResponse>

      ImportAppHttpError

an object with query parameters

an object with the body content

ImportAppHttpError

moveAppToSpace: (
    appId: string,
    body: UpdateSpace,
    options?: ApiCallOptions,
) => Promise<MoveAppToSpaceHttpResponse>

Sets space on a specific app.

Type declaration

Identifier of the app.

an object with the body content

MoveAppToSpaceHttpError

patchAppReportFilter: (
    appId: string,
    id: string,
    body: PatchFilter,
    options?: ApiCallOptions,
) => Promise<PatchAppReportFilterHttpResponse>

Update a filter

Type declaration

Qlik Sense app identifier

The filter id identifier (bookmarkId).

an object with the body content

PatchAppReportFilterHttpError

patchAppScript: (
    appId: string,
    id: string,
    body: NxPatch[],
    options?: ApiCallOptions,
) => Promise<PatchAppScriptHttpResponse>

Updates a specific version of the script for an app.

Type declaration

Identifier of the app.

Identifier of the script version.

an object with the body content

PatchAppScriptHttpError

publishApp: (
    appId: string,
    body: PublishApp,
    options?: ApiCallOptions,
) => Promise<PublishAppHttpResponse>

Publishes a specific app to a managed space.

Type declaration

Identifier of the app.

an object with the body content

PublishAppHttpError

queueAppEvaluation: (
    guid: string,
    options?: ApiCallOptions,
) => Promise<QueueAppEvaluationHttpResponse>

Queue an app evaluation by its app guid.

Type declaration

queueAppEvaluation(
"abcdefghijklmnopq"
)

Guid of the app.

QueueAppEvaluationHttpError

removeAppFromSpace: (
    appId: string,
    options?: ApiCallOptions,
) => Promise<RemoveAppFromSpaceHttpResponse>

Removes space from a specific app.

Type declaration

Identifier of the app.

RemoveAppFromSpaceHttpError

republishApp: (
    appId: string,
    body: RepublishApp,
    options?: ApiCallOptions,
) => Promise<RepublishAppHttpResponse>

Republishes a published app to a managed space.

Type declaration

Identifier of the app.

an object with the body content

RepublishAppHttpError

updateAppInfo: (
    appId: string,
    body: UpdateApp,
    options?: ApiCallOptions,
) => Promise<UpdateAppInfoHttpResponse>

Updates the information for a specific app.

Type declaration

Identifier of the app.

an object with the body content

UpdateAppInfoHttpError

updateAppObjectOwner: (
    appId: string,
    objectId: string,
    body: UpdateOwner,
    options?: ApiCallOptions,
) => Promise<UpdateAppObjectOwnerHttpResponse>

Sets owner on an app object. The user must be the owner of the object.

Type declaration

Identifier of the app.

Identifier of the object.

an object with the body content

UpdateAppObjectOwnerHttpError

updateAppOwner: (
    appId: string,
    body: UpdateOwner,
    options?: ApiCallOptions,
) => Promise<UpdateAppOwnerHttpResponse>

Changes owner of the app.

Type declaration

Identifier of the app.

an object with the body content

UpdateAppOwnerHttpError

updateAppScript: (
    appId: string,
    body: ScriptVersion,
    options?: ApiCallOptions,
) => Promise<UpdateAppScriptHttpResponse>

Sets script for an app.

Type declaration

Identifier of the app.

an object with the body content

UpdateAppScriptHttpError

uploadAppMedia: (
    appId: string,
    path: string,
    body: BodyInit,
    options?: ApiCallOptions,
) => Promise<UploadAppMediaHttpResponse>

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.

Type declaration

    • (
          appId: string,
          path: string,
          body: BodyInit,
          options?: ApiCallOptions,
      ): Promise<UploadAppMediaHttpResponse>
    • 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.

      Parameters

      • appId: string

        Unique application identifier.

      • path: string

        Path to file content.

      • body: BodyInit

        an object with the body content

      • Optionaloptions: ApiCallOptions

      Returns Promise<UploadAppMediaHttpResponse>

      UploadAppMediaHttpError

Unique application identifier.

Path to file content.

an object with the body content

UploadAppMediaHttpError