From 1ef43454c6a8a779204672322140c51c431fed2f Mon Sep 17 00:00:00 2001 From: Marcus Lacerda Date: Mon, 17 Jul 2023 15:38:05 +0200 Subject: [PATCH] chore: update enigma with QIX-RPC v. 12.1777.0 (#307) * fix generate.sh script so it fetches rpc-spec * update enigma according to latest spec * remove redundant make-targets --- Makefile | 5 -- api-spec.json | 122 ++++++++++++++++++++++------------ qix_generated.go | 145 +++++++++++++++++++++++++++-------------- schema/engine-rpc.json | 139 +++++++++++++++++++++++++++++---------- schema/generate.sh | 2 + 5 files changed, 283 insertions(+), 130 deletions(-) diff --git a/Makefile b/Makefile index 5a949387..a8731c16 100644 --- a/Makefile +++ b/Makefile @@ -5,8 +5,3 @@ test-unit: generate-schema: ./schema/generate.sh - -update-api-spec: - go run ./spec/generate.go - -update-engine-version: generate-schema update-api-spec diff --git a/api-spec.json b/api-spec.json index 3aaeef5d..4d87e236 100644 --- a/api-spec.json +++ b/api-spec.json @@ -175,7 +175,7 @@ "type": "bool" }, "Bnf": { - "description": "Array of token references that all together build up the definition of the current token.\nGenerally, if the array is not empty, the definition is a BNF rule (_qIsBnfRule_ is set to true). However, some BNF rules do have an empty array (_qIsBnfRule_ is set to true, but qBnf is empty).", + "description": "Array of token references that all together build up the definition of the current token.\nGenerally, if the array is not empty, the definition is a BNF rule (_qIsBnfRule_ is set to true). However, some BNF  rules do have an empty array (_qIsBnfRule_ is set to true, but qBnf is empty).", "type": "slice", "items": { "type": "int" @@ -622,7 +622,7 @@ "type": "struct", "entries": { "ConnectionString": { - "description": "One of:\n\n• ODBC CONNECT TO [\u003cprovider name\u003e]\n\n• OLEDB CONNECT TO [\u003cprovider name\u003e]\n\n• CUSTOM CONNECT TO [\u003cprovider name\u003e]\n\n• \"\u003clocal absolute or relative path, UNC path\u003e\"\n\n• \"\u003cURL\u003e\"\n\nConnection string.\nThis parameter is mandatory and must be set when creating or modifying a connection.", + "description": "One of:\n\n• ODBC CONNECT TO [\u003cprovider name\u003e]\n\n• OLEDB CONNECT TO [\u003cprovider name\u003e]\n\n• CUSTOM CONNECT TO [\u003cprovider name\u003e]\n\n• \"\u003clocal absolute or relative path, UNC path\u003e\"\n\n• \"\u003cURL\u003e\"\n\nConnection string.\nThis parameter is mandatory and must be set when creating or modifying a connection.", "type": "string" }, "Id": { @@ -1037,6 +1037,15 @@ "ReloadId": { "description": "Optional reload ID.\nID will be automatically generated if not set.", "type": "string" + }, + "RowLimit": { + "description": "If greater than or equal 0, defines max number of rows loaded from a data source.\nWhen set to nil the default value is used, when set to point at a value that value is used (including golang zero values)", + "type": "int", + "ref-type": "pointer" + }, + "SkipStore": { + "description": "Set to true to skip Store statements.\nThe default value is false.", + "type": "bool" } } }, @@ -1207,7 +1216,7 @@ }, "ApplyTemporaryBookmark": { "description": "Apply temporary bookmark identified by Id.\nApplyTemporaryBookmark method is only supported in SaaS Editions of Qlik Sense.\n\nParameters:\n\n◾ id - Identifier of the temporary selection state", - "x-qlik-stability": "experimental", + "x-qlik-stability": "locked", "type": "method", "params": [ { @@ -1484,6 +1493,21 @@ } ] }, + "ClearAllSoftPatches": { + "description": "Clear the soft properties of all generic objects in the app", + "x-qlik-stability": "experimental", + "type": "method", + "params": [ + { + "type": "https://golang.org/pkg/context/Context" + } + ], + "returns": [ + { + "type": "error" + } + ] + }, "ClearUndoBuffer": { "description": "Clears entirely the undo and redo buffer.", "x-qlik-stability": "locked", @@ -1994,7 +2018,7 @@ }, "CreateTemporaryBookmark": { "description": "Create temporary bookmark\nCreateTemporaryBookmark method is only supported in SaaS Editions of Qlik Sense.\n\nParameters:\n\n◾ options - Options for the temporary bookmark\n\n◾ objectIdsToPatch - Add softpatches for this objects if available. If empty all softpatches are added to the bookmark. This is ignored if IncludePatches is false.", - "x-qlik-stability": "experimental", + "x-qlik-stability": "locked", "type": "method", "params": [ { @@ -2024,7 +2048,7 @@ }, "CreateTemporaryBookmarkRaw": { "description": "Create temporary bookmark\nCreateTemporaryBookmark method is only supported in SaaS Editions of Qlik Sense.\n\nParameters:\n\n◾ options - Options for the temporary bookmark\n\n◾ objectIdsToPatch - Add softpatches for this objects if available. If empty all softpatches are added to the bookmark. This is ignored if IncludePatches is false.", - "x-qlik-stability": "experimental", + "x-qlik-stability": "locked", "type": "method", "params": [ { @@ -3020,7 +3044,7 @@ ] }, "GetDatabaseInfo": { - "description": "Gives information about an ODBC, OLEDB or CUSTOM connection. See Outputs for more details.\n\nParameters:\n\n◾ connectionId - Name of the connection.", + "description": "Gives information about an ODBC, OLEDB or CUSTOM connection. See Outputs for more details.\n\nParameters:\n\n◾ connectionId - Name of the connection.", "x-qlik-stability": "locked", "type": "method", "params": [ @@ -3041,7 +3065,7 @@ ] }, "GetDatabaseInfoRaw": { - "description": "Gives information about an ODBC, OLEDB or CUSTOM connection. See Outputs for more details.\n\nParameters:\n\n◾ connectionId - Name of the connection.", + "description": "Gives information about an ODBC, OLEDB or CUSTOM connection. See Outputs for more details.\n\nParameters:\n\n◾ connectionId - Name of the connection.", "x-qlik-stability": "locked", "type": "method", "params": [ @@ -3113,7 +3137,7 @@ ] }, "GetDatabaseTableFields": { - "description": "Lists the fields inside a table of a database for a ODBC, OLEDB or CUSTOM connection.\n\nParameters:\n\n◾ connectionId - Identifier of the connection.\n\n◾ database - Name of the database.\nIf qDatabase is not set then qOwner must be set.\n\n◾ owner - Owner of the database.\nIf qOwner is not set then qDatabase must be set.\n\n◾ table - Name of the table.", + "description": "Lists the fields inside a table of a database for a ODBC, OLEDB or CUSTOM connection.\n\nParameters:\n\n◾ connectionId - Identifier of the connection.\n\n◾ database - Name of the database.\nIf qDatabase is not set then qOwner must be set.\n\n◾ owner - Owner of the database.\nIf qOwner is not set then qDatabase must be set.\n\n◾ table - Name of the table.", "x-qlik-stability": "locked", "type": "method", "params": [ @@ -3146,7 +3170,7 @@ ] }, "GetDatabaseTableFieldsRaw": { - "description": "Lists the fields inside a table of a database for a ODBC, OLEDB or CUSTOM connection.\n\nParameters:\n\n◾ connectionId - Identifier of the connection.\n\n◾ database - Name of the database.\nIf qDatabase is not set then qOwner must be set.\n\n◾ owner - Owner of the database.\nIf qOwner is not set then qDatabase must be set.\n\n◾ table - Name of the table.", + "description": "Lists the fields inside a table of a database for a ODBC, OLEDB or CUSTOM connection.\n\nParameters:\n\n◾ connectionId - Identifier of the connection.\n\n◾ database - Name of the database.\nIf qDatabase is not set then qOwner must be set.\n\n◾ owner - Owner of the database.\nIf qOwner is not set then qDatabase must be set.\n\n◾ table - Name of the table.", "x-qlik-stability": "locked", "type": "method", "params": [ @@ -3176,7 +3200,7 @@ ] }, "GetDatabaseTablePreview": { - "description": "Retrieves the values of the specified table of a database for a ODBC, OLEDB or CUSTOM connection.\n\nParameters:\n\n◾ connectionId - Identifier of the connection.\n\n◾ database - Name of the database.\nIf qDatabase is not set then qOwner must be set.\n\n◾ owner - Owner of the database.\nIf qOwner is not set then qDatabase must be set.\n\n◾ table - Name of the table.\n\n◾ conditions -", + "description": "Retrieves the values of the specified table of a database for a ODBC, OLEDB or CUSTOM connection.\n\nParameters:\n\n◾ connectionId - Identifier of the connection.\n\n◾ database - Name of the database.\nIf qDatabase is not set then qOwner must be set.\n\n◾ owner - Owner of the database.\nIf qOwner is not set then qDatabase must be set.\n\n◾ table - Name of the table.\n\n◾ conditions -", "x-qlik-stability": "locked", "type": "method", "params": [ @@ -3215,7 +3239,7 @@ ] }, "GetDatabaseTablePreviewRaw": { - "description": "Retrieves the values of the specified table of a database for a ODBC, OLEDB or CUSTOM connection.\n\nParameters:\n\n◾ connectionId - Identifier of the connection.\n\n◾ database - Name of the database.\nIf qDatabase is not set then qOwner must be set.\n\n◾ owner - Owner of the database.\nIf qOwner is not set then qDatabase must be set.\n\n◾ table - Name of the table.\n\n◾ conditions -", + "description": "Retrieves the values of the specified table of a database for a ODBC, OLEDB or CUSTOM connection.\n\nParameters:\n\n◾ connectionId - Identifier of the connection.\n\n◾ database - Name of the database.\nIf qDatabase is not set then qOwner must be set.\n\n◾ owner - Owner of the database.\nIf qOwner is not set then qDatabase must be set.\n\n◾ table - Name of the table.\n\n◾ conditions -", "x-qlik-stability": "locked", "type": "method", "params": [ @@ -3251,7 +3275,7 @@ ] }, "GetDatabaseTables": { - "description": "Lists the tables inside a database for a ODBC, OLEDB or CUSTOM connection.\n\nParameters:\n\n◾ connectionId - Identifier of the connection.\n\n◾ database - Name of the database.\nIf qDatabase is not set then qOwner must be set.\n\n◾ owner - Owner of the database.\nIf qOwner is not set then qDatabase must be set.", + "description": "Lists the tables inside a database for a ODBC, OLEDB or CUSTOM connection.\n\nParameters:\n\n◾ connectionId - Identifier of the connection.\n\n◾ database - Name of the database.\nIf qDatabase is not set then qOwner must be set.\n\n◾ owner - Owner of the database.\nIf qOwner is not set then qDatabase must be set.", "x-qlik-stability": "locked", "type": "method", "params": [ @@ -3281,7 +3305,7 @@ ] }, "GetDatabaseTablesRaw": { - "description": "Lists the tables inside a database for a ODBC, OLEDB or CUSTOM connection.\n\nParameters:\n\n◾ connectionId - Identifier of the connection.\n\n◾ database - Name of the database.\nIf qDatabase is not set then qOwner must be set.\n\n◾ owner - Owner of the database.\nIf qOwner is not set then qDatabase must be set.", + "description": "Lists the tables inside a database for a ODBC, OLEDB or CUSTOM connection.\n\nParameters:\n\n◾ connectionId - Identifier of the connection.\n\n◾ database - Name of the database.\nIf qDatabase is not set then qOwner must be set.\n\n◾ owner - Owner of the database.\nIf qOwner is not set then qDatabase must be set.", "x-qlik-stability": "locked", "type": "method", "params": [ @@ -3701,7 +3725,7 @@ ] }, "GetFileTableFields": { - "description": "Lists the fields of a table for a folder connection.\n\nFileType:\n\nRecognized file formats are:\n\n• CSV for Delimited\n\n• FIX for Fixed Record\n\n• DIF for Data Interchange Format\n\n• EXCELBIFF_ for Microsoft Excel (XLS)\n\n• EXCELOOXML_ for Microsoft Excel (XLSX)\n\n• HTML for HTML\n\n• QVD for QVD file\n\n• XML for XML\n\n• QVX for QVX file\n\n• JSON for JSON format\n\n• KML for KML file\n\n• PARQUET for PARQUET file\n\nParameters:\n\n◾ connectionId - Identifier of the connection.\n\n◾ relativePath - Path of the connection file.\n\n◾ dataFormat - Type of the file.\n\n◾ table - Name of the table.\nThis parameter must be set for XLS , XLSX , HTML and XML files.", + "description": "Lists the fields of a table for a folder connection.\n\nFileType:\n\nRecognized file formats are:\n\n• CSV for Delimited\n\n• FIX for Fixed Record\n\n• DIF for Data Interchange Format\n\n• EXCELBIFF_ for Microsoft Excel (XLS)\n\n• EXCELOOXML_ for Microsoft Excel (XLSX)\n\n• HTML for HTML\n\n• QVD for QVD file\n\n• XML for XML\n\n• QVX for QVX file\n\n• JSON for JSON format\n\n• KML for KML file\n\n• PARQUET for PARQUET file\n\nParameters:\n\n◾ connectionId - Identifier of the connection.\n\n◾ relativePath - Path of the connection file.\n\n◾ dataFormat - Type of the file.\n\n◾ table - Name of the table.\nThis parameter must be set for XLS , XLSX , HTML   and XML files.", "x-qlik-stability": "locked", "type": "method", "params": [ @@ -3737,7 +3761,7 @@ ] }, "GetFileTableFieldsRaw": { - "description": "Lists the fields of a table for a folder connection.\n\nFileType:\n\nRecognized file formats are:\n\n• CSV for Delimited\n\n• FIX for Fixed Record\n\n• DIF for Data Interchange Format\n\n• EXCELBIFF_ for Microsoft Excel (XLS)\n\n• EXCELOOXML_ for Microsoft Excel (XLSX)\n\n• HTML for HTML\n\n• QVD for QVD file\n\n• XML for XML\n\n• QVX for QVX file\n\n• JSON for JSON format\n\n• KML for KML file\n\n• PARQUET for PARQUET file\n\nParameters:\n\n◾ connectionId - Identifier of the connection.\n\n◾ relativePath - Path of the connection file.\n\n◾ dataFormat - Type of the file.\n\n◾ table - Name of the table.\nThis parameter must be set for XLS , XLSX , HTML and XML files.", + "description": "Lists the fields of a table for a folder connection.\n\nFileType:\n\nRecognized file formats are:\n\n• CSV for Delimited\n\n• FIX for Fixed Record\n\n• DIF for Data Interchange Format\n\n• EXCELBIFF_ for Microsoft Excel (XLS)\n\n• EXCELOOXML_ for Microsoft Excel (XLSX)\n\n• HTML for HTML\n\n• QVD for QVD file\n\n• XML for XML\n\n• QVX for QVX file\n\n• JSON for JSON format\n\n• KML for KML file\n\n• PARQUET for PARQUET file\n\nParameters:\n\n◾ connectionId - Identifier of the connection.\n\n◾ relativePath - Path of the connection file.\n\n◾ dataFormat - Type of the file.\n\n◾ table - Name of the table.\nThis parameter must be set for XLS , XLSX , HTML   and XML files.", "x-qlik-stability": "locked", "type": "method", "params": [ @@ -3770,7 +3794,7 @@ ] }, "GetFileTablePreview": { - "description": "Lists the values in a table for a folder connection.\n\nFileType:\n\nRecognized file formats are:\n\n• CSV for Delimited\n\n• FIX for Fixed Record\n\n• DIF for Data Interchange Format\n\n• EXCELBIFF_ for Microsoft Excel (XLS)\n\n• EXCELOOXML_ for Microsoft Excel (XLSX)\n\n• HTML for HTML\n\n• QVD for QVD file\n\n• XML for XML\n\n• QVX for QVX file\n\n• JSON for JSON format\n\n• KML for KML file\n\n• PARQUET for PARQUET file\n\nParameters:\n\n◾ connectionId - Identifier of the connection.\n\n◾ relativePath - Path of the connection file.\n\n◾ dataFormat - Type of the file.\n\n◾ table - Name of the table.\nThis parameter must be set for XLS , XLSX , HTML and XML files.", + "description": "Lists the values in a table for a folder connection.\n\nFileType:\n\nRecognized file formats are:\n\n• CSV for Delimited\n\n• FIX for Fixed Record\n\n• DIF for Data Interchange Format\n\n• EXCELBIFF_ for Microsoft Excel (XLS)\n\n• EXCELOOXML_ for Microsoft Excel (XLSX)\n\n• HTML for HTML\n\n• QVD for QVD file\n\n• XML for XML\n\n• QVX for QVX file\n\n• JSON for JSON format\n\n• KML for KML file\n\n• PARQUET for PARQUET file\n\nParameters:\n\n◾ connectionId - Identifier of the connection.\n\n◾ relativePath - Path of the connection file.\n\n◾ dataFormat - Type of the file.\n\n◾ table - Name of the table.\nThis parameter must be set for XLS , XLSX , HTML   and XML files.", "x-qlik-stability": "locked", "type": "method", "params": [ @@ -3806,7 +3830,7 @@ ] }, "GetFileTablePreviewRaw": { - "description": "Lists the values in a table for a folder connection.\n\nFileType:\n\nRecognized file formats are:\n\n• CSV for Delimited\n\n• FIX for Fixed Record\n\n• DIF for Data Interchange Format\n\n• EXCELBIFF_ for Microsoft Excel (XLS)\n\n• EXCELOOXML_ for Microsoft Excel (XLSX)\n\n• HTML for HTML\n\n• QVD for QVD file\n\n• XML for XML\n\n• QVX for QVX file\n\n• JSON for JSON format\n\n• KML for KML file\n\n• PARQUET for PARQUET file\n\nParameters:\n\n◾ connectionId - Identifier of the connection.\n\n◾ relativePath - Path of the connection file.\n\n◾ dataFormat - Type of the file.\n\n◾ table - Name of the table.\nThis parameter must be set for XLS , XLSX , HTML and XML files.", + "description": "Lists the values in a table for a folder connection.\n\nFileType:\n\nRecognized file formats are:\n\n• CSV for Delimited\n\n• FIX for Fixed Record\n\n• DIF for Data Interchange Format\n\n• EXCELBIFF_ for Microsoft Excel (XLS)\n\n• EXCELOOXML_ for Microsoft Excel (XLSX)\n\n• HTML for HTML\n\n• QVD for QVD file\n\n• XML for XML\n\n• QVX for QVX file\n\n• JSON for JSON format\n\n• KML for KML file\n\n• PARQUET for PARQUET file\n\nParameters:\n\n◾ connectionId - Identifier of the connection.\n\n◾ relativePath - Path of the connection file.\n\n◾ dataFormat - Type of the file.\n\n◾ table - Name of the table.\nThis parameter must be set for XLS , XLSX , HTML   and XML files.", "x-qlik-stability": "locked", "type": "method", "params": [ @@ -3839,7 +3863,7 @@ ] }, "GetFileTables": { - "description": "Lists the tables for a folder connection.\n\nFileType:\n\nRecognized file formats are:\n\n• CSV for Delimited\n\n• FIX for Fixed Record\n\n• DIF for Data Interchange Format\n\n• EXCELBIFF_ for Microsoft Excel (XLS)\n\n• EXCELOOXML_ for Microsoft Excel (XLSX)\n\n• HTML for HTML\n\n• QVD for QVD file\n\n• XML for XML\n\n• QVX for QVX file\n\n• JSON for JSON format\n\n• KML for KML file\n\n• PARQUET for PARQUET file\n\nParameters:\n\n◾ connectionId - Identifier of the connection.\n\n◾ relativePath - Path of the connection file.\n\n◾ dataFormat - Type of the file.", + "description": "Lists the tables for a folder connection.\n\nFileType:\n\nRecognized file formats are:\n\n• CSV for Delimited\n\n• FIX for Fixed Record\n\n• DIF for Data Interchange Format\n\n• EXCELBIFF_ for Microsoft Excel (XLS)\n\n• EXCELOOXML_ for Microsoft Excel (XLSX)\n\n• HTML for HTML\n\n• QVD for QVD file\n\n• XML for XML\n\n• QVX for QVX file\n\n• JSON for JSON format\n\n• KML for KML file\n\n• PARQUET for PARQUET file\n\nParameters:\n\n◾ connectionId - Identifier of the connection.\n\n◾ relativePath - Path of the connection file.\n\n◾ dataFormat - Type of the file.", "x-qlik-stability": "locked", "type": "method", "params": [ @@ -3926,7 +3950,7 @@ ] }, "GetFileTablesRaw": { - "description": "Lists the tables for a folder connection.\n\nFileType:\n\nRecognized file formats are:\n\n• CSV for Delimited\n\n• FIX for Fixed Record\n\n• DIF for Data Interchange Format\n\n• EXCELBIFF_ for Microsoft Excel (XLS)\n\n• EXCELOOXML_ for Microsoft Excel (XLSX)\n\n• HTML for HTML\n\n• QVD for QVD file\n\n• XML for XML\n\n• QVX for QVX file\n\n• JSON for JSON format\n\n• KML for KML file\n\n• PARQUET for PARQUET file\n\nParameters:\n\n◾ connectionId - Identifier of the connection.\n\n◾ relativePath - Path of the connection file.\n\n◾ dataFormat - Type of the file.", + "description": "Lists the tables for a folder connection.\n\nFileType:\n\nRecognized file formats are:\n\n• CSV for Delimited\n\n• FIX for Fixed Record\n\n• DIF for Data Interchange Format\n\n• EXCELBIFF_ for Microsoft Excel (XLS)\n\n• EXCELOOXML_ for Microsoft Excel (XLSX)\n\n• HTML for HTML\n\n• QVD for QVD file\n\n• XML for XML\n\n• QVX for QVX file\n\n• JSON for JSON format\n\n• KML for KML file\n\n• PARQUET for PARQUET file\n\nParameters:\n\n◾ connectionId - Identifier of the connection.\n\n◾ relativePath - Path of the connection file.\n\n◾ dataFormat - Type of the file.", "x-qlik-stability": "locked", "type": "method", "params": [ @@ -4893,7 +4917,7 @@ ] }, "GuessFileType": { - "description": "Guesses the data format for a given file.\nRecognized file formats are:\n\n• CSV for Delimited\n\n• FIX for Fixed Record\n\n• DIF for Data Interchange Format\n\n• EXCELBIFF_ for Microsoft Excel (XLS)\n\n• EXCELOOXML_ for Microsoft Excel (XLSX)\n\n• HTML for HTML\n\n• QVD for QVD file\n\n• XML for XML\n\n• QVX for QVX file\n\n• JSON for JSON format\n\n• KML for KML file\n\n• PARQUET for PARQUET file\n\nFileType:\n\nRecognized file formats are:\n\n• CSV for Delimited\n\n• FIX for Fixed Record\n\n• DIF for Data Interchange Format\n\n• EXCELBIFF_ for Microsoft Excel (XLS)\n\n• EXCELOOXML_ for Microsoft Excel (XLSX)\n\n• HTML for HTML\n\n• QVD for QVD file\n\n• XML for XML\n\n• QVX for QVX file\n\n• JSON for JSON format\n\n• KML for KML file\n\n• PARQUET for PARQUET file\n\nParameters:\n\n◾ connectionId - Identifier of the connection file.\n\n◾ relativePath - Path of the connection file.", + "description": "Guesses the data format for a given file.\nRecognized file formats are:\n\n• CSV for Delimited\n\n• FIX for Fixed Record\n\n• DIF for Data Interchange Format\n\n• EXCELBIFF_ for Microsoft Excel (XLS)\n\n• EXCELOOXML_ for Microsoft Excel (XLSX)\n\n• HTML for HTML\n\n• QVD for QVD file\n\n• XML for XML\n\n• QVX for QVX file\n\n• JSON for JSON format\n\n• KML for KML file\n\n• PARQUET for PARQUET file\n\nFileType:\n\nRecognized file formats are:\n\n• CSV for Delimited\n\n• FIX for Fixed Record\n\n• DIF for Data Interchange Format\n\n• EXCELBIFF_ for Microsoft Excel (XLS)\n\n• EXCELOOXML_ for Microsoft Excel (XLSX)\n\n• HTML for HTML\n\n• QVD for QVD file\n\n• XML for XML\n\n• QVX for QVX file\n\n• JSON for JSON format\n\n• KML for KML file\n\n• PARQUET for PARQUET file\n\nParameters:\n\n◾ connectionId - Identifier of the connection file.\n\n◾ relativePath - Path of the connection file.", "x-qlik-stability": "locked", "type": "method", "params": [ @@ -4917,7 +4941,7 @@ ] }, "GuessFileTypeRaw": { - "description": "Guesses the data format for a given file.\nRecognized file formats are:\n\n• CSV for Delimited\n\n• FIX for Fixed Record\n\n• DIF for Data Interchange Format\n\n• EXCELBIFF_ for Microsoft Excel (XLS)\n\n• EXCELOOXML_ for Microsoft Excel (XLSX)\n\n• HTML for HTML\n\n• QVD for QVD file\n\n• XML for XML\n\n• QVX for QVX file\n\n• JSON for JSON format\n\n• KML for KML file\n\n• PARQUET for PARQUET file\n\nFileType:\n\nRecognized file formats are:\n\n• CSV for Delimited\n\n• FIX for Fixed Record\n\n• DIF for Data Interchange Format\n\n• EXCELBIFF_ for Microsoft Excel (XLS)\n\n• EXCELOOXML_ for Microsoft Excel (XLSX)\n\n• HTML for HTML\n\n• QVD for QVD file\n\n• XML for XML\n\n• QVX for QVX file\n\n• JSON for JSON format\n\n• KML for KML file\n\n• PARQUET for PARQUET file\n\nParameters:\n\n◾ connectionId - Identifier of the connection file.\n\n◾ relativePath - Path of the connection file.", + "description": "Guesses the data format for a given file.\nRecognized file formats are:\n\n• CSV for Delimited\n\n• FIX for Fixed Record\n\n• DIF for Data Interchange Format\n\n• EXCELBIFF_ for Microsoft Excel (XLS)\n\n• EXCELOOXML_ for Microsoft Excel (XLSX)\n\n• HTML for HTML\n\n• QVD for QVD file\n\n• XML for XML\n\n• QVX for QVX file\n\n• JSON for JSON format\n\n• KML for KML file\n\n• PARQUET for PARQUET file\n\nFileType:\n\nRecognized file formats are:\n\n• CSV for Delimited\n\n• FIX for Fixed Record\n\n• DIF for Data Interchange Format\n\n• EXCELBIFF_ for Microsoft Excel (XLS)\n\n• EXCELOOXML_ for Microsoft Excel (XLSX)\n\n• HTML for HTML\n\n• QVD for QVD file\n\n• XML for XML\n\n• QVX for QVX file\n\n• JSON for JSON format\n\n• KML for KML file\n\n• PARQUET for PARQUET file\n\nParameters:\n\n◾ connectionId - Identifier of the connection file.\n\n◾ relativePath - Path of the connection file.", "x-qlik-stability": "locked", "type": "method", "params": [ @@ -5987,6 +6011,10 @@ "Title": { "description": "Title of the app.", "type": "string" + }, + "Usage": { + "description": "One of:\n\n• ANALYTICS or ANALYTICS_USAGE\n\n• DATA_PREPARATION or DATA_PREPARATION_USAGE", + "type": "string" } } }, @@ -7112,7 +7140,7 @@ } }, "FileDataFormat": { - "description": "FileType:\n\nRecognized file formats are:\n\n• CSV for Delimited\n\n• FIX for Fixed Record\n\n• DIF for Data Interchange Format\n\n• EXCELBIFF_ for Microsoft Excel (XLS)\n\n• EXCELOOXML_ for Microsoft Excel (XLSX)\n\n• HTML for HTML\n\n• QVD for QVD file\n\n• XML for XML\n\n• QVX for QVX file\n\n• JSON for JSON format\n\n• KML for KML file\n\n• PARQUET for PARQUET file", + "description": "FileType:\n\nRecognized file formats are:\n\n• CSV for Delimited\n\n• FIX for Fixed Record\n\n• DIF for Data Interchange Format\n\n• EXCELBIFF_ for Microsoft Excel (XLS)\n\n• EXCELOOXML_ for Microsoft Excel (XLSX)\n\n• HTML for HTML\n\n• QVD for QVD file\n\n• XML for XML\n\n• QVX for QVX file\n\n• JSON for JSON format\n\n• KML for KML file\n\n• PARQUET for PARQUET file", "type": "struct", "entries": { "CodePage": { @@ -8939,7 +8967,7 @@ ] }, "ExportData": { - "description": "Exports the data of any generic object to an Excel file or a open XML file. If the object contains excluded values, those excluded values are not exported.\nThis API has limited functionality and will not support CSV export from all types of objects. Consider using Excel export instead. Treemap and bar chart are not supported.\nExportData method is not supported in SaaS Editions of Qlik Sense.\n\nDefault limitations in number of rows and columns:\n\nThe default maximum number of rows and columns in the Excel export file is:\n\n• 1048566 rows per sheet. For pivot tables: 1048566 column dimensions. 10 rows can be added after the export.\n\n• 16384 columns per sheet. If the number of columns exceeds the limit, the exported file is truncated and a warning message is sent.\n\nDefault limitation in number of columns:\n\nThe default maximum number of columns in the export file is:\n\n• 1000 to export to a CSV file\n\nThe exported file is truncated if the number of cells exceeds the limit. A warning message with code 1000 is sent.\nThere is an option to export only the possible values ( qExportState is P).\n\nDefault limitation in size:\n\nIf the exported file is larger than the maximum value, then an out-of-memory error with code 13000 is returned.\n\nExported files are temporary and are available only for a certain time span and only to the user who created them.\n\nParameters:\n\n◾ fileType - Type of the file to export.\n\nOne of:\n\n• CSV_C or EXPORT_CSV_C\n\n• CSV_T or EXPORT_CSV_T\n\n• OOXML or EXPORT_OOXML\n\n• PARQUET or EXPORT_PARQUET\n\n◾ path - Path to the definition of the object to be exported.\nFor example, /qHyperCubeDef .\nThis parameter is mandatory if the file type is CSVC_ or CSVT_ .\n\n◾ fileName - Name of the exported file after download from browser.\nThis parameter is optional and only used in Qlik Sense Desktop.\n\n◾ exportState - Defines the values to be exported.\nThe default value is A.\n\nOne of:\n\n• P or EXPORT_POSSIBLE\n\n• A or EXPORT_ALL\n\n◾ serveOnce - If the exported file should be served only once\nThis parameter is optional and only used in Qlik Sense Enterprise (Windows)\nDefault value: false", + "description": "Exports the data of any generic object to an Excel file or a open XML file. If the object contains excluded values, those excluded values are not exported.\nThis API has limited functionality and will not support CSV export from all types of objects. Consider using Excel export instead. Treemap and bar chart are not supported.\nExportData method is not supported in SaaS Editions of Qlik Sense.\n\nDefault limitations in number of rows and columns:\n\nThe default maximum number of rows and columns in the Excel export file is:\n\n• 1048566 rows per sheet. For pivot tables: 1048566 column dimensions. 10 rows can be added after the export.\n\n• 16384 columns per sheet. If the number of columns exceeds the limit, the exported file is truncated and a warning message is sent.\n\nDefault limitation in number of columns:\n\nThe default maximum number of columns in the export file is:\n\n• 1000 to export to a CSV file\n\nDefault limitations in number of cells:\n\nThe default maximum number of cells in the export file is:\n\n• 5000000 to export to a CSV file\n\nThe exported file is truncated if the number of cells exceeds the limit. A warning message with code 1000 is sent.\nThere is an option to export only the possible values ( qExportState is P).\n\nDefault limitation in size:\n\nIf the exported file is larger than the maximum value, then an out-of-memory error with code 13000 is returned.\n\nExported files are temporary and are available only for a certain time span and only to the user who created them.\n\nParameters:\n\n◾ fileType - Type of the file to export.\n\nOne of:\n\n• CSV_C or EXPORT_CSV_C\n\n• CSV_T or EXPORT_CSV_T\n\n• OOXML or EXPORT_OOXML\n\n• PARQUET or EXPORT_PARQUET\n\n◾ path - Path to the definition of the object to be exported.\nFor example, /qHyperCubeDef .\nThis parameter is mandatory if the file type is CSVC_ or CSVT_ .\n\n◾ fileName - Name of the exported file after download from browser.\nThis parameter is optional and only used in Qlik Sense Desktop.\n\n◾ exportState - Defines the values to be exported.\nThe default value is A.\n\nOne of:\n\n• P or EXPORT_POSSIBLE\n\n• A or EXPORT_ALL\n\n◾ serveOnce - If the exported file should be served only once\nThis parameter is optional and only used in Qlik Sense Enterprise (Windows)\nDefault value: false", "x-qlik-stability": "locked", "type": "method", "params": [ @@ -9368,7 +9396,7 @@ ] }, "GetHyperCubeReducedData": { - "description": "Reduces the data of a bar chart, a line chart or a scatter plot chart and retrieves them.\nThe reduction is dependent on the zoom factor (parameter qZoomFactor ) and on the reduction mode.\nThis method can be used to create mini charts.\n\nBar chart or line chart data reduction:\n\nFor the data reduction to happen, the following conditions must be fulfilled:\n\n• The values cannot fit in the defined page (parameter qPages ).\n\n• The zoom factor is not 0 (parameter qZoomFactor ).\n\n• The reduction mode must be set to D1.\n\nThe reduction algorithm keeps the shape of the visualizations and works whatever the number of dimensions in the chart. The global profile of the chart is reduced, and not only a specific dimension. A visualization that has been reduced contains fewer values but its shape is the same. Data of all types can be reduced. Therefore it is hard to relate the values before and after a reduction especially when reducing string values.\n\nExample:\n\nIf you have a chart with 1 million data, and you have set the zoom factor to 5, the GetHyperCubeReducedData method reduces the chart and retrieves 200 000 data.\n\nScatter plot chart data reduction:\n\nThe reduction mode must be set to C.\nThis reduction mechanism follows the 2D K-Means algorithm. Data are reduced into a number of clusters. Each data is assigned to a specific centroid.\nThe number of centroids can be defined in the parameter qZoomFactor.\n\nScatter plot chart resolution reduction:\n\nThe reduction mode must be set to S.\nThe resolution is reduced according to the zoom factor (parameter qZoomFactor ).\n\nExample:\n\nIf you have a scatter plot chart and the zoom factor is set to 2, the scatter plot chart resolution is reduced by 4.\n\nParameters:\n\n◾ path - Path to the definition of the object to be selected.\nFor example, /qHyperCubeDef .\n\n◾ pages - Array of pages.\n\n◾ zoomFactor - Defines the zoom factor.\nIf set to -1, the engine decides of the zoom factor.\n\n• If the reduction mode is D1 or S , the zoom factor is 2ⁿ. If the zoom factor is 5, the data are reduced by a factor 32.\n\n• If the reduction mode is C , the zoom factor defines the number of centroids.\n\n◾ reductionMode - Defines the reduction mode.\n\nOne of:\n\n• N or DATA_REDUCTION_NONE\n\n• D1 or DATA_REDUCTION_ONEDIM\n\n• S or DATA_REDUCTION_SCATTERED\n\n• C or DATA_REDUCTION_CLUSTERED\n\n• ST or DATA_REDUCTION_STACKED", + "description": "Reduces the data of a bar chart, a line chart or a scatter plot chart and retrieves them.\nThe reduction is dependent on the zoom factor (parameter qZoomFactor ) and on the reduction mode.\nThis method can be used to create mini charts.\n\nBar chart or line chart data reduction:\n\nFor the data reduction to happen, the following conditions must be fulfilled:\n\n• The values cannot fit in the defined page (parameter qPages ).\n\n• The zoom factor is not 0 (parameter qZoomFactor ).\n\n• The reduction mode must be set to D1.\n\nThe reduction algorithm keeps the shape of the visualizations and works whatever the number of dimensions in the chart. The global profile of the chart is reduced, and not only a specific dimension. A visualization that has been reduced contains fewer values but its shape is the same. Data of all types can be reduced. Therefore it is hard to relate the values before and after a reduction especially when reducing string values.\n\nExample:\n\nIf you have a chart with 1 million data, and you have set the zoom factor to 5, the GetHyperCubeReducedData method reduces the chart and retrieves 200 000 data.\n\nScatter plot chart data reduction:\n\nThe reduction mode must be set to C.\nThis reduction mechanism follows the 2D K-Means algorithm. Data are reduced into a number of clusters. Each data is assigned to a specific centroid.\nThe number of centroids can be defined in the parameter qZoomFactor.\n\nScatter plot chart resolution reduction:\n\nThe reduction mode must be set to S.\nThe resolution is reduced according to the zoom factor (parameter qZoomFactor ).\n\nExample:\n\nIf you have a scatter plot chart and the zoom factor is set to 2, the scatter plot chart resolution is reduced by 4.\n\nParameters:\n\n◾ path - Path to the definition of the object to be selected.\nFor example, /qHyperCubeDef .\n\n◾ pages - Array of pages.\n\n◾ zoomFactor - Defines the zoom factor.\nIf set to -1, the engine decides of the zoom factor.\n\n• If the reduction mode is D1 or S , the zoom factor is 2ⁿ. If the zoom factor is 5, the data are reduced by a factor 32.\n\n• If the reduction mode is C , the zoom factor defines the number of centroids.\n\n◾ reductionMode - Defines the reduction mode.\n\nOne of:\n\n• N or DATA_REDUCTION_NONE\n\n• D1 or DATA_REDUCTION_ONEDIM\n\n• S or DATA_REDUCTION_SCATTERED\n\n• C or DATA_REDUCTION_CLUSTERED\n\n• ST or DATA_REDUCTION_STACKED", "x-qlik-stability": "locked", "type": "method", "params": [ @@ -9404,7 +9432,7 @@ ] }, "GetHyperCubeReducedDataRaw": { - "description": "Reduces the data of a bar chart, a line chart or a scatter plot chart and retrieves them.\nThe reduction is dependent on the zoom factor (parameter qZoomFactor ) and on the reduction mode.\nThis method can be used to create mini charts.\n\nBar chart or line chart data reduction:\n\nFor the data reduction to happen, the following conditions must be fulfilled:\n\n• The values cannot fit in the defined page (parameter qPages ).\n\n• The zoom factor is not 0 (parameter qZoomFactor ).\n\n• The reduction mode must be set to D1.\n\nThe reduction algorithm keeps the shape of the visualizations and works whatever the number of dimensions in the chart. The global profile of the chart is reduced, and not only a specific dimension. A visualization that has been reduced contains fewer values but its shape is the same. Data of all types can be reduced. Therefore it is hard to relate the values before and after a reduction especially when reducing string values.\n\nExample:\n\nIf you have a chart with 1 million data, and you have set the zoom factor to 5, the GetHyperCubeReducedData method reduces the chart and retrieves 200 000 data.\n\nScatter plot chart data reduction:\n\nThe reduction mode must be set to C.\nThis reduction mechanism follows the 2D K-Means algorithm. Data are reduced into a number of clusters. Each data is assigned to a specific centroid.\nThe number of centroids can be defined in the parameter qZoomFactor.\n\nScatter plot chart resolution reduction:\n\nThe reduction mode must be set to S.\nThe resolution is reduced according to the zoom factor (parameter qZoomFactor ).\n\nExample:\n\nIf you have a scatter plot chart and the zoom factor is set to 2, the scatter plot chart resolution is reduced by 4.\n\nParameters:\n\n◾ path - Path to the definition of the object to be selected.\nFor example, /qHyperCubeDef .\n\n◾ pages - Array of pages.\n\n◾ zoomFactor - Defines the zoom factor.\nIf set to -1, the engine decides of the zoom factor.\n\n• If the reduction mode is D1 or S , the zoom factor is 2ⁿ. If the zoom factor is 5, the data are reduced by a factor 32.\n\n• If the reduction mode is C , the zoom factor defines the number of centroids.\n\n◾ reductionMode - Defines the reduction mode.\n\nOne of:\n\n• N or DATA_REDUCTION_NONE\n\n• D1 or DATA_REDUCTION_ONEDIM\n\n• S or DATA_REDUCTION_SCATTERED\n\n• C or DATA_REDUCTION_CLUSTERED\n\n• ST or DATA_REDUCTION_STACKED", + "description": "Reduces the data of a bar chart, a line chart or a scatter plot chart and retrieves them.\nThe reduction is dependent on the zoom factor (parameter qZoomFactor ) and on the reduction mode.\nThis method can be used to create mini charts.\n\nBar chart or line chart data reduction:\n\nFor the data reduction to happen, the following conditions must be fulfilled:\n\n• The values cannot fit in the defined page (parameter qPages ).\n\n• The zoom factor is not 0 (parameter qZoomFactor ).\n\n• The reduction mode must be set to D1.\n\nThe reduction algorithm keeps the shape of the visualizations and works whatever the number of dimensions in the chart. The global profile of the chart is reduced, and not only a specific dimension. A visualization that has been reduced contains fewer values but its shape is the same. Data of all types can be reduced. Therefore it is hard to relate the values before and after a reduction especially when reducing string values.\n\nExample:\n\nIf you have a chart with 1 million data, and you have set the zoom factor to 5, the GetHyperCubeReducedData method reduces the chart and retrieves 200 000 data.\n\nScatter plot chart data reduction:\n\nThe reduction mode must be set to C.\nThis reduction mechanism follows the 2D K-Means algorithm. Data are reduced into a number of clusters. Each data is assigned to a specific centroid.\nThe number of centroids can be defined in the parameter qZoomFactor.\n\nScatter plot chart resolution reduction:\n\nThe reduction mode must be set to S.\nThe resolution is reduced according to the zoom factor (parameter qZoomFactor ).\n\nExample:\n\nIf you have a scatter plot chart and the zoom factor is set to 2, the scatter plot chart resolution is reduced by 4.\n\nParameters:\n\n◾ path - Path to the definition of the object to be selected.\nFor example, /qHyperCubeDef .\n\n◾ pages - Array of pages.\n\n◾ zoomFactor - Defines the zoom factor.\nIf set to -1, the engine decides of the zoom factor.\n\n• If the reduction mode is D1 or S , the zoom factor is 2ⁿ. If the zoom factor is 5, the data are reduced by a factor 32.\n\n• If the reduction mode is C , the zoom factor defines the number of centroids.\n\n◾ reductionMode - Defines the reduction mode.\n\nOne of:\n\n• N or DATA_REDUCTION_NONE\n\n• D1 or DATA_REDUCTION_ONEDIM\n\n• S or DATA_REDUCTION_SCATTERED\n\n• C or DATA_REDUCTION_CLUSTERED\n\n• ST or DATA_REDUCTION_STACKED", "x-qlik-stability": "locked", "type": "method", "params": [ @@ -9581,7 +9609,7 @@ ] }, "GetLayout": { - "description": "Evaluates an object and displays its properties including the dynamic properties.\nIf the member delta is set to true in the request object, only the delta is evaluated. A GetLayout call on a generic object, returns up to one level down in the hierarchy.\n\nExample::\n\n_A_ is a generic object and is the parent of the objects B and C. B is the parent of the objects D and E.\n\n![](images/dr_gen_QVCPMethodGetLayoutHierarchy.png)\n\nA GetLayout call on A returns information on the objects A, B and C.\nA GetLayout call on B returns information on the objects B, D and E.\nA GetLayout call on C returns information on the object C.\n\nIn addition to the parameters displayed above, the GetLayout method can return other properties according to what is defined in the generic object.\nFor example, if qHyperCubeDef is defined in the generic object, the GetLayout method returns the properties described in HyperCube.", + "description": "Evaluates an object and displays its properties including the dynamic properties.\nIf the member delta is set to true in the request object, only the delta is evaluated. A GetLayout call on a generic object, returns up to one level down in the hierarchy.\n\nExample::\n\n_A_ is a generic object and is the parent of the objects B and C. B is the parent of the objects D and E.\n\n![](images/dr_gen_QVCPMethodGetLayoutHierarchy.png)\n\nA GetLayout call on A returns information on the objects A, B and C.\nA GetLayout call on B returns information on the objects B, D and E.\nA  GetLayout call on C returns information on the object C.\n\nIn addition to the parameters displayed above, the GetLayout method can return other properties according to what is defined in the generic object.\nFor example, if qHyperCubeDef is defined in the generic object, the GetLayout method returns the properties described in HyperCube.", "x-qlik-stability": "locked", "type": "method", "params": [ @@ -9599,7 +9627,7 @@ ] }, "GetLayoutRaw": { - "description": "Evaluates an object and displays its properties including the dynamic properties.\nIf the member delta is set to true in the request object, only the delta is evaluated. A GetLayout call on a generic object, returns up to one level down in the hierarchy.\n\nExample::\n\n_A_ is a generic object and is the parent of the objects B and C. B is the parent of the objects D and E.\n\n![](images/dr_gen_QVCPMethodGetLayoutHierarchy.png)\n\nA GetLayout call on A returns information on the objects A, B and C.\nA GetLayout call on B returns information on the objects B, D and E.\nA GetLayout call on C returns information on the object C.\n\nIn addition to the parameters displayed above, the GetLayout method can return other properties according to what is defined in the generic object.\nFor example, if qHyperCubeDef is defined in the generic object, the GetLayout method returns the properties described in HyperCube.", + "description": "Evaluates an object and displays its properties including the dynamic properties.\nIf the member delta is set to true in the request object, only the delta is evaluated. A GetLayout call on a generic object, returns up to one level down in the hierarchy.\n\nExample::\n\n_A_ is a generic object and is the parent of the objects B and C. B is the parent of the objects D and E.\n\n![](images/dr_gen_QVCPMethodGetLayoutHierarchy.png)\n\nA GetLayout call on A returns information on the objects A, B and C.\nA GetLayout call on B returns information on the objects B, D and E.\nA  GetLayout call on C returns information on the object C.\n\nIn addition to the parameters displayed above, the GetLayout method can return other properties according to what is defined in the generic object.\nFor example, if qHyperCubeDef is defined in the generic object, the GetLayout method returns the properties described in HyperCube.", "x-qlik-stability": "locked", "type": "method", "params": [ @@ -10063,7 +10091,7 @@ ] }, "SelectHyperCubeCells": { - "description": "Makes selections in multiple dimensions and measures.\nThis method applies to hypercubes, such as bar charts, tables and scatter plots.\n\nThe member Change returns the handles of the objects that are updated following the selections.\n_qSuccess_ is set to true if the selections are successful and is set to false in the following cases:\n\n• The object contains some invalid fields (fields that are not in the data model).\n\n• The selection applies to a locked field.\n\n• A range selection is performed and the parameter OneAndOnlyOne is set to true in the definition of the object.\n\nParameters:\n\n◾ path - Path to the definition of the object to be selected.\nFor example, /qHyperCubeDef .\n\n◾ rowIndices - Array of row indexes to select, starting from 0.\nIf the array is empty [ ] , all rows are selected.\n\n◾ colIndices - Indexes of the columns to select, starting from 0.\nA column corresponds to a dimension in the order they are added to the hypercube.\nIf a column is hidden it is ignored, qColIndex n refers to the n:th visible column (starting from zero).\nExample:\nIf the hypercube has two dimensions:\n\n• [0] selects the first column (i.e the first dimension).\n\n• [1] selects the second column (i.e the second dimension).\n\nIf the array is empty [ ] , all columns are selected.\n\n◾ softLock - Set to true to ignore locks; in that case, locked fields can be selected.\n\n◾ deselectOnlyOneSelected - Set this parameter to true to unselect the last single selected value. There must be only one selected value in the field.\nThe default value is false.", + "description": "Makes selections in multiple dimensions and measures.\nThis method applies to hypercubes, such as bar charts, tables and scatter plots.\n\nThe member Change returns the handles of the objects that are updated following the selections.\n_qSuccess_ is set to true if the selections are successful and is set to false in the following cases:\n\n• The object contains some invalid fields (fields that are not in the data model).\n\n• The selection applies to a locked field.\n\n• A range selection is performed and the parameter OneAndOnlyOne is set to true in the definition of the object.\n\nParameters:\n\n◾ path - Path to the definition of the object to be selected.\nFor example, /qHyperCubeDef .\n\n◾ rowIndices - Array of row indexes to select, starting from 0.\nIf the array is empty [ ] , all rows are selected.\n\n◾ colIndices - Indexes of the columns to select, starting from 0.\nA column corresponds to a dimension in the order they are added to the hypercube.\nIf a column is hidden it is ignored, qColIndex n refers to the n:th visible column (starting from zero).\nExample:\nIf the hypercube has two dimensions:\n\n• [0] selects the first column (i.e the first dimension).\n\n• [1] selects the second column (i.e the second dimension).\n\nIf the array is empty [ ] , all columns are selected.\n\n◾ softLock - Set to true to ignore locks; in that case, locked fields can be selected.\n\n◾ deselectOnlyOneSelected - Set this parameter to true to unselect the last single selected value. There must be only one selected value in the field.\nThe default value is false.", "x-qlik-stability": "locked", "type": "method", "params": [ @@ -10378,7 +10406,7 @@ ] }, "SelectPivotCells": { - "description": "This method only applies to hypercubes that are not represented as straight tables. The parameter qMode in HyperCubeDef must be set either to P or K .\n\nPivot table:\n\nMakes selections in the top or left dimension cells of a pivot table or in the data matrix. Only expanded dimensions can be selected.\n\nStacked table:\n\nMakes selections in the left dimension cells of a stacked table or in the data matrix.\nThere is no top dimensions in a stacked table. A stacked table can only contain one measure.\n\nExample of a pivot table:\n\n![](images/ui_gen_ExampleQVCPPivotTableDescription.png)\n\nIn the representation above:\n\n +-------------------+--------------------------------+\n | Sum(OrderTotal) | Are pseudo dimensions. |\n | Count(OrderTotal) | |\n | CategoryName | Is a left dimension. |\n | | Beverages , Condiments ... are |\n | | left dimension values. |\n | ProductName | Is a top dimension. Chef |\n | | Anton's Cajun Seasoning is a |\n | | top dimension value. |\n | Numeric values | Are calculated values in the |\n | | data matrix. 626291,832 is a |\n | | calculated value. |\n +-------------------+--------------------------------+\n\nThe member Change returns the handles of the objects that are updated following the selections.\n_qSuccess_ is set to true if the selections are successful and is set to false in the following cases:\n\n• The object contains some invalid fields (fields that are not in the data model).\n\n• The selection applies to a locked field.\n\n• A range selection is performed and the parameter OneAndOnlyOne is set to true in the definition of the object.\n\nParameters:\n\n◾ path - Path to the definition of the object.\nFor example, /qHyperCubeDef .\n\n◾ selections - Information about the selections to perform.\n\n◾ softLock - Set to true to ignore locks; in that case, locked fields can be selected.\n\n◾ deselectOnlyOneSelected - Set this parameter to true to unselect the last single selected value. There must be only one selected value in the field.\nThe default value is false.", + "description": "This method only applies to hypercubes that are not represented as straight tables. The parameter qMode in HyperCubeDef must be set either to P  or K .\n\nPivot table:\n\nMakes selections in the top or left dimension cells of a pivot table or in the data matrix. Only expanded dimensions can be selected.\n\nStacked table:\n\nMakes selections in the left dimension cells of a stacked table or in the data matrix.\nThere is no top dimensions in a stacked table. A stacked table can only contain one measure.\n\nExample of a pivot table:\n\n![](images/ui_gen_ExampleQVCPPivotTableDescription.png)\n\nIn the representation above:\n\n +-------------------+--------------------------------+\n | Sum(OrderTotal) | Are pseudo dimensions. |\n | Count(OrderTotal) | |\n | CategoryName | Is a left dimension. |\n | | Beverages , Condiments ... are |\n | | left dimension values. |\n | ProductName | Is a top dimension. Chef |\n | | Anton's Cajun Seasoning is a |\n | | top dimension value. |\n | Numeric values | Are calculated values in the |\n | | data matrix. 626291,832 is a |\n | | calculated value. |\n +-------------------+--------------------------------+\n\nThe member Change returns the handles of the objects that are updated following the selections.\n_qSuccess_ is set to true if the selections are successful and is set to false in the following cases:\n\n• The object contains some invalid fields (fields that are not in the data model).\n\n• The selection applies to a locked field.\n\n• A range selection is performed and the parameter OneAndOnlyOne is set to true in the definition of the object.\n\nParameters:\n\n◾ path - Path to the definition of the object.\nFor example, /qHyperCubeDef .\n\n◾ selections - Information about the selections to perform.\n\n◾ softLock - Set to true to ignore locks; in that case, locked fields can be selected.\n\n◾ deselectOnlyOneSelected - Set this parameter to true to unselect the last single selected value. There must be only one selected value in the field.\nThe default value is false.", "x-qlik-stability": "locked", "type": "method", "params": [ @@ -10411,7 +10439,7 @@ ] }, "SelectPivotCellsRaw": { - "description": "This method only applies to hypercubes that are not represented as straight tables. The parameter qMode in HyperCubeDef must be set either to P or K .\n\nPivot table:\n\nMakes selections in the top or left dimension cells of a pivot table or in the data matrix. Only expanded dimensions can be selected.\n\nStacked table:\n\nMakes selections in the left dimension cells of a stacked table or in the data matrix.\nThere is no top dimensions in a stacked table. A stacked table can only contain one measure.\n\nExample of a pivot table:\n\n![](images/ui_gen_ExampleQVCPPivotTableDescription.png)\n\nIn the representation above:\n\n +-------------------+--------------------------------+\n | Sum(OrderTotal) | Are pseudo dimensions. |\n | Count(OrderTotal) | |\n | CategoryName | Is a left dimension. |\n | | Beverages , Condiments ... are |\n | | left dimension values. |\n | ProductName | Is a top dimension. Chef |\n | | Anton's Cajun Seasoning is a |\n | | top dimension value. |\n | Numeric values | Are calculated values in the |\n | | data matrix. 626291,832 is a |\n | | calculated value. |\n +-------------------+--------------------------------+\n\nThe member Change returns the handles of the objects that are updated following the selections.\n_qSuccess_ is set to true if the selections are successful and is set to false in the following cases:\n\n• The object contains some invalid fields (fields that are not in the data model).\n\n• The selection applies to a locked field.\n\n• A range selection is performed and the parameter OneAndOnlyOne is set to true in the definition of the object.\n\nParameters:\n\n◾ path - Path to the definition of the object.\nFor example, /qHyperCubeDef .\n\n◾ selections - Information about the selections to perform.\n\n◾ softLock - Set to true to ignore locks; in that case, locked fields can be selected.\n\n◾ deselectOnlyOneSelected - Set this parameter to true to unselect the last single selected value. There must be only one selected value in the field.\nThe default value is false.", + "description": "This method only applies to hypercubes that are not represented as straight tables. The parameter qMode in HyperCubeDef must be set either to P  or K .\n\nPivot table:\n\nMakes selections in the top or left dimension cells of a pivot table or in the data matrix. Only expanded dimensions can be selected.\n\nStacked table:\n\nMakes selections in the left dimension cells of a stacked table or in the data matrix.\nThere is no top dimensions in a stacked table. A stacked table can only contain one measure.\n\nExample of a pivot table:\n\n![](images/ui_gen_ExampleQVCPPivotTableDescription.png)\n\nIn the representation above:\n\n +-------------------+--------------------------------+\n | Sum(OrderTotal) | Are pseudo dimensions. |\n | Count(OrderTotal) | |\n | CategoryName | Is a left dimension. |\n | | Beverages , Condiments ... are |\n | | left dimension values. |\n | ProductName | Is a top dimension. Chef |\n | | Anton's Cajun Seasoning is a |\n | | top dimension value. |\n | Numeric values | Are calculated values in the |\n | | data matrix. 626291,832 is a |\n | | calculated value. |\n +-------------------+--------------------------------+\n\nThe member Change returns the handles of the objects that are updated following the selections.\n_qSuccess_ is set to true if the selections are successful and is set to false in the following cases:\n\n• The object contains some invalid fields (fields that are not in the data model).\n\n• The selection applies to a locked field.\n\n• A range selection is performed and the parameter OneAndOnlyOne is set to true in the definition of the object.\n\nParameters:\n\n◾ path - Path to the definition of the object.\nFor example, /qHyperCubeDef .\n\n◾ selections - Information about the selections to perform.\n\n◾ softLock - Set to true to ignore locks; in that case, locked fields can be selected.\n\n◾ deselectOnlyOneSelected - Set this parameter to true to unselect the last single selected value. There must be only one selected value in the field.\nThe default value is false.", "x-qlik-stability": "locked", "type": "method", "params": [ @@ -11162,12 +11190,15 @@ ] }, "CancelReload": { - "description": "Cancels an ongoing reload. The reload of the app is stopped. The indexation can be canceled and true is still the return value of the reload task.", + "description": "Cancels an ongoing reload. The reload of the app is stopped. The indexation can be canceled and true is still the return value of the reload task.\n\nParameters:\n\n◾ reason - Reason for why the reload was cancelled. This will be echoed back to the user in the script log.", "x-qlik-stability": "locked", "type": "method", "params": [ { "type": "https://golang.org/pkg/context/Context" + }, + { + "type": "string" } ], "returns": [ @@ -11219,7 +11250,7 @@ ] }, "CopyApp": { - "description": "Copies an app that is in the Qlik Sense repository.\nThe engine copies the app into an app entity that was previously created by the repository.\nThis operation is possible only in Qlik Sense Enterprise.\n\nParameters:\n\n◾ targetAppId - Identifier (GUID) of the app entity in the Qlik Sense repository.\nThe app entity must have been previously created by the Qlik Sense Repository Service (QRS) API.\n\n◾ srcAppId - Identifier (GUID) of the source app in the Qlik Sense repository.\n\n◾ ids - Array of QRS identifiers.\nThe list of all objects in the app to be copied must be given. This list must contain the GUIDs of all these objects.\nIf the list of the QRS identifiers is empty, the CopyApp method copies all objects to the target app.\nScript-defined variables are automatically copied when copying an app. To be able to copy variables not created via script, the GUID of each variable must be provided in the list of QRS identifiers.\nTo get the QRS identifiers of the objects in an app, you can use the QRS API. The GET method (from the QRS API) returns the identifiers of the objects in the app.\nThe following example returns the QRS identifiers of all the objects in a specified app:\nGET /qrs/app/9c3f8634-6191-4a34-a114-a39102058d13\nWhere\n_9c3f8634-6191-4a34-a114-a39102058d13_ is the identifier of the app.", + "description": "Copies an app that is in the Qlik Sense repository.\nThe engine copies the app into an app entity that was previously created by the repository.\nThis operation is possible only in Qlik Sense Enterprise.\n\nParameters:\n\n◾ targetAppId - Identifier (GUID) of the app entity in the Qlik Sense repository.\nThe app entity must have been previously created by the Qlik Sense Repository Service (QRS) API.\n\n◾ srcAppId - Identifier (GUID) of the source app in the Qlik Sense repository.\n\n◾ ids - Array of QRS identifiers.\nThe list of all objects in the app to be copied must be given. This list must contain the GUIDs of all these objects.\nIf the list of the QRS identifiers is empty, the CopyApp method copies all objects to the target app.\nScript-defined variables are automatically copied when copying an app. To be able to copy variables not created via script, the GUID of each variable must be provided in the list of QRS identifiers.\nTo get the QRS identifiers of the objects in an app, you can use the QRS API. The GET method (from the QRS API) returns the identifiers of the objects in the app.\nThe following example returns the QRS identifiers of all the objects in a specified app:\nGET /qrs/app/9c3f8634-6191-4a34-a114-a39102058d13\nWhere\n_9c3f8634-6191-4a34-a114-a39102058d13_ is the identifier of the app.", "x-qlik-stability": "locked", "type": "method", "params": [ @@ -13055,7 +13086,7 @@ "type": "struct", "entries": { "Discriminator": { - "description": "A string indicating the origin of the data:\n\n• [filename]: the data comes from a local file.\n\n• INLINE: the data is entered inline in the load script.\n\n• RESIDENT: the data comes from a resident table. The table name is listed.\n\n• AUTOGENERATE: the data is generated from the load script (no external table of data source).\n\n• Provider: the data comes from a data connection. The connector source name is listed.\n\n• [webfile]: the data comes from a web-based file.\n\n• STORE: path to QVD or TXT file where data is stored.\n\n• EXTENSION: the data comes from a Server Side Extension (SSE).", + "description": "A string indicating the origin of the data:\n\n• [filename]: the data comes from a local file.\n\n• INLINE: the data is entered inline in the load script.\n\n• RESIDENT: the data comes from a resident table. The table name is listed.\n\n• AUTOGENERATE: the data is generated from the load script (no external table of data source).\n\n• Provider: the data comes from a data connection. The connector source name is listed.\n\n• [webfile]: the data comes from a web-based file.\n\n• STORE: path to QVD or TXT file where data is stored.\n\n• EXTENSION: the data comes from a Server Side Extension (SSE).", "type": "string" }, "Statement": { @@ -13161,7 +13192,7 @@ "type": "#/definitions/CalendarStrings" }, "Collation": { - "description": "Locale name (following language tagging convention RFC 4646):\n_\u003c language\u003e-\u003cREGION\u003e_\nWhere:\n\n• language is a lowercase ISO 639 language code\n\n• REGION specifies an uppercase ISO 3166 country code.\n\nIf this property has not been set in a script, the returned value comes from the Windows operating system.", + "description": "Locale name (following language tagging convention RFC 4646):\n_\u003c language\u003e-\u003cREGION\u003e_\nWhere:\n\n• language is a lowercase ISO  639 language code\n\n• REGION specifies an uppercase ISO 3166 country code.\n\nIf this property has not been set in a script, the returned value comes from the Windows operating system.", "type": "string" }, "CurrentYear": { @@ -13181,7 +13212,7 @@ "type": "int" }, "FirstWeekDay": { - "description": "First day of the week, starting from 0.\nAccording to ISO 8601, Monday is the first day of the week.\n\n• 0 = Monday\n\n• 1 = Tuesday\n\n• ...\n\n• 6 = Sunday\n\nIf this property has not been set in a script, the returned value comes from the Windows operating system.", + "description": "First day of the week, starting from 0.\nAccording to ISO 8601, Monday is the first day of the week.\n\n• 0 = Monday\n\n• 1 = Tuesday\n\n• ...\n\n• 6 = Sunday\n\nIf this property has not been set in a script, the returned value comes from the Windows operating system.", "type": "int" }, "ListSep": { @@ -13477,6 +13508,10 @@ "description": "Is set to true if the app has been updated since the last save.", "type": "bool" }, + "ProhibitBinaryLoad": { + "description": "If set to true, the persisted app cannot be used in a Binary load statement in Qlik load script.", + "type": "bool" + }, "ReadOnly": { "description": "If set to true, it means that the app is read-only.", "type": "bool" @@ -13502,6 +13537,10 @@ "items": { "type": "string" } + }, + "Usage": { + "description": "One of:\n\n• ANALYTICS or ANALYTICS_USAGE\n\n• DATA_PREPARATION or DATA_PREPARATION_USAGE", + "type": "string" } } }, @@ -13532,6 +13571,10 @@ "Title": { "description": "App title.", "type": "string" + }, + "Usage": { + "description": "Indicates whether the app is used for Analytics or DataPreparation\n\nOne of:\n\n• ANALYTICS or ANALYTICS_USAGE\n\n• DATA_PREPARATION or DATA_PREPARATION_USAGE", + "type": "string" } } }, @@ -14457,7 +14500,7 @@ "type": "struct", "entries": { "FieldSelectionMode": { - "description": "Selection mode.\n\nProperties:\n\nOne of:\n\n• NORMAL for a selection in normal mode.\n\n• AND for a selection in AND mode.\n\n• NOT for a selection NOT in AND mode.\nOne of:\n\n• NORMAL or SELECTION_MODE_NORMAL\n\n• AND or SELECTION_MODE_AND\n\n• NOT or SELECTION_MODE_NOT", + "description": "Selection mode.\n\nProperties:\n\nOne of:\n\n• NORMAL for a selection in normal mode.\n\n• AND for a selection in AND mode.\n\n• NOT for a selection NOT in AND mode.\nOne of:\n\n• NORMAL or SELECTION_MODE_NORMAL\n\n• AND or SELECTION_MODE_AND\n\n• NOT or SELECTION_MODE_NOT", "type": "string" }, "Name": { @@ -14665,7 +14708,7 @@ "type": "bool" }, "Tags": { - "description": "Name connected to the measure that is used for search purposes.\nA measure can have several tags.\nThis parameter is optional.", + "description": "Name connected to the measure that is used for search purposes.\nA measure can have several tags.\nThis parameter is optional.", "type": "slice", "items": { "type": "string" @@ -15546,7 +15589,6 @@ } }, "NxTempBookmarkOptions": { - "x-qlik-stability": "experimental", "type": "struct", "entries": { "IncludeAllPatches": { @@ -16143,11 +16185,11 @@ "type": "bool" }, "Description": { - "description": "Description of the ODBC connection.", + "description": "Description of the ODBC connection.", "type": "string" }, "Name": { - "description": "Name of the ODBC connection.", + "description": "Name of the ODBC connection.", "type": "string" }, "UserOnly": { diff --git a/qix_generated.go b/qix_generated.go index 60384bfc..27ca814a 100644 --- a/qix_generated.go +++ b/qix_generated.go @@ -1,4 +1,4 @@ -// Code generated by QIX generator (./schema/generate.go) for Qlik Associative Engine version 12.1678.0 . DO NOT EDIT. +// Code generated by QIX generator (./schema/generate.go) for Qlik Associative Engine version 12.1777.0 . DO NOT EDIT. package enigma @@ -8,7 +8,7 @@ import ( ) // Version of the schema used to generate the enigma.go QIX API -const QIX_SCHEMA_VERSION = "12.1678.0" +const QIX_SCHEMA_VERSION = "12.1777.0" // Deprecated: This will be removed in a future version type AlfaNumString struct { @@ -118,7 +118,7 @@ type AssociationScore struct { type BNFDef struct { // Array of token references that all together build up the definition of the current token. - // Generally, if the array is not empty, the definition is a BNF rule (_qIsBnfRule_ is set to true). However, some BNF rules do have an empty array (_qIsBnfRule_ is set to true, but qBnf is empty). + // Generally, if the array is not empty, the definition is a BNF rule (_qIsBnfRule_ is set to true). However, some BNF  rules do have an empty array (_qIsBnfRule_ is set to true, but qBnf is empty). Bnf []int `json:"qBnf,omitempty"` // Number of the current token definition. Nbr int `json:"qNbr,omitempty"` @@ -419,11 +419,11 @@ type Connection struct { Name string `json:"qName,omitempty"` // One of: // - // • ODBC CONNECT TO [] + // • ODBC CONNECT TO [] // - // • OLEDB CONNECT TO [] + // • OLEDB CONNECT TO [] // - // • CUSTOM CONNECT TO [] + // • CUSTOM CONNECT TO [] // // • "" // @@ -660,6 +660,12 @@ type DoReloadExParams struct { // Optional reload ID. // ID will be automatically generated if not set. ReloadId string `json:"qReloadId,omitempty"` + // Set to true to skip Store statements. + // The default value is false. + SkipStore bool `json:"qSkipStore,omitempty"` + // If greater than or equal 0, defines max number of rows loaded from a data source. + // When set to nil the default value is used, when set to point at a value that value is used (including golang zero values) + RowLimit *int `json:"qRowLimit,omitempty"` } // The result and path to script log for a reload. @@ -705,6 +711,12 @@ type DocListEntry struct { HasSectionAccess bool `json:"qHasSectionAccess,omitempty"` // Is the app a Direct Query app? IsDirectQueryMode bool `json:"qIsDirectQueryMode,omitempty"` + // One of: + // + // • ANALYTICS or ANALYTICS_USAGE + // + // • DATA_PREPARATION or DATA_PREPARATION_USAGE + Usage string `json:"qUsage,omitempty"` } type DriveInfo struct { @@ -1237,7 +1249,7 @@ type FieldValue struct { // // • QVX for QVX file // -// • JSON for JSON format +// • JSON for JSON format // // • KML for KML file // @@ -2008,7 +2020,7 @@ type LineageInfo struct { // // • 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. + // • Provider: the data comes from a data connection. The connector source name is listed. // // • [webfile]: the data comes from a web-based file. // @@ -2126,7 +2138,7 @@ type LocaleInfo struct { // // • ... // - // • 6 = Sunday + // • 6 = Sunday // // If this property has not been set in a script, the returned value comes from the Windows operating system. FirstWeekDay int `json:"qFirstWeekDay,omitempty"` @@ -2157,7 +2169,7 @@ type LocaleInfo struct { // _< language>-_ // Where: // - // • language is a lowercase ISO 639 language code + // • language is a lowercase ISO  639 language code // // • REGION specifies an uppercase ISO 3166 country code. // @@ -2280,6 +2292,8 @@ type NxAppLayout struct { IsOpenedWithoutData bool `json:"qIsOpenedWithoutData,omitempty"` // If set to true, the app is a Session App, i.e. not persistent. IsSessionApp bool `json:"qIsSessionApp,omitempty"` + // If set to true, the persisted app cannot be used in a Binary load statement in Qlik load script. + ProhibitBinaryLoad bool `json:"qProhibitBinaryLoad,omitempty"` // App thumbnail. Thumbnail *StaticContentUrl `json:"qThumbnail,omitempty"` // If set to true, the app is in BDI Direct Query Mode. @@ -2288,6 +2302,12 @@ type NxAppLayout struct { IsDirectQueryMode bool `json:"qIsDirectQueryMode,omitempty"` // Array of features not supported by the app. UnsupportedFeatures []string `json:"qUnsupportedFeatures,omitempty"` + // One of: + // + // • ANALYTICS or ANALYTICS_USAGE + // + // • DATA_PREPARATION or DATA_PREPARATION_USAGE + Usage string `json:"qUsage,omitempty"` } // Qlik Sense Desktop: @@ -2327,6 +2347,14 @@ type NxAppProperties struct { Thumbnail *StaticContentUrlDef `json:"qThumbnail,omitempty"` // If true the app has section access configured. HasSectionAccess bool `json:"qHasSectionAccess,omitempty"` + // Indicates whether the app is used for Analytics or DataPreparation + // + // One of: + // + // • ANALYTICS or ANALYTICS_USAGE + // + // • DATA_PREPARATION or DATA_PREPARATION_USAGE + Usage string `json:"qUsage,omitempty"` } // Layout for NxAttrDimDef. @@ -2932,7 +2960,7 @@ type NxFieldSelectionInfo struct { // // • NORMAL for a selection in normal mode. // - // • AND for a selection in AND mode. + // • AND for a selection in AND mode. // // • NOT for a selection NOT in AND mode. // One of: @@ -3048,7 +3076,7 @@ type NxInlineMeasureDef struct { // This parameter is optional. Description string `json:"qDescription,omitempty"` // Name connected to the measure that is used for search purposes. - // A measure can have several tags. + // A measure can have several tags. // This parameter is optional. Tags []string `json:"qTags,omitempty"` // Default value is no grouping. @@ -4366,7 +4394,6 @@ type NxStreamListEntry struct { Id string `json:"qId,omitempty"` } -// Stability: experimental type NxTempBookmarkOptions struct { // IncludeVariables If true all variables will be stored in the temporary bookmark IncludeVariables bool `json:"qIncludeVariables,omitempty"` @@ -4828,9 +4855,9 @@ type ObjectInterface struct { } type OdbcDsn struct { - // Name of the ODBC connection. + // Name of the ODBC connection. Name string `json:"qName,omitempty"` - // Description of the ODBC connection. + // Description of the ODBC connection. Description string `json:"qDescription,omitempty"` // Is set to true if the version of ODBC is 32-bit. // This parameter is optional. Default is false. @@ -5966,7 +5993,7 @@ func (obj *Doc) ApplyBookmark(ctx context.Context, id string) (bool, error) { // // ◾ id - Identifier of the temporary selection state // -// Stability: experimental +// Stability: locked func (obj *Doc) ApplyTemporaryBookmark(ctx context.Context, id string) (bool, error) { result := &struct { Return bool `json:"qReturn"` @@ -6192,6 +6219,13 @@ func (obj *Doc) ClearAll(ctx context.Context, lockedAlso bool, stateName string) return err } +// Clear the soft properties of all generic objects in the app +// Stability: experimental +func (obj *Doc) ClearAllSoftPatches(ctx context.Context) error { + err := obj.RPC(ctx, "ClearAllSoftPatches", nil) + return err +} + // Clears entirely the undo and redo buffer. // Stability: locked func (obj *Doc) ClearUndoBuffer(ctx context.Context) error { @@ -6657,7 +6691,7 @@ func (obj *Doc) CreateSessionVariableRaw(ctx context.Context, prop interface{}) // // ◾ objectIdsToPatch - Add softpatches for this objects if available. If empty all softpatches are added to the bookmark. This is ignored if IncludePatches is false. // -// Stability: experimental +// Stability: locked func (obj *Doc) CreateTemporaryBookmark(ctx context.Context, options *NxTempBookmarkOptions, objectIdsToPatch []string) (string, bool, error) { result := &struct { Id string `json:"qId"` @@ -6676,7 +6710,7 @@ func (obj *Doc) CreateTemporaryBookmark(ctx context.Context, options *NxTempBook // // ◾ objectIdsToPatch - Add softpatches for this objects if available. If empty all softpatches are added to the bookmark. This is ignored if IncludePatches is false. // -// Stability: experimental +// Stability: locked func (obj *Doc) CreateTemporaryBookmarkRaw(ctx context.Context, options interface{}, objectIdsToPatch []string) (string, bool, error) { result := &struct { Id string `json:"qId"` @@ -7674,7 +7708,7 @@ func (obj *Doc) GetContentLibrariesRaw(ctx context.Context) (json.RawMessage, er return result.List, err } -// Gives information about an ODBC, OLEDB or CUSTOM connection. See Outputs for more details. +// Gives information about an ODBC, OLEDB or CUSTOM connection. See Outputs for more details. // // Parameters: // @@ -7689,7 +7723,7 @@ func (obj *Doc) GetDatabaseInfo(ctx context.Context, connectionId string) (*Data return result.Info, err } -// Gives information about an ODBC, OLEDB or CUSTOM connection. See Outputs for more details. +// Gives information about an ODBC, OLEDB or CUSTOM connection. See Outputs for more details. // // Parameters: // @@ -7738,7 +7772,7 @@ func (obj *Doc) GetDatabaseOwnersRaw(ctx context.Context, connectionId string, d return result.Owners, err } -// Lists the fields inside a table of a database for a ODBC, OLEDB or CUSTOM connection. +// Lists the fields inside a table of a database for a ODBC, OLEDB or CUSTOM connection. // // Parameters: // @@ -7761,7 +7795,7 @@ func (obj *Doc) GetDatabaseTableFields(ctx context.Context, connectionId string, return result.Fields, err } -// Lists the fields inside a table of a database for a ODBC, OLEDB or CUSTOM connection. +// Lists the fields inside a table of a database for a ODBC, OLEDB or CUSTOM connection. // // Parameters: // @@ -7784,7 +7818,7 @@ func (obj *Doc) GetDatabaseTableFieldsRaw(ctx context.Context, connectionId stri return result.Fields, err } -// Retrieves the values of the specified table of a database for a ODBC, OLEDB or CUSTOM connection. +// Retrieves the values of the specified table of a database for a ODBC, OLEDB or CUSTOM connection. // // Parameters: // @@ -7810,7 +7844,7 @@ func (obj *Doc) GetDatabaseTablePreview(ctx context.Context, connectionId string return result.Preview, result.RowCount, err } -// Retrieves the values of the specified table of a database for a ODBC, OLEDB or CUSTOM connection. +// Retrieves the values of the specified table of a database for a ODBC, OLEDB or CUSTOM connection. // // Parameters: // @@ -7836,7 +7870,7 @@ func (obj *Doc) GetDatabaseTablePreviewRaw(ctx context.Context, connectionId str return result.Preview, result.RowCount, err } -// Lists the tables inside a database for a ODBC, OLEDB or CUSTOM connection. +// Lists the tables inside a database for a ODBC, OLEDB or CUSTOM connection. // // Parameters: // @@ -7857,7 +7891,7 @@ func (obj *Doc) GetDatabaseTables(ctx context.Context, connectionId string, data return result.Tables, err } -// Lists the tables inside a database for a ODBC, OLEDB or CUSTOM connection. +// Lists the tables inside a database for a ODBC, OLEDB or CUSTOM connection. // // Parameters: // @@ -8168,7 +8202,7 @@ func (obj *Doc) GetFieldsResourceIdsRaw(ctx context.Context, fieldNames []string // // • QVX for QVX file // -// • JSON for JSON format +// • JSON for JSON format // // • KML for KML file // @@ -8183,7 +8217,7 @@ func (obj *Doc) GetFieldsResourceIdsRaw(ctx context.Context, fieldNames []string // ◾ dataFormat - Type of the file. // // ◾ table - Name of the table. -// This parameter must be set for XLS , XLSX , HTML and XML files. +// This parameter must be set for XLS , XLSX , HTML   and XML files. // // Stability: locked func (obj *Doc) GetFileTableFields(ctx context.Context, connectionId string, relativePath string, dataFormat *FileDataFormat, table string) ([]*DataField, string, error) { @@ -8219,7 +8253,7 @@ func (obj *Doc) GetFileTableFields(ctx context.Context, connectionId string, rel // // • QVX for QVX file // -// • JSON for JSON format +// • JSON for JSON format // // • KML for KML file // @@ -8234,7 +8268,7 @@ func (obj *Doc) GetFileTableFields(ctx context.Context, connectionId string, rel // ◾ dataFormat - Type of the file. // // ◾ table - Name of the table. -// This parameter must be set for XLS , XLSX , HTML and XML files. +// This parameter must be set for XLS , XLSX , HTML   and XML files. // // Stability: locked func (obj *Doc) GetFileTableFieldsRaw(ctx context.Context, connectionId string, relativePath string, dataFormat interface{}, table string) (json.RawMessage, string, error) { @@ -8270,7 +8304,7 @@ func (obj *Doc) GetFileTableFieldsRaw(ctx context.Context, connectionId string, // // • QVX for QVX file // -// • JSON for JSON format +// • JSON for JSON format // // • KML for KML file // @@ -8285,7 +8319,7 @@ func (obj *Doc) GetFileTableFieldsRaw(ctx context.Context, connectionId string, // ◾ dataFormat - Type of the file. // // ◾ table - Name of the table. -// This parameter must be set for XLS , XLSX , HTML and XML files. +// This parameter must be set for XLS , XLSX , HTML   and XML files. // // Stability: locked func (obj *Doc) GetFileTablePreview(ctx context.Context, connectionId string, relativePath string, dataFormat *FileDataFormat, table string) ([]*DataRecord, string, error) { @@ -8321,7 +8355,7 @@ func (obj *Doc) GetFileTablePreview(ctx context.Context, connectionId string, re // // • QVX for QVX file // -// • JSON for JSON format +// • JSON for JSON format // // • KML for KML file // @@ -8336,7 +8370,7 @@ func (obj *Doc) GetFileTablePreview(ctx context.Context, connectionId string, re // ◾ dataFormat - Type of the file. // // ◾ table - Name of the table. -// This parameter must be set for XLS , XLSX , HTML and XML files. +// This parameter must be set for XLS , XLSX , HTML   and XML files. // // Stability: locked func (obj *Doc) GetFileTablePreviewRaw(ctx context.Context, connectionId string, relativePath string, dataFormat interface{}, table string) (json.RawMessage, string, error) { @@ -8372,7 +8406,7 @@ func (obj *Doc) GetFileTablePreviewRaw(ctx context.Context, connectionId string, // // • QVX for QVX file // -// • JSON for JSON format +// • JSON for JSON format // // • KML for KML file // @@ -8419,7 +8453,7 @@ func (obj *Doc) GetFileTables(ctx context.Context, connectionId string, relative // // • QVX for QVX file // -// • JSON for JSON format +// • JSON for JSON format // // • KML for KML file // @@ -9204,7 +9238,7 @@ func (obj *Doc) GetViewDlgSaveInfoRaw(ctx context.Context) (json.RawMessage, err // // • QVX for QVX file // -// • JSON for JSON format +// • JSON for JSON format // // • KML for KML file // @@ -9232,7 +9266,7 @@ func (obj *Doc) GetViewDlgSaveInfoRaw(ctx context.Context) (json.RawMessage, err // // • QVX for QVX file // -// • JSON for JSON format +// • JSON for JSON format // // • KML for KML file // @@ -9274,7 +9308,7 @@ func (obj *Doc) GuessFileType(ctx context.Context, connectionId string, relative // // • QVX for QVX file // -// • JSON for JSON format +// • JSON for JSON format // // • KML for KML file // @@ -9302,7 +9336,7 @@ func (obj *Doc) GuessFileType(ctx context.Context, connectionId string, relative // // • QVX for QVX file // -// • JSON for JSON format +// • JSON for JSON format // // • KML for KML file // @@ -11456,6 +11490,12 @@ func (obj *GenericObject) ExpandTop(ctx context.Context, path string, row int, c // // • 1000 to export to a CSV file // +// Default limitations in number of cells: +// +// The default maximum number of cells in the export file is: +// +// • 5000000 to export to a CSV file +// // The exported file is truncated if the number of cells exceeds the limit. A warning message with code 1000 is sent. // There is an option to export only the possible values ( qExportState is P). // @@ -12042,7 +12082,7 @@ func (obj *GenericObject) GetHyperCubePivotDataRaw(ctx context.Context, path str // Scatter plot chart data reduction: // // The reduction mode must be set to C. -// This reduction mechanism follows the 2D K-Means algorithm. Data are reduced into a number of clusters. Each data is assigned to a specific centroid. +// This reduction mechanism follows the 2D K-Means algorithm. Data are reduced into a number of clusters. Each data is assigned to a specific centroid. // The number of centroids can be defined in the parameter qZoomFactor. // // Scatter plot chart resolution reduction: @@ -12114,7 +12154,7 @@ func (obj *GenericObject) GetHyperCubeReducedData(ctx context.Context, path stri // Scatter plot chart data reduction: // // The reduction mode must be set to C. -// This reduction mechanism follows the 2D K-Means algorithm. Data are reduced into a number of clusters. Each data is assigned to a specific centroid. +// This reduction mechanism follows the 2D K-Means algorithm. Data are reduced into a number of clusters. Each data is assigned to a specific centroid. // The number of centroids can be defined in the parameter qZoomFactor. // // Scatter plot chart resolution reduction: @@ -12274,7 +12314,7 @@ func (obj *GenericObject) GetInfoRaw(ctx context.Context) (json.RawMessage, erro // // A GetLayout call on A returns information on the objects A, B and C. // A GetLayout call on B returns information on the objects B, D and E. -// A GetLayout call on C returns information on the object C. +// A  GetLayout call on C returns information on the object C. // // In addition to the parameters displayed above, the GetLayout method can return other properties according to what is defined in the generic object. // For example, if qHyperCubeDef is defined in the generic object, the GetLayout method returns the properties described in HyperCube. @@ -12298,7 +12338,7 @@ func (obj *GenericObject) GetLayout(ctx context.Context) (*GenericObjectLayout, // // A GetLayout call on A returns information on the objects A, B and C. // A GetLayout call on B returns information on the objects B, D and E. -// A GetLayout call on C returns information on the object C. +// A  GetLayout call on C returns information on the object C. // // In addition to the parameters displayed above, the GetLayout method can return other properties according to what is defined in the generic object. // For example, if qHyperCubeDef is defined in the generic object, the GetLayout method returns the properties described in HyperCube. @@ -12674,7 +12714,7 @@ func (obj *GenericObject) SearchListObjectFor(ctx context.Context, path string, // ◾ path - Path to the definition of the object to be selected. // For example, /qHyperCubeDef . // -// ◾ rowIndices - Array of row indexes to select, starting from 0. +// ◾ rowIndices - Array of row indexes to select, starting from 0. // If the array is empty [ ] , all rows are selected. // // ◾ colIndices - Indexes of the columns to select, starting from 0. @@ -12981,7 +13021,7 @@ func (obj *GenericObject) SelectListObjectValues(ctx context.Context, path strin return result.Success, err } -// This method only applies to hypercubes that are not represented as straight tables. The parameter qMode in HyperCubeDef must be set either to P or K . +// This method only applies to hypercubes that are not represented as straight tables. The parameter qMode in HyperCubeDef must be set either to P  or K . // // Pivot table: // @@ -13042,7 +13082,7 @@ func (obj *GenericObject) SelectPivotCells(ctx context.Context, path string, sel return result.Success, err } -// This method only applies to hypercubes that are not represented as straight tables. The parameter qMode in HyperCubeDef must be set either to P or K . +// This method only applies to hypercubes that are not represented as straight tables. The parameter qMode in HyperCubeDef must be set either to P  or K . // // Pivot table: // @@ -13438,9 +13478,14 @@ func (obj *Global) AllowCreateApp(ctx context.Context) (bool, error) { } // Cancels an ongoing reload. The reload of the app is stopped. The indexation can be canceled and true is still the return value of the reload task. +// +// Parameters: +// +// ◾ reason - Reason for why the reload was cancelled. This will be echoed back to the user in the script log. +// // Stability: locked -func (obj *Global) CancelReload(ctx context.Context) error { - err := obj.RPC(ctx, "CancelReload", nil) +func (obj *Global) CancelReload(ctx context.Context, reason string) error { + err := obj.RPC(ctx, "CancelReload", nil, reason) return err } @@ -13492,7 +13537,7 @@ func (obj *Global) ConfigureReload(ctx context.Context, cancelOnScriptError bool // If the list of the QRS identifiers is empty, the CopyApp method copies all objects to the target app. // Script-defined variables are automatically copied when copying an app. To be able to copy variables not created via script, the GUID of each variable must be provided in the list of QRS identifiers. // To get the QRS identifiers of the objects in an app, you can use the QRS API. The GET method (from the QRS API) returns the identifiers of the objects in the app. -// The following example returns the QRS identifiers of all the objects in a specified app: +// The following example returns the QRS identifiers of all the objects in a specified app: // GET /qrs/app/9c3f8634-6191-4a34-a114-a39102058d13 // Where // _9c3f8634-6191-4a34-a114-a39102058d13_ is the identifier of the app. diff --git a/schema/engine-rpc.json b/schema/engine-rpc.json index 03da98ff..143309a4 100644 --- a/schema/engine-rpc.json +++ b/schema/engine-rpc.json @@ -2,7 +2,7 @@ "openrpc": "1.0.0", "info": { "title": "QIX", - "version": "12.1678.0", + "version": "12.1777.0", "description": "The JSON-RPC API over websocket that enables you to interact with the Qlik Associative Engine." }, "methods": [ @@ -757,7 +757,7 @@ }, { "name": "GenericObject.GetLayout", - "description": "Evaluates an object and displays its properties including the dynamic properties.\nIf the member _delta_ is set to true in the request object, only the delta is evaluated. A _GetLayout_ call on a generic object, returns up to one level down in the hierarchy.\n\n### Example:\n_A_ is a generic object and is the parent of the objects B and C. _B_ is the parent of the objects D and E.\n
![](images/dr_gen_QVCPMethodGetLayoutHierarchy.png)
\nA _GetLayout_ call on A returns information on the objects A, B and C.\nA _GetLayout_ call on B returns information on the objects B, D and E.\nA _GetLayout_ call on C returns information on the object C.\n\n
\nIn addition to the parameters displayed above, the **GetLayout** method can return other properties according to what is defined in the generic object.\nFor example, if **qHyperCubeDef** is defined in the generic object, the **GetLayout** method returns the properties described in _HyperCube_.\n
", + "description": "Evaluates an object and displays its properties including the dynamic properties.\nIf the member _delta_ is set to true in the request object, only the delta is evaluated. A _GetLayout_ call on a generic object, returns up to one level down in the hierarchy.\n\n### Example:\n_A_ is a generic object and is the parent of the objects B and C. _B_ is the parent of the objects D and E.\n
![](images/dr_gen_QVCPMethodGetLayoutHierarchy.png)
\nA _GetLayout_ call on A returns information on the objects A, B and C.\nA _GetLayout_ call on B returns information on the objects B, D and E.\nA  _GetLayout_ call on C returns information on the object C.\n\n
\nIn addition to the parameters displayed above, the **GetLayout** method can return other properties according to what is defined in the generic object.\nFor example, if **qHyperCubeDef** is defined in the generic object, the **GetLayout** method returns the properties described in _HyperCube_.\n
", "params": [], "result": { "name": "Results for GenericObject.GetLayout", @@ -885,7 +885,7 @@ }, { "name": "GenericObject.GetHyperCubeReducedData", - "description": "Reduces the data of a bar chart, a line chart or a scatter plot chart and retrieves them.\nThe reduction is dependent on the zoom factor (parameter _qZoomFactor_ ) and on the reduction mode.\n
This method can be used to create mini charts.
\n\n### Bar chart or line chart data reduction\nFor the data reduction to happen, the following conditions must be fulfilled:\n* The values cannot fit in the defined page (parameter _qPages_ ).\n* The zoom factor is not 0 (parameter _qZoomFactor_ ).\n* The reduction mode must be set to D1.\n\nThe reduction algorithm keeps the shape of the visualizations and works whatever the number of dimensions in the chart. The global profile of the chart is reduced, and not only a specific dimension. A visualization that has been reduced contains fewer values but its shape is the same. Data of all types can be reduced. Therefore it is hard to relate the values before and after a reduction especially when reducing string values.\n\n### Example\nIf you have a chart with 1 million data, and you have set the zoom factor to 5, the _GetHyperCubeReducedData_ method reduces the chart and retrieves 200 000 data.\n\n### Scatter plot chart data reduction\nThe reduction mode must be set to C.\nThis reduction mechanism follows the 2D K-Means algorithm. Data are reduced into a number of clusters. Each data is assigned to a specific centroid.\nThe number of centroids can be defined in the parameter _qZoomFactor_.\n\n### Scatter plot chart resolution reduction\nThe reduction mode must be set to S.\nThe resolution is reduced according to the zoom factor (parameter _qZoomFactor_ ).\n\n### Example\nIf you have a scatter plot chart and the zoom factor is set to 2, the scatter plot chart resolution is reduced by 4.", + "description": "Reduces the data of a bar chart, a line chart or a scatter plot chart and retrieves them.\nThe reduction is dependent on the zoom factor (parameter _qZoomFactor_ ) and on the reduction mode.\n
This method can be used to create mini charts.
\n\n### Bar chart or line chart data reduction\nFor the data reduction to happen, the following conditions must be fulfilled:\n* The values cannot fit in the defined page (parameter _qPages_ ).\n* The zoom factor is not 0 (parameter _qZoomFactor_ ).\n* The reduction mode must be set to D1.\n\nThe reduction algorithm keeps the shape of the visualizations and works whatever the number of dimensions in the chart. The global profile of the chart is reduced, and not only a specific dimension. A visualization that has been reduced contains fewer values but its shape is the same. Data of all types can be reduced. Therefore it is hard to relate the values before and after a reduction especially when reducing string values.\n\n### Example\nIf you have a chart with 1 million data, and you have set the zoom factor to 5, the _GetHyperCubeReducedData_ method reduces the chart and retrieves 200 000 data.\n\n### Scatter plot chart data reduction\nThe reduction mode must be set to C.\nThis reduction mechanism follows the 2D K-Means algorithm. Data are reduced into a number of clusters. Each data is assigned to a specific centroid.\nThe number of centroids can be defined in the parameter _qZoomFactor_.\n\n### Scatter plot chart resolution reduction\nThe reduction mode must be set to S.\nThe resolution is reduced according to the zoom factor (parameter _qZoomFactor_ ).\n\n### Example\nIf you have a scatter plot chart and the zoom factor is set to 2, the scatter plot chart resolution is reduced by 4.", "params": [ { "name": "qPath", @@ -1516,7 +1516,7 @@ }, { "name": "GenericObject.ExportData", - "description": "Exports the data of any generic object to an Excel file or a open XML file. If the object contains excluded values, those excluded values are not exported.\nThis API has limited functionality and will not support CSV export from all types of objects. Consider using Excel export instead. Treemap and bar chart are not supported.\n
ExportData method is not supported in SaaS Editions of Qlik Sense.
\n\n### Default limitations in number of rows and columns\nThe default maximum number of rows and columns in the Excel export file is:\n* 1048566 rows per sheet. For pivot tables: 1048566 column dimensions. 10 rows can be added after the export.\n* 16384 columns per sheet. If the number of columns exceeds the limit, the exported file is truncated and a warning message is sent.\n\n### Default limitation in number of columns\nThe default maximum number of columns in the export file is:\n* 1000 to export to a CSV file\n\nThe exported file is truncated if the number of cells exceeds the limit. A warning message with code 1000 is sent.\n
There is an option to export only the possible values ( _qExportState_ is P).
\n\n### Default limitation in size\nIf the exported file is larger than the maximum value, then an out-of-memory error with code 13000 is returned.\n\n
Exported files are temporary and are available only for a certain time span and only to the user who created them.
", + "description": "Exports the data of any generic object to an Excel file or a open XML file. If the object contains excluded values, those excluded values are not exported.\nThis API has limited functionality and will not support CSV export from all types of objects. Consider using Excel export instead. Treemap and bar chart are not supported.\n
ExportData method is not supported in SaaS Editions of Qlik Sense.
\n\n### Default limitations in number of rows and columns\nThe default maximum number of rows and columns in the Excel export file is:\n* 1048566 rows per sheet. For pivot tables: 1048566 column dimensions. 10 rows can be added after the export.\n* 16384 columns per sheet. If the number of columns exceeds the limit, the exported file is truncated and a warning message is sent.\n\n### Default limitation in number of columns\nThe default maximum number of columns in the export file is:\n* 1000 to export to a CSV file\n\n### Default limitations in number of cells\nThe default maximum number of cells in the export file is:\n* 5000000 to export to a CSV file\n\nThe exported file is truncated if the number of cells exceeds the limit. A warning message with code 1000 is sent.\n
There is an option to export only the possible values ( _qExportState_ is P).
\n\n### Default limitation in size\nIf the exported file is larger than the maximum value, then an out-of-memory error with code 13000 is returned.\n\n
Exported files are temporary and are available only for a certain time span and only to the user who created them.
", "params": [ { "name": "qFileType", @@ -2388,7 +2388,7 @@ }, { "name": "qRowIndices", - "description": "Array of row indexes to select, starting from 0.\nIf the array is empty _[ ]_ , all rows are selected.", + "description": "Array of row indexes to select, starting from 0.\nIf the array is empty _[ ]_ , all rows are selected.", "required": true, "schema": { "type": "array", @@ -2448,7 +2448,7 @@ }, { "name": "GenericObject.SelectPivotCells", - "description": "
This method only applies to hypercubes that are not represented as straight tables. The parameter _qMode_ in _HyperCubeDef_ must be set either to _P_ or _K_ .
\n\n### Pivot table\nMakes selections in the top or left dimension cells of a pivot table or in the data matrix. Only expanded dimensions can be selected.\n\n### Stacked table\nMakes selections in the left dimension cells of a stacked table or in the data matrix.\n
There is no top dimensions in a stacked table. A stacked table can only contain one measure.
\n\n### Example of a pivot table\n![](images/ui_gen_ExampleQVCPPivotTableDescription.png)
\nIn the representation above:\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Sum(OrderTotal)
Count(OrderTotal)		Are pseudo dimensions.
CategoryNameIs a left dimension.
Beverages , Condiments ... are left dimension values.
ProductNameIs a top dimension.
Chef Anton's Cajun Seasoning is a top dimension value.
Numeric valuesAre calculated values in the data matrix.
626291,832 is a calculated value.
\n\nThe member **Change** returns the handles of the objects that are updated following the selections.\n_qSuccess_ is set to _true_ if the selections are successful and is set to _false_ in the following cases:\n* The object contains some invalid fields (fields that are not in the data model).\n* The selection applies to a locked field.\n* A range selection is performed and the parameter _OneAndOnlyOne_ is set to true in the definition of the object.", + "description": "
This method only applies to hypercubes that are not represented as straight tables. The parameter _qMode_ in _HyperCubeDef_ must be set either to _P_  or _K_ .
\n\n### Pivot table\nMakes selections in the top or left dimension cells of a pivot table or in the data matrix. Only expanded dimensions can be selected.\n\n### Stacked table\nMakes selections in the left dimension cells of a stacked table or in the data matrix.\n
There is no top dimensions in a stacked table. A stacked table can only contain one measure.
\n\n### Example of a pivot table\n![](images/ui_gen_ExampleQVCPPivotTableDescription.png)
\nIn the representation above:\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Sum(OrderTotal)
Count(OrderTotal)		Are pseudo dimensions.
CategoryNameIs a left dimension.
Beverages , Condiments ... are left dimension values.
ProductNameIs a top dimension.
Chef Anton's Cajun Seasoning is a top dimension value.
Numeric valuesAre calculated values in the data matrix.
626291,832 is a calculated value.
\n\nThe member **Change** returns the handles of the objects that are updated following the selections.\n_qSuccess_ is set to _true_ if the selections are successful and is set to _false_ in the following cases:\n* The object contains some invalid fields (fields that are not in the data model).\n* The selection applies to a locked field.\n* A range selection is performed and the parameter _OneAndOnlyOne_ is set to true in the definition of the object.", "params": [ { "name": "qPath", @@ -7710,7 +7710,7 @@ }, { "name": "Doc.GetDatabaseInfo", - "description": "Gives information about an ODBC, OLEDB or CUSTOM connection. See _Outputs_ for more details.", + "description": "Gives information about an ODBC, OLEDB or CUSTOM connection. See _Outputs_ for more details.", "params": [ { "name": "qConnectionId", @@ -7826,7 +7826,7 @@ }, { "name": "Doc.GetDatabaseTables", - "description": "Lists the tables inside a database for a ODBC, OLEDB or CUSTOM connection.", + "description": "Lists the tables inside a database for a ODBC, OLEDB or CUSTOM connection.", "params": [ { "name": "qConnectionId", @@ -7877,7 +7877,7 @@ }, { "name": "Doc.GetDatabaseTableFields", - "description": "Lists the fields inside a table of a database for a ODBC, OLEDB or CUSTOM connection.", + "description": "Lists the fields inside a table of a database for a ODBC, OLEDB or CUSTOM connection.", "params": [ { "name": "qConnectionId", @@ -7936,7 +7936,7 @@ }, { "name": "Doc.GetDatabaseTablePreview", - "description": "Retrieves the values of the specified table of a database for a ODBC, OLEDB or CUSTOM connection.", + "description": "Retrieves the values of the specified table of a database for a ODBC, OLEDB or CUSTOM connection.", "params": [ { "name": "qConnectionId", @@ -8049,7 +8049,7 @@ }, { "name": "Doc.GuessFileType", - "description": "Guesses the data format for a given file.\nRecognized file formats are:\n* _CSV_ for Delimited\n* _FIX_ for Fixed Record\n* _DIF_ for Data Interchange Format\n* _EXCEL_BIFF_ for Microsoft Excel (XLS)\n* _EXCEL_OOXML_ for Microsoft Excel (XLSX)\n* _HTML_ for HTML\n* _QVD_ for QVD file\n* _XML_ for XML\n* _QVX_ for QVX file\n* _JSON_ for JSON format\n* _KML_ for KML file\n* _PARQUET_ for PARQUET file\n\n### FileType\nRecognized file formats are:\n* _CSV_ for Delimited\n* _FIX_ for Fixed Record\n* _DIF_ for Data Interchange Format\n* _EXCEL_BIFF_ for Microsoft Excel (XLS)\n* _EXCEL_OOXML_ for Microsoft Excel (XLSX)\n* _HTML_ for HTML\n* _QVD_ for QVD file\n* _XML_ for XML\n* _QVX_ for QVX file\n* _JSON_ for JSON format\n* _KML_ for KML file\n* _PARQUET_ for PARQUET file", + "description": "Guesses the data format for a given file.\nRecognized file formats are:\n* _CSV_ for Delimited\n* _FIX_ for Fixed Record\n* _DIF_ for Data Interchange Format\n* _EXCEL_BIFF_ for Microsoft Excel (XLS)\n* _EXCEL_OOXML_ for Microsoft Excel (XLSX)\n* _HTML_ for HTML\n* _QVD_ for QVD file\n* _XML_ for XML\n* _QVX_ for QVX file\n* _JSON_ for JSON format\n* _KML_ for KML file\n* _PARQUET_ for PARQUET file\n\n### FileType\nRecognized file formats are:\n* _CSV_ for Delimited\n* _FIX_ for Fixed Record\n* _DIF_ for Data Interchange Format\n* _EXCEL_BIFF_ for Microsoft Excel (XLS)\n* _EXCEL_OOXML_ for Microsoft Excel (XLSX)\n* _HTML_ for HTML\n* _QVD_ for QVD file\n* _XML_ for XML\n* _QVX_ for QVX file\n* _JSON_ for JSON format\n* _KML_ for KML file\n* _PARQUET_ for PARQUET file", "params": [ { "name": "qConnectionId", @@ -8091,7 +8091,7 @@ }, { "name": "Doc.GetFileTables", - "description": "Lists the tables for a folder connection.\n\n### FileType\nRecognized file formats are:\n* _CSV_ for Delimited\n* _FIX_ for Fixed Record\n* _DIF_ for Data Interchange Format\n* _EXCEL_BIFF_ for Microsoft Excel (XLS)\n* _EXCEL_OOXML_ for Microsoft Excel (XLSX)\n* _HTML_ for HTML\n* _QVD_ for QVD file\n* _XML_ for XML\n* _QVX_ for QVX file\n* _JSON_ for JSON format\n* _KML_ for KML file\n* _PARQUET_ for PARQUET file", + "description": "Lists the tables for a folder connection.\n\n### FileType\nRecognized file formats are:\n* _CSV_ for Delimited\n* _FIX_ for Fixed Record\n* _DIF_ for Data Interchange Format\n* _EXCEL_BIFF_ for Microsoft Excel (XLS)\n* _EXCEL_OOXML_ for Microsoft Excel (XLSX)\n* _HTML_ for HTML\n* _QVD_ for QVD file\n* _XML_ for XML\n* _QVX_ for QVX file\n* _JSON_ for JSON format\n* _KML_ for KML file\n* _PARQUET_ for PARQUET file", "params": [ { "name": "qConnectionId", @@ -8144,7 +8144,7 @@ }, { "name": "Doc.GetFileTableFields", - "description": "Lists the fields of a table for a folder connection.\n\n### FileType\nRecognized file formats are:\n* _CSV_ for Delimited\n* _FIX_ for Fixed Record\n* _DIF_ for Data Interchange Format\n* _EXCEL_BIFF_ for Microsoft Excel (XLS)\n* _EXCEL_OOXML_ for Microsoft Excel (XLSX)\n* _HTML_ for HTML\n* _QVD_ for QVD file\n* _XML_ for XML\n* _QVX_ for QVX file\n* _JSON_ for JSON format\n* _KML_ for KML file\n* _PARQUET_ for PARQUET file", + "description": "Lists the fields of a table for a folder connection.\n\n### FileType\nRecognized file formats are:\n* _CSV_ for Delimited\n* _FIX_ for Fixed Record\n* _DIF_ for Data Interchange Format\n* _EXCEL_BIFF_ for Microsoft Excel (XLS)\n* _EXCEL_OOXML_ for Microsoft Excel (XLSX)\n* _HTML_ for HTML\n* _QVD_ for QVD file\n* _XML_ for XML\n* _QVX_ for QVX file\n* _JSON_ for JSON format\n* _KML_ for KML file\n* _PARQUET_ for PARQUET file", "params": [ { "name": "qConnectionId", @@ -8172,7 +8172,7 @@ }, { "name": "qTable", - "description": "Name of the table.\nThis parameter must be set for _XLS_ , _XLSX_ , _HTML _ and _XML_ files.", + "description": "Name of the table.\nThis parameter must be set for _XLS_ , _XLSX_ , _HTML  _ and _XML_ files.", "required": true, "schema": { "type": "string" @@ -8208,7 +8208,7 @@ }, { "name": "Doc.GetFileTablePreview", - "description": "Lists the values in a table for a folder connection.\n\n### FileType\nRecognized file formats are:\n* _CSV_ for Delimited\n* _FIX_ for Fixed Record\n* _DIF_ for Data Interchange Format\n* _EXCEL_BIFF_ for Microsoft Excel (XLS)\n* _EXCEL_OOXML_ for Microsoft Excel (XLSX)\n* _HTML_ for HTML\n* _QVD_ for QVD file\n* _XML_ for XML\n* _QVX_ for QVX file\n* _JSON_ for JSON format\n* _KML_ for KML file\n* _PARQUET_ for PARQUET file", + "description": "Lists the values in a table for a folder connection.\n\n### FileType\nRecognized file formats are:\n* _CSV_ for Delimited\n* _FIX_ for Fixed Record\n* _DIF_ for Data Interchange Format\n* _EXCEL_BIFF_ for Microsoft Excel (XLS)\n* _EXCEL_OOXML_ for Microsoft Excel (XLSX)\n* _HTML_ for HTML\n* _QVD_ for QVD file\n* _XML_ for XML\n* _QVX_ for QVX file\n* _JSON_ for JSON format\n* _KML_ for KML file\n* _PARQUET_ for PARQUET file", "params": [ { "name": "qConnectionId", @@ -8236,7 +8236,7 @@ }, { "name": "qTable", - "description": "Name of the table.\nThis parameter must be set for _XLS_ , _XLSX_ , _HTML _ and _XML_ files.", + "description": "Name of the table.\nThis parameter must be set for _XLS_ , _XLSX_ , _HTML  _ and _XML_ files.", "required": true, "schema": { "type": "string" @@ -9414,7 +9414,7 @@ "$ref": "#/components/errors/GenericErrors" } ], - "x-qlik-stability": "experimental" + "x-qlik-stability": "locked" }, { "name": "Doc.ApplyTemporaryBookmark", @@ -9445,7 +9445,7 @@ "$ref": "#/components/errors/GenericErrors" } ], - "x-qlik-stability": "experimental" + "x-qlik-stability": "locked" }, { "name": "Doc.GetScriptMeta", @@ -9529,6 +9529,23 @@ "update" ] }, + { + "name": "Doc.ClearAllSoftPatches", + "description": "Clear the soft properties of all generic objects in the app", + "params": [], + "result": { + "name": "Results for Doc.ClearAllSoftPatches", + "schema": { + "type": "object" + } + }, + "errors": [ + { + "$ref": "#/components/errors/GenericErrors" + } + ], + "x-qlik-stability": "experimental" + }, { "name": "Doc.CommitScript", "description": "Commits the current script version so that any future changes will be part of a new version.", @@ -10247,7 +10264,7 @@ }, { "name": "qIds", - "description": "Array of QRS identifiers.\nThe list of all objects in the app to be copied must be given. This list must contain the GUIDs of all these objects.\nIf the list of the QRS identifiers is empty, the _CopyApp_ method copies all objects to the target app.\nScript-defined variables are automatically copied when copying an app. To be able to copy variables not created via script, the GUID of each variable must be provided in the list of QRS identifiers.\nTo get the QRS identifiers of the objects in an app, you can use the QRS API. The GET method (from the QRS API) returns the identifiers of the objects in the app.\nThe following example returns the QRS identifiers of all the objects in a specified app:\nGET /qrs/app/9c3f8634-6191-4a34-a114-a39102058d13\nWhere\n_9c3f8634-6191-4a34-a114-a39102058d13_ is the identifier of the app.", + "description": "Array of QRS identifiers.\nThe list of all objects in the app to be copied must be given. This list must contain the GUIDs of all these objects.\nIf the list of the QRS identifiers is empty, the _CopyApp_ method copies all objects to the target app.\nScript-defined variables are automatically copied when copying an app. To be able to copy variables not created via script, the GUID of each variable must be provided in the list of QRS identifiers.\nTo get the QRS identifiers of the objects in an app, you can use the QRS API. The GET method (from the QRS API) returns the identifiers of the objects in the app.\nThe following example returns the QRS identifiers of all the objects in a specified app:\nGET /qrs/app/9c3f8634-6191-4a34-a114-a39102058d13\nWhere\n_9c3f8634-6191-4a34-a114-a39102058d13_ is the identifier of the app.", "required": true, "schema": { "type": "array", @@ -10684,7 +10701,15 @@ { "name": "Global.CancelReload", "description": "Cancels an ongoing reload. The reload of the app is stopped. The indexation can be canceled and _true_ is still the return value of the reload task.", - "params": [], + "params": [ + { + "name": "qReason", + "description": "Reason for why the reload was cancelled. This will be echoed back to the user in the script log.", + "schema": { + "type": "string" + } + } + ], "result": { "name": "Results for Global.CancelReload", "schema": { @@ -10875,7 +10900,7 @@ } ], "x-qlik-see-also": [ - "[List the databases of a ODBC, OLEDB or CUSTOM connection](#csh-list-databases-Odbc-Oledb-custom-connection)" + "[List the databases of a ODBC, OLEDB or CUSTOM connection](#csh-list-databases-Odbc-Oledb-custom-connection)" ], "x-qlik-stability": "locked", "x-qlik-access-control": [ @@ -16205,7 +16230,7 @@ }, "qTags": { "type": "array", - "description": "Name connected to the measure that is used for search purposes.\nA measure can have several tags.\nThis parameter is optional.", + "description": "Name connected to the measure that is used for search purposes.\nA measure can have several tags.\nThis parameter is optional.", "items": { "type": "string" } @@ -17567,7 +17592,7 @@ }, "qFieldSelectionMode": { "type": "string", - "description": "Selection mode.\n### Properties\nOne of:\n* NORMAL for a selection in normal mode.\n* AND for a selection in AND mode.\n* NOT for a selection NOT in AND mode.\nOne of:\n* NORMAL or SELECTION_MODE_NORMAL\n* AND or SELECTION_MODE_AND\n* NOT or SELECTION_MODE_NOT", + "description": "Selection mode.\n### Properties\nOne of:\n* NORMAL for a selection in normal mode.\n* AND for a selection in AND mode.\n* NOT for a selection NOT in AND mode.\nOne of:\n* NORMAL or SELECTION_MODE_NORMAL\n* AND or SELECTION_MODE_AND\n* NOT or SELECTION_MODE_NOT", "$ref": "#/components/schemas/NxFieldSelectionMode" } } @@ -18583,7 +18608,7 @@ }, "qFirstWeekDay": { "type": "integer", - "description": "First day of the week, starting from 0.\nAccording to ISO 8601, _Monday_ is the first day of the week.\n* 0 = Monday\n* 1 = Tuesday\n* ...\n* 6 = Sunday\n\nIf this property has not been set in a script, the returned value comes from the Windows operating system.", + "description": "First day of the week, starting from 0.\nAccording to ISO 8601, _Monday_ is the first day of the week.\n* 0 = Monday\n* 1 = Tuesday\n* ...\n* 6 = Sunday\n\nIf this property has not been set in a script, the returned value comes from the Windows operating system.", "format": "int32" }, "qBrokenWeeks": { @@ -18602,7 +18627,7 @@ }, "qCollation": { "type": "string", - "description": "Locale name (following language tagging convention RFC 4646):\n_< language>-<REGION>_\nWhere:\n* _language_ is a lowercase ISO 639 language code\n* _REGION_ specifies an uppercase ISO 3166 country code.\n\nIf this property has not been set in a script, the returned value comes from the Windows operating system." + "description": "Locale name (following language tagging convention RFC 4646):\n_< language>-<REGION>_\nWhere:\n* _language_ is a lowercase ISO  639 language code\n* _REGION_ specifies an uppercase ISO 3166 country code.\n\nIf this property has not been set in a script, the returned value comes from the Windows operating system." }, "qNumericalAbbreviation": { "type": "string", @@ -19324,6 +19349,10 @@ "type": "boolean", "description": "If set to true, the app is a Session App, i.e. not persistent." }, + "qProhibitBinaryLoad": { + "type": "boolean", + "description": "If set to true, the persisted app cannot be used in a Binary load statement in Qlik load script." + }, "qThumbnail": { "type": "object", "description": "App thumbnail.", @@ -19343,6 +19372,11 @@ "items": { "$ref": "#/components/schemas/NxFeature" } + }, + "qUsage": { + "type": "string", + "description": "\nOne of:\n* ANALYTICS or ANALYTICS_USAGE\n* DATA_PREPARATION or DATA_PREPARATION_USAGE", + "$ref": "#/components/schemas/UsageEnum" } } }, @@ -19451,6 +19485,21 @@ } ] }, + "UsageEnum": { + "type": "string", + "oneOf": [ + { + "x-qlik-const": 0, + "title": "ANALYTICS", + "description": "ANALYTICS_USAGE" + }, + { + "x-qlik-const": 1, + "title": "DATA_PREPARATION", + "description": "DATA_PREPARATION_USAGE" + } + ] + }, "NxAppProperties": { "type": "object", "description": "### Qlik Sense Desktop\nIn Qlik Sense Desktop, this structure can contain dynamic properties.\n\n### Qlik Sense Enterprise\nIn Qlik Sense Enterprise, only a few dynamic properties at the app level are persisted.\nThe persisted dynamic properties are the following:\n* modifiedDate\n* published\n* publishTime\n* privileges\n* description\n* dynamicColor", @@ -19479,6 +19528,11 @@ "qHasSectionAccess": { "type": "boolean", "description": "If true the app has section access configured." + }, + "qUsage": { + "type": "string", + "description": "Indicates whether the app is used for Analytics or DataPreparation\n\nOne of:\n* ANALYTICS or ANALYTICS_USAGE\n* DATA_PREPARATION or DATA_PREPARATION_USAGE", + "$ref": "#/components/schemas/UsageEnum" } } }, @@ -19487,7 +19541,7 @@ "properties": { "qDiscriminator": { "type": "string", - "description": "A string indicating the origin of the data:\n* [filename]: the data comes from a local file.\n* INLINE: the data is entered inline in the load script.\n* RESIDENT: the data comes from a resident table. The table name is listed.\n* AUTOGENERATE: the data is generated from the load script (no external table of data source).\n* Provider: the data comes from a data connection. The connector source name is listed.\n* [webfile]: the data comes from a web-based file.\n* STORE: path to QVD or TXT file where data is stored.\n* EXTENSION: the data comes from a Server Side Extension (SSE)." + "description": "A string indicating the origin of the data:\n* [filename]: the data comes from a local file.\n* INLINE: the data is entered inline in the load script.\n* RESIDENT: the data comes from a resident table. The table name is listed.\n* AUTOGENERATE: the data is generated from the load script (no external table of data source).\n* Provider: the data comes from a data connection. The connector source name is listed.\n* [webfile]: the data comes from a web-based file.\n* STORE: path to QVD or TXT file where data is stored.\n* EXTENSION: the data comes from a Server Side Extension (SSE)." }, "qStatement": { "type": "string", @@ -19730,6 +19784,17 @@ "qReloadId": { "type": "string", "description": "Optional reload ID.\nID will be automatically generated if not set." + }, + "qSkipStore": { + "type": "boolean", + "description": "Set to true to skip Store statements.\nThe default value is false.", + "default": false + }, + "qRowLimit": { + "type": "integer", + "description": "If greater than or equal 0, defines max number of rows loaded from a data source.", + "format": "int64", + "default": -1 } } }, @@ -19819,7 +19884,7 @@ }, "qConnectionString": { "type": "string", - "description": "One of:\n* ODBC CONNECT TO [<provider name>]\n* OLEDB CONNECT TO [<provider name>]\n* CUSTOM CONNECT TO [<provider name>]\n* \"<local absolute or relative path, UNC path>\"\n* \"<URL>\"\n\nConnection string.\nThis parameter is mandatory and must be set when creating or modifying a connection." + "description": "One of:\n* ODBC CONNECT TO [<provider name>]\n* OLEDB CONNECT TO [<provider name>]\n* CUSTOM CONNECT TO [<provider name>]\n* \"<local absolute or relative path, UNC path>\"\n* \"<URL>\"\n\nConnection string.\nThis parameter is mandatory and must be set when creating or modifying a connection." }, "qType": { "type": "string", @@ -20043,7 +20108,7 @@ }, "FileDataFormat": { "type": "object", - "description": "### FileType\nRecognized file formats are:\n* _CSV_ for Delimited\n* _FIX_ for Fixed Record\n* _DIF_ for Data Interchange Format\n* _EXCEL_BIFF_ for Microsoft Excel (XLS)\n* _EXCEL_OOXML_ for Microsoft Excel (XLSX)\n* _HTML_ for HTML\n* _QVD_ for QVD file\n* _XML_ for XML\n* _QVX_ for QVX file\n* _JSON_ for JSON format\n* _KML_ for KML file\n* _PARQUET_ for PARQUET file", + "description": "### FileType\nRecognized file formats are:\n* _CSV_ for Delimited\n* _FIX_ for Fixed Record\n* _DIF_ for Data Interchange Format\n* _EXCEL_BIFF_ for Microsoft Excel (XLS)\n* _EXCEL_OOXML_ for Microsoft Excel (XLSX)\n* _HTML_ for HTML\n* _QVD_ for QVD file\n* _XML_ for XML\n* _QVX_ for QVX file\n* _JSON_ for JSON format\n* _KML_ for KML file\n* _PARQUET_ for PARQUET file", "properties": { "qType": { "type": "string", @@ -20939,7 +21004,7 @@ "properties": { "qBnf": { "type": "array", - "description": "Array of token references that all together build up the definition of the current token.\nGenerally, if the array is not empty, the definition is a BNF rule (_qIsBnfRule_ is set to true). However, some BNF rules do have an empty array (_qIsBnfRule_ is set to true, but _qBnf_ is empty).", + "description": "Array of token references that all together build up the definition of the current token.\nGenerally, if the array is not empty, the definition is a BNF rule (_qIsBnfRule_ is set to true). However, some BNF  rules do have an empty array (_qIsBnfRule_ is set to true, but _qBnf_ is empty).", "items": { "type": "integer", "format": "int32" @@ -21249,8 +21314,7 @@ "type": "boolean", "description": "IncludeAllPatches If true all patches will be stored in the temporary bookmark, if false ObjectIdsToPatch will determine what patches to include" } - }, - "x-qlik-stability": "experimental" + } }, "AppScriptMeta": { "type": "object", @@ -21446,6 +21510,11 @@ "qIsDirectQueryMode": { "type": "boolean", "description": "Is the app a Direct Query app?" + }, + "qUsage": { + "type": "string", + "description": "\nOne of:\n* ANALYTICS or ANALYTICS_USAGE\n* DATA_PREPARATION or DATA_PREPARATION_USAGE", + "$ref": "#/components/schemas/UsageEnum" } } }, @@ -21617,11 +21686,11 @@ "properties": { "qName": { "type": "string", - "description": "Name of the ODBC connection." + "description": "Name of the ODBC connection." }, "qDescription": { "type": "string", - "description": "Description of the ODBC connection." + "description": "Description of the ODBC connection." }, "qBit32": { "type": "boolean", @@ -23037,7 +23106,7 @@ }, "LOCERR_APP_DIRECT_QUERY_WORKLOAD_NOT_SUPPORTED": { "code": 1016, - "message": "Unknown error" + "message": "Direct Query mode not supported" }, "LOCERR_CONNECTION_ALREADY_EXISTS": { "code": 2000, @@ -24058,4 +24127,4 @@ "x-qlik-categories": [ "external/manage" ] -} +} \ No newline at end of file diff --git a/schema/generate.sh b/schema/generate.sh index 00c82e16..0937b7b6 100755 --- a/schema/generate.sh +++ b/schema/generate.sh @@ -1,6 +1,8 @@ #!/bin/bash ## compares engine spec with master + +wget -q https://qlik.dev/specs/openRPC/engine-rpc.json -O ./schema/engine-rpc.json git diff --exit-code origin/master -- ./schema/engine-rpc.json >/dev/null if [[ $? -ne 0 ]]; then ENGINE_VERSION=$(cat ./schema/engine-rpc.json | jq -r '.info.version')