IApp Interface

The Qlik Sense engine session connection.

Aborts any selection mode in an app. For more information about selection mode, see BeginSelections method.

Aborts any selection mode in an app. For more information about selection mode, see BeginSelections method.

Aborts any selection mode in an app. For more information about selection mode, see BeginSelections method.

Adds an alternate state in the app.

You can create multiple states within a Qlik Sense app and apply these states to specific objects within the app. Objects in a given state are not affected by user selections in the other states.

Adds an alternate state in the app.

You can create multiple states within a Qlik Sense app and apply these states to specific objects within the app. Objects in a given state are not affected by user selections in the other states.

Adds an alternate state in the app.

You can create multiple states within a Qlik Sense app and apply these states to specific objects within the app. Objects in a given state are not affected by user selections in the other states.

Adds a field on the fly.

Adds a field on the fly.

Adds a field on the fly.

Adds a field on the fly.

Adds an session alternate state in the app.

You can create multiple states within a Qlik Sense app and apply these states to specific objects within the app. Objects in a given state are not affected by user selections in the other states.

A session alternate state is not persisted and is not included in the StateNames array in the AppLayout.

You can use the optional second parameter to choose any other state to get the initial selection on the new state from

Adds an session alternate state in the app.

You can create multiple states within a Qlik Sense app and apply these states to specific objects within the app. Objects in a given state are not affected by user selections in the other states.

A session alternate state is not persisted and is not included in the StateNames array in the AppLayout.

You can use the optional second parameter to choose any other state to get the initial selection on the new state from

Adds an session alternate state in the app.

You can create multiple states within a Qlik Sense app and apply these states to specific objects within the app. Objects in a given state are not affected by user selections in the other states.

A session alternate state is not persisted and is not included in the StateNames array in the AppLayout.

You can use the optional second parameter to choose any other state to get the initial selection on the new state from

Applies a bookmark and verifies result dataset against originally selected values.

Applies a bookmark and verifies result dataset against originally selected values.

Applies a bookmark and verifies result dataset against originally selected values.

Applies a bookmark and verifies result dataset against originally selected values.

Applies a bookmark.

Applies a bookmark.

Applies a bookmark.

Applies a bookmark.

Apply temporary bookmark identified by Id.

Apply temporary bookmark identified by Id.

Apply temporary bookmark identified by Id.

Apply temporary bookmark identified by Id.

Loads the last logical operation (if any).

Loads the last logical operation (if any).

Loads the last logical operation (if any).

Returns the number of entries on the back stack.

Returns the number of entries on the back stack.

Returns the number of entries on the back stack.

Returns the number of entries on the back stack.

Change the owner of a session app.

Change the owner of a session app.

Change the owner of a session app.

Change the owner of a session app.

Add a session app to a space.

Add a session app to a space.

Add a session app to a space.

Add a session app to a space.

Checks if a given expression is valid.

Checks if a given expression is valid.

Checks if a given expression is valid.

Checks if a given expression is valid.

Checks if:

* A given expression is valid.

* A number is correct according to the locale.

Checks if:

* A given expression is valid.

* A number is correct according to the locale.

Checks if:

* A given expression is valid.

* A number is correct according to the locale.

Checks if:

* A given expression is valid.

* A number is correct according to the locale.

Checks the syntax of a script.

Example

"result": { "qErrors": [ { "qErrLen": 3, "qTabIx": 0, "qLineInTab": 0, "qColInLine": 0, "qTextPos": 0 }, { "qErrLen": 5, "qTabIx": 0, "qLineInTab": 0, "qColInLine": 1, "qTextPos": 4, "qSecondaryFailure": true } ] }

The list of syntax errors in the script.

If there are no errors, the engine returns:

If there are errors, the engine returns the following properties in the response:

Please refer to Engine API reference for table definition.

Checks the syntax of a script.

Example

"result": { "qErrors": [ { "qErrLen": 3, "qTabIx": 0, "qLineInTab": 0, "qColInLine": 0, "qTextPos": 0 }, { "qErrLen": 5, "qTabIx": 0, "qLineInTab": 0, "qColInLine": 1, "qTextPos": 4, "qSecondaryFailure": true } ] }

The list of syntax errors in the script.

If there are no errors, the engine returns:

If there are errors, the engine returns the following properties in the response:

Please refer to Engine API reference for table definition.

Checks the syntax of a script.

Example

"result": { "qErrors": [ { "qErrLen": 3, "qTabIx": 0, "qLineInTab": 0, "qColInLine": 0, "qTextPos": 0 }, { "qErrLen": 5, "qTabIx": 0, "qLineInTab": 0, "qColInLine": 1, "qTextPos": 4, "qSecondaryFailure": true } ] }

The list of syntax errors in the script.

If there are no errors, the engine returns:

If there are errors, the engine returns the following properties in the response:

Please refer to Engine API reference for table definition.

Checks the syntax of a script.

Example

"result": { "qErrors": [ { "qErrLen": 3, "qTabIx": 0, "qLineInTab": 0, "qColInLine": 0, "qTextPos": 0 }, { "qErrLen": 5, "qTabIx": 0, "qLineInTab": 0, "qColInLine": 1, "qTextPos": 4, "qSecondaryFailure": true } ] }

The list of syntax errors in the script.

If there are no errors, the engine returns:

If there are errors, the engine returns the following properties in the response:

Please refer to Engine API reference for table definition.

Clear selections in fields for current state. Locked fields are not cleared by default.

Clear selections in fields for current state. Locked fields are not cleared by default.

Clear selections in fields for current state. Locked fields are not cleared by default.

Clear the soft properties of all generic objects in the app

Clear the soft properties of all generic objects in the app

Clear the soft properties of all generic objects in the app

Clears entirely the undo and redo buffer.

Clears entirely the undo and redo buffer.

Clears entirely the undo and redo buffer.

Clones a bookmark.

Clones a bookmark.

Clones a bookmark.

Clones a bookmark.

Clones a dimension.

Clones a dimension.

Clones a dimension.

Clones a dimension.

Clones a measure.

Clones a measure.

Clones a measure.

Clones a measure.

Clones root level objects, such as sheets and stories. The CloneObject method works for both app objects and child objects.

When you clone an object that contains children, the children are cloned as well.

If you for example want to clone a visualization, you must provide the qID of the root object, in this case the sheet since CloneObject clones root level objects.

Clones root level objects, such as sheets and stories. The CloneObject method works for both app objects and child objects.

When you clone an object that contains children, the children are cloned as well.

If you for example want to clone a visualization, you must provide the qID of the root object, in this case the sheet since CloneObject clones root level objects.

Clones root level objects, such as sheets and stories. The CloneObject method works for both app objects and child objects.

When you clone an object that contains children, the children are cloned as well.

If you for example want to clone a visualization, you must provide the qID of the root object, in this case the sheet since CloneObject clones root level objects.

Clones root level objects, such as sheets and stories. The CloneObject method works for both app objects and child objects.

When you clone an object that contains children, the children are cloned as well.

If you for example want to clone a visualization, you must provide the qID of the root object, in this case the sheet since CloneObject clones root level objects.

Commits the draft of an object that was previously created by invoking the CreateDraft method.

Committing a draft replaces the corresponding published object.

Commits the draft of an object that was previously created by invoking the CreateDraft method.

Committing a draft replaces the corresponding published object.

Commits the draft of an object that was previously created by invoking the CreateDraft method.

Committing a draft replaces the corresponding published object.

Commits the current script version so that any future changes will be part of a new version.

Commits the current script version so that any future changes will be part of a new version.

Commits the current script version so that any future changes will be part of a new version.

Creates a bookmark with softpatches.

Creates a bookmark with softpatches.

Creates a bookmark with softpatches.

Creates a bookmark with softpatches.

Creates a connection.

A connection indicates from which data source the data should be taken.

Creates a connection.

A connection indicates from which data source the data should be taken.

Creates a connection.

A connection indicates from which data source the data should be taken.

Creates a connection.

A connection indicates from which data source the data should be taken.

Creates a draft of an object.

This method can be used to create a draft of a sheet or a story that is published. This is a way to continue working on a sheet or a story that is published.

Replace the published object by the content of the draft by invoking the CommitDraft method.

Creates a draft of an object.

This method can be used to create a draft of a sheet or a story that is published. This is a way to continue working on a sheet or a story that is published.

Replace the published object by the content of the draft by invoking the CommitDraft method.

Creates a draft of an object.

This method can be used to create a draft of a sheet or a story that is published. This is a way to continue working on a sheet or a story that is published.

Replace the published object by the content of the draft by invoking the CommitDraft method.

Creates a draft of an object.

This method can be used to create a draft of a sheet or a story that is published. This is a way to continue working on a sheet or a story that is published.

Replace the published object by the content of the draft by invoking the CommitDraft method.

Creates a bookmark.

Creates a bookmark.

Creates a bookmark.

Creates a bookmark.

Creates a master dimension.

A master dimension is stored in the library of an app and can be used in many objects. Several generic objects can contain the same dimension.

Creates a master dimension.

A master dimension is stored in the library of an app and can be used in many objects. Several generic objects can contain the same dimension.

Creates a master dimension.

A master dimension is stored in the library of an app and can be used in many objects. Several generic objects can contain the same dimension.

Creates a master dimension.

A master dimension is stored in the library of an app and can be used in many objects. Several generic objects can contain the same dimension.

Creates a master measure.

A master measure is stored in the library of an app and can be used in many objects. Several generic objects can contain the same measure.

Creates a master measure.

A master measure is stored in the library of an app and can be used in many objects. Several generic objects can contain the same measure.

Creates a master measure.

A master measure is stored in the library of an app and can be used in many objects. Several generic objects can contain the same measure.

Creates a master measure.

A master measure is stored in the library of an app and can be used in many objects. Several generic objects can contain the same measure.

Creates a generic object at app level. For more information on generic objects, see Generic object.

It is possible to create a generic object that is linked to another object.

A linked object is an object that points to a linking object. The linking object is defined in the properties of the linked object (in qExtendsId ).

The linked object has the same properties as the linking object.

Creates a generic object at app level. For more information on generic objects, see Generic object.

It is possible to create a generic object that is linked to another object.

A linked object is an object that points to a linking object. The linking object is defined in the properties of the linked object (in qExtendsId ).

The linked object has the same properties as the linking object.

Creates a generic object at app level. For more information on generic objects, see Generic object.

It is possible to create a generic object that is linked to another object.

A linked object is an object that points to a linking object. The linking object is defined in the properties of the linked object (in qExtendsId ).

The linked object has the same properties as the linking object.

Creates a generic object at app level. For more information on generic objects, see Generic object.

It is possible to create a generic object that is linked to another object.

A linked object is an object that points to a linking object. The linking object is defined in the properties of the linked object (in qExtendsId ).

The linked object has the same properties as the linking object.

Creates a transient object. For example, you can use a transient object to create an app overview or a story overview.

It is possible to create a transient object that is linked to another object.

A linked object is an object that points to a linking object. The linking object is defined in the properties of the linked object (in qExtendsId ).

The linked object has the same properties as the linking object.

Creates a transient object. For example, you can use a transient object to create an app overview or a story overview.

It is possible to create a transient object that is linked to another object.

A linked object is an object that points to a linking object. The linking object is defined in the properties of the linked object (in qExtendsId ).

The linked object has the same properties as the linking object.

Creates a transient object. For example, you can use a transient object to create an app overview or a story overview.

It is possible to create a transient object that is linked to another object.

A linked object is an object that points to a linking object. The linking object is defined in the properties of the linked object (in qExtendsId ).

The linked object has the same properties as the linking object.

Creates a transient object. For example, you can use a transient object to create an app overview or a story overview.

It is possible to create a transient object that is linked to another object.

A linked object is an object that points to a linking object. The linking object is defined in the properties of the linked object (in qExtendsId ).

The linked object has the same properties as the linking object.

Creates a transient variable.

Definition

A variable in Qlik Sense is a named entity, containing a data value. This value can be static or be the result of a calculation. A variable acquires its value at the same time that the variable is created or after when updating the properties of the variable. Variables can be used in bookmarks and can contain numeric or alphanumeric data. Any change made to the variable is applied everywhere the variable is used.

When a variable is used in an expression, it is substituted by its value or the variable's definition.

Example

The variable x contains the text string Sum(Sales) .

In a chart, you define the expression $(x)/12 . The effect is exactly the same as having the chart expression Sum(Sales)/12 .

However, if you change the value of the variable x to Sum(Budget) , the data in the chart are immediately recalculated with the expression interpreted as Sum(Budget)/12 .

Creates a transient variable.

Definition

A variable in Qlik Sense is a named entity, containing a data value. This value can be static or be the result of a calculation. A variable acquires its value at the same time that the variable is created or after when updating the properties of the variable. Variables can be used in bookmarks and can contain numeric or alphanumeric data. Any change made to the variable is applied everywhere the variable is used.

When a variable is used in an expression, it is substituted by its value or the variable's definition.

Example

The variable x contains the text string Sum(Sales) .

In a chart, you define the expression $(x)/12 . The effect is exactly the same as having the chart expression Sum(Sales)/12 .

However, if you change the value of the variable x to Sum(Budget) , the data in the chart are immediately recalculated with the expression interpreted as Sum(Budget)/12 .

Creates a transient variable.

Definition

A variable in Qlik Sense is a named entity, containing a data value. This value can be static or be the result of a calculation. A variable acquires its value at the same time that the variable is created or after when updating the properties of the variable. Variables can be used in bookmarks and can contain numeric or alphanumeric data. Any change made to the variable is applied everywhere the variable is used.

When a variable is used in an expression, it is substituted by its value or the variable's definition.

Example

The variable x contains the text string Sum(Sales) .

In a chart, you define the expression $(x)/12 . The effect is exactly the same as having the chart expression Sum(Sales)/12 .

However, if you change the value of the variable x to Sum(Budget) , the data in the chart are immediately recalculated with the expression interpreted as Sum(Budget)/12 .

Creates a transient variable.

Definition

A variable in Qlik Sense is a named entity, containing a data value. This value can be static or be the result of a calculation. A variable acquires its value at the same time that the variable is created or after when updating the properties of the variable. Variables can be used in bookmarks and can contain numeric or alphanumeric data. Any change made to the variable is applied everywhere the variable is used.

When a variable is used in an expression, it is substituted by its value or the variable's definition.

Example

The variable x contains the text string Sum(Sales) .

In a chart, you define the expression $(x)/12 . The effect is exactly the same as having the chart expression Sum(Sales)/12 .

However, if you change the value of the variable x to Sum(Budget) , the data in the chart are immediately recalculated with the expression interpreted as Sum(Budget)/12 .

Create temporary bookmark

Create temporary bookmark

Create temporary bookmark

Create temporary bookmark

Creates a variable.

Creates a variable.

Creates a variable.

Creates a variable.

Creates a variable.

To create a variable via a script, you need to use the SetScript method. For more information, see Create a variable.

Definition

A variable in Qlik Sense is a named entity, containing a data value. This value can be static or be the result of a calculation. A variable acquires its value at the same time that the variable is created or after when updating the properties of the variable. Variables can be used in bookmarks and can contain numeric or alphanumeric data. Any change made to the variable is applied everywhere the variable is used.

When a variable is used in an expression, it is substituted by its value or the variable's definition.

Example

The variable x contains the text string Sum(Sales) .

In a chart, you define the expression $(x)/12 . The effect is exactly the same as having the chart expression Sum(Sales)/12 .

However, if you change the value of the variable x to Sum(Budget) , the data in the chart are immediately recalculated with the expression interpreted as Sum(Budget)/12 .

Creates a variable.

To create a variable via a script, you need to use the SetScript method. For more information, see Create a variable.

Definition

A variable in Qlik Sense is a named entity, containing a data value. This value can be static or be the result of a calculation. A variable acquires its value at the same time that the variable is created or after when updating the properties of the variable. Variables can be used in bookmarks and can contain numeric or alphanumeric data. Any change made to the variable is applied everywhere the variable is used.

When a variable is used in an expression, it is substituted by its value or the variable's definition.

Example

The variable x contains the text string Sum(Sales) .

In a chart, you define the expression $(x)/12 . The effect is exactly the same as having the chart expression Sum(Sales)/12 .

However, if you change the value of the variable x to Sum(Budget) , the data in the chart are immediately recalculated with the expression interpreted as Sum(Budget)/12 .

Creates a variable.

To create a variable via a script, you need to use the SetScript method. For more information, see Create a variable.

Definition

A variable in Qlik Sense is a named entity, containing a data value. This value can be static or be the result of a calculation. A variable acquires its value at the same time that the variable is created or after when updating the properties of the variable. Variables can be used in bookmarks and can contain numeric or alphanumeric data. Any change made to the variable is applied everywhere the variable is used.

When a variable is used in an expression, it is substituted by its value or the variable's definition.

Example

The variable x contains the text string Sum(Sales) .

In a chart, you define the expression $(x)/12 . The effect is exactly the same as having the chart expression Sum(Sales)/12 .

However, if you change the value of the variable x to Sum(Budget) , the data in the chart are immediately recalculated with the expression interpreted as Sum(Budget)/12 .

Creates a variable.

To create a variable via a script, you need to use the SetScript method. For more information, see Create a variable.

Definition

A variable in Qlik Sense is a named entity, containing a data value. This value can be static or be the result of a calculation. A variable acquires its value at the same time that the variable is created or after when updating the properties of the variable. Variables can be used in bookmarks and can contain numeric or alphanumeric data. Any change made to the variable is applied everywhere the variable is used.

When a variable is used in an expression, it is substituted by its value or the variable's definition.

Example

The variable x contains the text string Sum(Sales) .

In a chart, you define the expression $(x)/12 . The effect is exactly the same as having the chart expression Sum(Sales)/12 .

However, if you change the value of the variable x to Sum(Budget) , the data in the chart are immediately recalculated with the expression interpreted as Sum(Budget)/12 .

Deletes a connection.

Deletes a connection.

Deletes a connection.

Removes the draft of an object.

The children of the draft object (if any) are removed as well.

This method can be used to cancel the work on the draft of an object. For example, if you had created a draft of a sheet that is published, you might not want anymore to replace the published sheet.

Removes the draft of an object.

The children of the draft object (if any) are removed as well.

This method can be used to cancel the work on the draft of an object. For example, if you had created a draft of a sheet that is published, you might not want anymore to replace the published sheet.

Removes the draft of an object.

The children of the draft object (if any) are removed as well.

This method can be used to cancel the work on the draft of an object. For example, if you had created a draft of a sheet that is published, you might not want anymore to replace the published sheet.

Removes the draft of an object.

The children of the draft object (if any) are removed as well.

This method can be used to cancel the work on the draft of an object. For example, if you had created a draft of a sheet that is published, you might not want anymore to replace the published sheet.

Removes a bookmark.

Removes a bookmark.

Removes a bookmark.

Removes a bookmark.

Removes a dimension.

Removes a dimension.

Removes a dimension.

Removes a dimension.

Removes a generic measure.

Removes a generic measure.

Removes a generic measure.

Removes a generic measure.

Removes an app object.

The children of the object (if any) are removed as well.

Removes an app object.

The children of the object (if any) are removed as well.

Removes an app object.

The children of the object (if any) are removed as well.

Removes an app object.

The children of the object (if any) are removed as well.

Removes a transient object.

Removes a transient object.

Removes a transient object.

Removes a transient object.

Removes a transient variable.

Removes a transient variable.

Removes a transient variable.

Removes a transient variable.

Removes a transient variable.

Removes a transient variable.

Removes a transient variable.

Removes a transient variable.

Removes a transient variable.

Removes a transient variable.

Removes a transient variable.

Removes a transient variable.

Removes a variable.

Script-defined variables cannot be removed using the DestroyVariableById method or the DestroyVariableByName method. For more information, see Remove a variable.

Removes a variable.

Script-defined variables cannot be removed using the DestroyVariableById method or the DestroyVariableByName method. For more information, see Remove a variable.

Removes a variable.

Script-defined variables cannot be removed using the DestroyVariableById method or the DestroyVariableByName method. For more information, see Remove a variable.

Removes a variable.

Script-defined variables cannot be removed using the DestroyVariableById method or the DestroyVariableByName method. For more information, see Remove a variable.

Removes a variable.

Script-defined variables cannot be removed using the DestroyVariableById method or the DestroyVariableByName method. For more information, see Remove a variable.

Removes a variable.

Script-defined variables cannot be removed using the DestroyVariableById method or the DestroyVariableByName method. For more information, see Remove a variable.

Removes a variable.

Script-defined variables cannot be removed using the DestroyVariableById method or the DestroyVariableByName method. For more information, see Remove a variable.

Removes a variable.

Script-defined variables cannot be removed using the DestroyVariableById method or the DestroyVariableByName method. For more information, see Remove a variable.

Reloads the script that is set in an app.

Logs

When this method is called, audit activity logs are produced to track the user activity.

In the case of errors, both audit activity logs and system services logs are produced.

The log files are named as follows:

Please refer to Engine API reference for table definition.

Where to find the log files

The location of the log files depends on whether you have installed Qlik Sense Enterprise or Qlik Sense Desktop.

Please refer to Engine API reference for table definition.

Reloads the script that is set in an app.

Logs

When this method is called, audit activity logs are produced to track the user activity.

In the case of errors, both audit activity logs and system services logs are produced.

The log files are named as follows:

Please refer to Engine API reference for table definition.

Where to find the log files

The location of the log files depends on whether you have installed Qlik Sense Enterprise or Qlik Sense Desktop.

Please refer to Engine API reference for table definition.

Reloads the script that is set in an app.

Logs

When this method is called, audit activity logs are produced to track the user activity.

In the case of errors, both audit activity logs and system services logs are produced.

The log files are named as follows:

Please refer to Engine API reference for table definition.

Where to find the log files

The location of the log files depends on whether you have installed Qlik Sense Enterprise or Qlik Sense Desktop.

Please refer to Engine API reference for table definition.

Reloads the script that is set in an app.

Logs

When this method is called, audit activity logs are produced to track the user activity.

In the case of errors, both audit activity logs and system services logs are produced.

The log files are named as follows:

Please refer to Engine API reference for table definition.

Where to find the log files

The location of the log files depends on whether you have installed Qlik Sense Enterprise or Qlik Sense Desktop.

Please refer to Engine API reference for table definition.

Reloads the script that is set in an app and returns the path to the script log file.

Logs

When this method is called, audit activity logs are produced to track the user activity.

In the case of errors, both audit activity logs and system services logs are produced.

The log files are named as follows:

Please refer to Engine API reference for table definition.

Where to find the log files

The location of the log files depends on whether you have installed Qlik Sense Enterprise or Qlik Sense Desktop.

Please refer to Engine API reference for table definition.

DoReloadExParams

Please refer to Engine API reference for table definition.

DoReloadExResult

Please refer to Engine API reference for table definition.

If the data load has successfully finished, no matter how the indexing behaves, true is returned. This happens even if there is a timeout, a memory limit is reached or any other error occurs during the indexing.

Reloads the script that is set in an app and returns the path to the script log file.

Logs

When this method is called, audit activity logs are produced to track the user activity.

In the case of errors, both audit activity logs and system services logs are produced.

The log files are named as follows:

Please refer to Engine API reference for table definition.

Where to find the log files

The location of the log files depends on whether you have installed Qlik Sense Enterprise or Qlik Sense Desktop.

Please refer to Engine API reference for table definition.

DoReloadExParams

Please refer to Engine API reference for table definition.

DoReloadExResult

Please refer to Engine API reference for table definition.

If the data load has successfully finished, no matter how the indexing behaves, true is returned. This happens even if there is a timeout, a memory limit is reached or any other error occurs during the indexing.

Reloads the script that is set in an app and returns the path to the script log file.

Logs

When this method is called, audit activity logs are produced to track the user activity.

In the case of errors, both audit activity logs and system services logs are produced.

The log files are named as follows:

Please refer to Engine API reference for table definition.

Where to find the log files

The location of the log files depends on whether you have installed Qlik Sense Enterprise or Qlik Sense Desktop.

Please refer to Engine API reference for table definition.

DoReloadExParams

Please refer to Engine API reference for table definition.

DoReloadExResult

Please refer to Engine API reference for table definition.

If the data load has successfully finished, no matter how the indexing behaves, true is returned. This happens even if there is a timeout, a memory limit is reached or any other error occurs during the indexing.

Reloads the script that is set in an app and returns the path to the script log file.

Logs

When this method is called, audit activity logs are produced to track the user activity.

In the case of errors, both audit activity logs and system services logs are produced.

The log files are named as follows:

Please refer to Engine API reference for table definition.

Where to find the log files

The location of the log files depends on whether you have installed Qlik Sense Enterprise or Qlik Sense Desktop.

Please refer to Engine API reference for table definition.

DoReloadExParams

Please refer to Engine API reference for table definition.

DoReloadExResult

Please refer to Engine API reference for table definition.

If the data load has successfully finished, no matter how the indexing behaves, true is returned. This happens even if there is a timeout, a memory limit is reached or any other error occurs during the indexing.

Saves an app. All objects and data in the data model are saved.

Saves an app. All objects and data in the data model are saved.

Saves an app. All objects and data in the data model are saved.

Evaluates an expression and returns the result as a string.

Example

The client sends:

</p> <p>{</p> <p>&quot;handle&quot;: 1,</p> <p>&quot;method&quot;: &quot;Evaluate&quot;,</p> <p>&quot;params&quot;: {</p> <p>&quot;qExpression&quot;: &quot;Sum(Holes)&quot;</p> <p>},</p> <p>&quot;id&quot;: 6,</p> <p>&quot;jsonrpc&quot;: &quot;2.0&quot;</p> <p>}</p> <p>

The engine returns:

</p> <p>{</p> <p>&quot;jsonrpc&quot;: &quot;2.0&quot;,</p> <p>&quot;id&quot;: 6,</p> <p>&quot;result&quot;: {</p> <p>&quot;qReturn&quot;: &quot;361716&quot;</p> <p>}</p> <p>}</p> <p>

Evaluates an expression and returns the result as a string.

Example

The client sends:

</p> <p>{</p> <p>&quot;handle&quot;: 1,</p> <p>&quot;method&quot;: &quot;Evaluate&quot;,</p> <p>&quot;params&quot;: {</p> <p>&quot;qExpression&quot;: &quot;Sum(Holes)&quot;</p> <p>},</p> <p>&quot;id&quot;: 6,</p> <p>&quot;jsonrpc&quot;: &quot;2.0&quot;</p> <p>}</p> <p>

The engine returns:

</p> <p>{</p> <p>&quot;jsonrpc&quot;: &quot;2.0&quot;,</p> <p>&quot;id&quot;: 6,</p> <p>&quot;result&quot;: {</p> <p>&quot;qReturn&quot;: &quot;361716&quot;</p> <p>}</p> <p>}</p> <p>

Evaluates an expression and returns the result as a string.

Example

The client sends:

</p> <p>{</p> <p>&quot;handle&quot;: 1,</p> <p>&quot;method&quot;: &quot;Evaluate&quot;,</p> <p>&quot;params&quot;: {</p> <p>&quot;qExpression&quot;: &quot;Sum(Holes)&quot;</p> <p>},</p> <p>&quot;id&quot;: 6,</p> <p>&quot;jsonrpc&quot;: &quot;2.0&quot;</p> <p>}</p> <p>

The engine returns:

</p> <p>{</p> <p>&quot;jsonrpc&quot;: &quot;2.0&quot;,</p> <p>&quot;id&quot;: 6,</p> <p>&quot;result&quot;: {</p> <p>&quot;qReturn&quot;: &quot;361716&quot;</p> <p>}</p> <p>}</p> <p>

Evaluates an expression and returns the result as a string.

Example

The client sends:

</p> <p>{</p> <p>&quot;handle&quot;: 1,</p> <p>&quot;method&quot;: &quot;Evaluate&quot;,</p> <p>&quot;params&quot;: {</p> <p>&quot;qExpression&quot;: &quot;Sum(Holes)&quot;</p> <p>},</p> <p>&quot;id&quot;: 6,</p> <p>&quot;jsonrpc&quot;: &quot;2.0&quot;</p> <p>}</p> <p>

The engine returns:

</p> <p>{</p> <p>&quot;jsonrpc&quot;: &quot;2.0&quot;,</p> <p>&quot;id&quot;: 6,</p> <p>&quot;result&quot;: {</p> <p>&quot;qReturn&quot;: &quot;361716&quot;</p> <p>}</p> <p>}</p> <p>

Evaluates an expression and returns the result as a dual.

Example

The client sends:

</p> <p>{</p> <p>&quot;handle&quot;: 1,</p> <p>&quot;method&quot;: &quot;EvaluateEx&quot;,</p> <p>&quot;params&quot;: {</p> <p>&quot;qExpression&quot;: &quot;Sum(Holes)&quot;</p> <p>},</p> <p>&quot;id&quot;: 7,</p> <p>&quot;jsonrpc&quot;: &quot;2.0&quot;</p> <p>}</p> <p>

The engine returns:

</p> <p>{</p> <p>&quot;jsonrpc&quot;: &quot;2.0&quot;,</p> <p>&quot;id&quot;: 7,</p> <p>&quot;result&quot;: {</p> <p>&quot;qReturn&quot;: &quot;361716&quot;</p> <p>}</p> <p>}</p> <p>

Evaluates an expression and returns the result as a dual.

Example

The client sends:

</p> <p>{</p> <p>&quot;handle&quot;: 1,</p> <p>&quot;method&quot;: &quot;EvaluateEx&quot;,</p> <p>&quot;params&quot;: {</p> <p>&quot;qExpression&quot;: &quot;Sum(Holes)&quot;</p> <p>},</p> <p>&quot;id&quot;: 7,</p> <p>&quot;jsonrpc&quot;: &quot;2.0&quot;</p> <p>}</p> <p>

The engine returns:

</p> <p>{</p> <p>&quot;jsonrpc&quot;: &quot;2.0&quot;,</p> <p>&quot;id&quot;: 7,</p> <p>&quot;result&quot;: {</p> <p>&quot;qReturn&quot;: &quot;361716&quot;</p> <p>}</p> <p>}</p> <p>

Evaluates an expression and returns the result as a dual.

Example

The client sends:

</p> <p>{</p> <p>&quot;handle&quot;: 1,</p> <p>&quot;method&quot;: &quot;EvaluateEx&quot;,</p> <p>&quot;params&quot;: {</p> <p>&quot;qExpression&quot;: &quot;Sum(Holes)&quot;</p> <p>},</p> <p>&quot;id&quot;: 7,</p> <p>&quot;jsonrpc&quot;: &quot;2.0&quot;</p> <p>}</p> <p>

The engine returns:

</p> <p>{</p> <p>&quot;jsonrpc&quot;: &quot;2.0&quot;,</p> <p>&quot;id&quot;: 7,</p> <p>&quot;result&quot;: {</p> <p>&quot;qReturn&quot;: &quot;361716&quot;</p> <p>}</p> <p>}</p> <p>

Evaluates an expression and returns the result as a dual.

Example

The client sends:

</p> <p>{</p> <p>&quot;handle&quot;: 1,</p> <p>&quot;method&quot;: &quot;EvaluateEx&quot;,</p> <p>&quot;params&quot;: {</p> <p>&quot;qExpression&quot;: &quot;Sum(Holes)&quot;</p> <p>},</p> <p>&quot;id&quot;: 7,</p> <p>&quot;jsonrpc&quot;: &quot;2.0&quot;</p> <p>}</p> <p>

The engine returns:

</p> <p>{</p> <p>&quot;jsonrpc&quot;: &quot;2.0&quot;,</p> <p>&quot;id&quot;: 7,</p> <p>&quot;result&quot;: {</p> <p>&quot;qReturn&quot;: &quot;361716&quot;</p> <p>}</p> <p>}</p> <p>

Expands the expression.

Expands the expression.

Expands the expression.

Expands the expression.

Applies a bookmark to reduce (slice) the data on. Returns a url and file size to the reduced application. Section Access is always applied.

Applies a bookmark to reduce (slice) the data on. Returns a url and file size to the reduced application. Section Access is always applied.

Applies a bookmark to reduce (slice) the data on. Returns a url and file size to the reduced application. Section Access is always applied.

Applies a bookmark to reduce (slice) the data on. Returns a url and file size to the reduced application. Section Access is always applied.

Retrieves any fields that belong to the same archipelago as the specified field and that match at least one of the specified tags.

Retrieves any fields that belong to the same archipelago as the specified field and that match at least one of the specified tags.

Retrieves any fields that belong to the same archipelago as the specified field and that match at least one of the specified tags.

Retrieves any fields that belong to the same archipelago as the specified field and that match at least one of the specified tags.

Loads the next logical operation (if any).

Loads the next logical operation (if any).

Loads the next logical operation (if any).

Returns the number of entries on the Forward stack.

Returns the number of entries on the Forward stack.

Returns the number of entries on the Forward stack.

Returns the number of entries on the Forward stack.

Returns the identifier and the type of any generic object in the app.

Returns the identifier and the type of any generic object in the app.

Returns the identifier and the type of any generic object in the app.

Returns the identifier and the type of any generic object in the app.

Evaluates an app.

Returns dynamic properties (if any) in addition to the engine (fixed) properties.

A data set is returned.

Evaluates an app.

Returns dynamic properties (if any) in addition to the engine (fixed) properties.

A data set is returned.

Evaluates an app.

Returns dynamic properties (if any) in addition to the engine (fixed) properties.

A data set is returned.

Evaluates an app.

Returns dynamic properties (if any) in addition to the engine (fixed) properties.

A data set is returned.

Gets the properties of an app.

Gets the properties of an app.

Gets the properties of an app.

Gets the properties of an app.

Computes a set of association scores for each pair of fields between two given tables that have been loaded in an app.

When a table contains some synthetic keys, all fields in the synthetic key tables are analyzed against fields in other tables. To denote that a field is a synthetic key, the field name is prefixed by [Synthetic Key]: .

Computes a set of association scores for each pair of fields between two given tables that have been loaded in an app.

When a table contains some synthetic keys, all fields in the synthetic key tables are analyzed against fields in other tables. To denote that a field is a synthetic key, the field name is prefixed by [Synthetic Key]: .

Computes a set of association scores for each pair of fields between two given tables that have been loaded in an app.

When a table contains some synthetic keys, all fields in the synthetic key tables are analyzed against fields in other tables. To denote that a field is a synthetic key, the field name is prefixed by [Synthetic Key]: .

Computes a set of association scores for each pair of fields between two given tables that have been loaded in an app.

When a table contains some synthetic keys, all fields in the synthetic key tables are analyzed against fields in other tables. To denote that a field is a synthetic key, the field name is prefixed by [Synthetic Key]: .

Returns all bookmarks compatible with options.

Returns all bookmarks compatible with options.

Returns all bookmarks compatible with options.

Returns all bookmarks compatible with options.

Retrieves a connection and returns:

* The creation time of the connection.

* The identifier of the connection.

* The type of the connection.

* The name of the connection.

* The connection string.

Retrieves a connection and returns:

* The creation time of the connection.

* The identifier of the connection.

* The type of the connection.

* The name of the connection.

* The connection string.

Retrieves a connection and returns:

* The creation time of the connection.

* The identifier of the connection.

* The type of the connection.

* The name of the connection.

* The connection string.

Retrieves a connection and returns:

* The creation time of the connection.

* The identifier of the connection.

* The type of the connection.

* The name of the connection.

* The connection string.

Lists the connections in an app.

Lists the connections in an app.

Lists the connections in an app.

Lists the connections in an app.

Lists the content libraries.

To differentiate a global content library from an app specific content library, you can check the property qAppSpecific . If this property is set to true, it means that the content library is app specific.

Qlik Sense

Returns the global content libraries and the app specific content library.

When using Qlik Sense, you can have more than one global content library. The global content libraries are common to all apps in the Qlik Sense repository.

By default, there is one global content library named Default .

Qlik Sense Desktop

Returns the global content library and the app specific content library from the disk.

Lists the content libraries.

To differentiate a global content library from an app specific content library, you can check the property qAppSpecific . If this property is set to true, it means that the content library is app specific.

Qlik Sense

Returns the global content libraries and the app specific content library.

When using Qlik Sense, you can have more than one global content library. The global content libraries are common to all apps in the Qlik Sense repository.

By default, there is one global content library named Default .

Qlik Sense Desktop

Returns the global content library and the app specific content library from the disk.

Lists the content libraries.

To differentiate a global content library from an app specific content library, you can check the property qAppSpecific . If this property is set to true, it means that the content library is app specific.

Qlik Sense

Returns the global content libraries and the app specific content library.

When using Qlik Sense, you can have more than one global content library. The global content libraries are common to all apps in the Qlik Sense repository.

By default, there is one global content library named Default .

Qlik Sense Desktop

Returns the global content library and the app specific content library from the disk.

Lists the content libraries.

To differentiate a global content library from an app specific content library, you can check the property qAppSpecific . If this property is set to true, it means that the content library is app specific.

Qlik Sense

Returns the global content libraries and the app specific content library.

When using Qlik Sense, you can have more than one global content library. The global content libraries are common to all apps in the Qlik Sense repository.

By default, there is one global content library named Default .

Qlik Sense Desktop

Returns the global content library and the app specific content library from the disk.

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.

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.

Lists the owners of a database for a ODBC, OLEDB or CUSTOM connection.

Lists the owners of a database for a ODBC, OLEDB or CUSTOM connection.

Lists the owners of a database for a ODBC, OLEDB or CUSTOM connection.

Lists the owners of a database for a ODBC, OLEDB or CUSTOM connection.

Lists the databases inside a ODBC, OLEDB or CUSTOM data source.

Lists the databases inside a ODBC, OLEDB or CUSTOM data source.

Lists the databases inside a ODBC, OLEDB or CUSTOM data source.

Lists the databases inside a ODBC, OLEDB or CUSTOM data source.

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.

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.

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.

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.

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.

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.

Creates a script that contains one section. This section contains SET statements that give localized information from the regional settings of the computer.

Creates a script that contains one section. This section contains SET statements that give localized information from the regional settings of the computer.

Creates a script that contains one section. This section contains SET statements that give localized information from the regional settings of the computer.

Creates a script that contains one section. This section contains SET statements that give localized information from the regional settings of the computer.

Gets the current Backus-Naur Form (BNF) grammar of the Qlik chart expressions supported within a given App.

Gets the current Backus-Naur Form (BNF) grammar of the Qlik chart expressions supported within a given App.

Gets the current Backus-Naur Form (BNF) grammar of the Qlik chart expressions supported within a given App.

Gets the current Backus-Naur Form (BNF) grammar of the Qlik chart expressions supported within a given App.

Gets a string hash calculated from the current Backus-Naur Form (BNF) grammar of the Qlik chart expressions supported within a given App.

Gets a string hash calculated from the current Backus-Naur Form (BNF) grammar of the Qlik chart expressions supported within a given App.

Gets a string hash calculated from the current Backus-Naur Form (BNF) grammar of the Qlik chart expressions supported within a given App.

Gets a string hash calculated from the current Backus-Naur Form (BNF) grammar of the Qlik chart expressions supported within a given App.

Retrieves the variables that are tagged as favorite.

Retrieves the variables that are tagged as favorite.

Retrieves the variables that are tagged as favorite.

Retrieves the variables that are tagged as favorite.

Returns a handle to a field.

Get sample values from either a column in a table or from a field.

Supports wildcard matches in tables or field names:

- '*' for zero or more characters.

- '?' for one character.

Get sample values from either a column in a table or from a field.

Supports wildcard matches in tables or field names:

- '*' for zero or more characters.

- '?' for one character.

Get sample values from either a column in a table or from a field.

Supports wildcard matches in tables or field names:

- '*' for zero or more characters.

- '?' for one character.

Get sample values from either a column in a table or from a field.

Supports wildcard matches in tables or field names:

- '*' for zero or more characters.

- '?' for one character.

Returns a handle to a field.

Returns a handle to a field.

Returns a handle to a field.

Returns the description of a field.

Returns the description of a field.

Returns the description of a field.

Returns the description of a field.

Find the field-on-the-fly by passing its readable name.

Find the field-on-the-fly by passing its readable name.

Find the field-on-the-fly by passing its readable name.

Find the field-on-the-fly by passing its readable name.

Retrives any fields from an expression.

Retrives any fields from an expression.

Retrives any fields from an expression.

Retrives any fields from an expression.

Returns a list of resource ids (QRI) for fields that belongs to the datamodel.

Key fields (that belongs to multiple tables), returns one resource identifier per table.

Returns a list of resource ids (QRI) for fields that belongs to the datamodel.

Key fields (that belongs to multiple tables), returns one resource identifier per table.

Returns a list of resource ids (QRI) for fields that belongs to the datamodel.

Key fields (that belongs to multiple tables), returns one resource identifier per table.

Returns a list of resource ids (QRI) for fields that belongs to the datamodel.

Key fields (that belongs to multiple tables), returns one resource identifier per table.

Lists the fields of a table for a folder connection.

FileType

Recognized file formats are:

* CSV for Delimited

* FIX for Fixed Record

* DIF for Data Interchange Format

* EXCEL_BIFF for Microsoft Excel (XLS)

* EXCEL_OOXML for Microsoft Excel (XLSX)

* HTML for HTML

* QVD for QVD file

* XML for XML

* QVX for QVX file

* JSON for JSON format

* KML for KML file

* PARQUET for PARQUET file

Lists the fields of a table for a folder connection.

FileType

Recognized file formats are:

* CSV for Delimited

* FIX for Fixed Record

* DIF for Data Interchange Format

* EXCEL_BIFF for Microsoft Excel (XLS)

* EXCEL_OOXML for Microsoft Excel (XLSX)

* HTML for HTML

* QVD for QVD file

* XML for XML

* QVX for QVX file

* JSON for JSON format

* KML for KML file

* PARQUET for PARQUET file

Lists the fields of a table for a folder connection.

FileType

Recognized file formats are:

* CSV for Delimited

* FIX for Fixed Record

* DIF for Data Interchange Format

* EXCEL_BIFF for Microsoft Excel (XLS)

* EXCEL_OOXML for Microsoft Excel (XLSX)

* HTML for HTML

* QVD for QVD file

* XML for XML

* QVX for QVX file

* JSON for JSON format

* KML for KML file

* PARQUET for PARQUET file

Lists the fields of a table for a folder connection.

FileType

Recognized file formats are:

* CSV for Delimited

* FIX for Fixed Record

* DIF for Data Interchange Format

* EXCEL_BIFF for Microsoft Excel (XLS)

* EXCEL_OOXML for Microsoft Excel (XLSX)

* HTML for HTML

* QVD for QVD file

* XML for XML

* QVX for QVX file

* JSON for JSON format

* KML for KML file

* PARQUET for PARQUET file

Lists the values in a table for a folder connection.

FileType

Recognized file formats are:

* CSV for Delimited

* FIX for Fixed Record

* DIF for Data Interchange Format

* EXCEL_BIFF for Microsoft Excel (XLS)

* EXCEL_OOXML for Microsoft Excel (XLSX)

* HTML for HTML

* QVD for QVD file

* XML for XML

* QVX for QVX file

* JSON for JSON format

* KML for KML file

* PARQUET for PARQUET file

Lists the values in a table for a folder connection.

FileType

Recognized file formats are:

* CSV for Delimited

* FIX for Fixed Record

* DIF for Data Interchange Format

* EXCEL_BIFF for Microsoft Excel (XLS)

* EXCEL_OOXML for Microsoft Excel (XLSX)

* HTML for HTML

* QVD for QVD file

* XML for XML

* QVX for QVX file

* JSON for JSON format

* KML for KML file

* PARQUET for PARQUET file

Lists the values in a table for a folder connection.

FileType

Recognized file formats are:

* CSV for Delimited

* FIX for Fixed Record

* DIF for Data Interchange Format

* EXCEL_BIFF for Microsoft Excel (XLS)

* EXCEL_OOXML for Microsoft Excel (XLSX)

* HTML for HTML

* QVD for QVD file

* XML for XML

* QVX for QVX file

* JSON for JSON format

* KML for KML file

* PARQUET for PARQUET file

Lists the values in a table for a folder connection.

FileType

Recognized file formats are:

* CSV for Delimited

* FIX for Fixed Record

* DIF for Data Interchange Format

* EXCEL_BIFF for Microsoft Excel (XLS)

* EXCEL_OOXML for Microsoft Excel (XLSX)

* HTML for HTML

* QVD for QVD file

* XML for XML

* QVX for QVX file

* JSON for JSON format

* KML for KML file

* PARQUET for PARQUET file

Lists the tables for a folder connection.

FileType

Recognized file formats are:

* CSV for Delimited

* FIX for Fixed Record

* DIF for Data Interchange Format

* EXCEL_BIFF for Microsoft Excel (XLS)

* EXCEL_OOXML for Microsoft Excel (XLSX)

* HTML for HTML

* QVD for QVD file

* XML for XML

* QVX for QVX file

* JSON for JSON format

* KML for KML file

* PARQUET for PARQUET file

Lists the tables for a folder connection.

FileType

Recognized file formats are:

* CSV for Delimited

* FIX for Fixed Record

* DIF for Data Interchange Format

* EXCEL_BIFF for Microsoft Excel (XLS)

* EXCEL_OOXML for Microsoft Excel (XLSX)

* HTML for HTML

* QVD for QVD file

* XML for XML

* QVX for QVX file

* JSON for JSON format

* KML for KML file

* PARQUET for PARQUET file

Lists the tables for a folder connection.

FileType

Recognized file formats are:

* CSV for Delimited

* FIX for Fixed Record

* DIF for Data Interchange Format

* EXCEL_BIFF for Microsoft Excel (XLS)

* EXCEL_OOXML for Microsoft Excel (XLSX)

* HTML for HTML

* QVD for QVD file

* XML for XML

* QVX for QVX file

* JSON for JSON format

* KML for KML file

* PARQUET for PARQUET file

Lists the tables for a folder connection.

FileType

Recognized file formats are:

* CSV for Delimited

* FIX for Fixed Record

* DIF for Data Interchange Format

* EXCEL_BIFF for Microsoft Excel (XLS)

* EXCEL_OOXML for Microsoft Excel (XLSX)

* HTML for HTML

* QVD for QVD file

* XML for XML

* QVX for QVX file

* JSON for JSON format

* KML for KML file

* PARQUET for PARQUET file

Lists the tables and fields of a JSON or XML file for a folder connection.

Lists the tables and fields of a JSON or XML file for a folder connection.

Lists the tables and fields of a JSON or XML file for a folder connection.

Lists the tables and fields of a JSON or XML file for a folder connection.

Lists the items for a folder connection.

Lists the items for a folder connection.

Lists the items for a folder connection.

Lists the items for a folder connection.

Returns the handle of a bookmark.

Returns the handle of a bookmark.

Returns the handle of a bookmark.

Returns the handle of a bookmark.

Returns the handle of a dimension.

Returns the handle of a dimension.

Returns the handle of a dimension.

Returns the handle of a dimension.

Returns the handle of a measure.

Returns the handle of a measure.

Returns the handle of a measure.

Returns the handle of a measure.

Returns the type of the app object and the corresponding handle.

Returns the type of the app object and the corresponding handle.

Returns the type of the app object and the corresponding handle.

Returns the type of the app object and the corresponding handle.

Gets the content of a file.

Gets the content of a file.

Gets the content of a file.

Gets the content of a file.

Returns the content of a library.

Global content library

In Qlik Sense Desktop, the content files are retrieved from:

%userprofile%\Documents\Qlik\Sense\Content\Default

In Qlik Sense Enterprise, the content files are retrieved from the Qlik Sense repository.

App specific content library

The embedded files are returned.

Returns the content of a library.

Global content library

In Qlik Sense Desktop, the content files are retrieved from:

%userprofile%\Documents\Qlik\Sense\Content\Default

In Qlik Sense Enterprise, the content files are retrieved from the Qlik Sense repository.

App specific content library

The embedded files are returned.

Returns the content of a library.

Global content library

In Qlik Sense Desktop, the content files are retrieved from:

%userprofile%\Documents\Qlik\Sense\Content\Default

In Qlik Sense Enterprise, the content files are retrieved from the Qlik Sense repository.

App specific content library

The embedded files are returned.

Returns the content of a library.

Global content library

In Qlik Sense Desktop, the content files are retrieved from:

%userprofile%\Documents\Qlik\Sense\Content\Default

In Qlik Sense Enterprise, the content files are retrieved from the Qlik Sense repository.

App specific content library

The embedded files are returned.

Gets the lineage information of the app. The lineage information includes the LOAD and STORE statements from the data load script associated with this app.

An array of lineage information.

Gets the lineage information of the app. The lineage information includes the LOAD and STORE statements from the data load script associated with this app.

An array of lineage information.

Gets the lineage information of the app. The lineage information includes the LOAD and STORE statements from the data load script associated with this app.

An array of lineage information.

Gets the lineage information of the app. The lineage information includes the LOAD and STORE statements from the data load script associated with this app.

An array of lineage information.

Returns locale information.

Returns locale information.

Returns locale information.

Returns locale information.

Returns a list of table states.

The following states apply:

* 0 The table is not loosely coupled.

* 1 The table is loosely coupled.

* 2 The table is loosely coupled and cannot be changed to another state using the Qlik Engine API.

Returns a list of table states.

The following states apply:

* 0 The table is not loosely coupled.

* 1 The table is loosely coupled.

* 2 The table is loosely coupled and cannot be changed to another state using the Qlik Engine API.

Returns a list of table states.

The following states apply:

* 0 The table is not loosely coupled.

* 1 The table is loosely coupled.

* 2 The table is loosely coupled and cannot be changed to another state using the Qlik Engine API.

Returns a list of table states.

The following states apply:

* 0 The table is not loosely coupled.

* 1 The table is loosely coupled.

* 2 The table is loosely coupled and cannot be changed to another state using the Qlik Engine API.

Retrieves any fields that match all of the specified tags or just one of them in the data model of an app.

Retrieves any fields that match all of the specified tags or just one of them in the data model of an app.

Retrieves any fields that match all of the specified tags or just one of them in the data model of an app.

Retrieves any fields that match all of the specified tags or just one of them in the data model of an app.

Returns the handle of a measure with a label.

If multiple measures has the same label the first is returned.

Returns the handle of a measure with a label.

If multiple measures has the same label the first is returned.

Returns the handle of a measure with a label.

If multiple measures has the same label the first is returned.

Returns the handle of a measure with a label.

If multiple measures has the same label the first is returned.

Lists the media files.

Lists the media files.

Lists the media files.

Lists the media files.

Get an object

Get an object

Get an object

Get an object

Returns all objects compatible with options.

Returns all objects compatible with options.

Returns all objects compatible with options.

Returns all objects compatible with options.

Gets values in script.

Gets values in script.

Gets values in script.

Gets values in script.

Lists the breakpoints in the script of an app.

Lists the breakpoints in the script of an app.

Lists the breakpoints in the script of an app.

Lists the breakpoints in the script of an app.

Gets script and script meta-data.

Gets script and script meta-data.

Gets script and script meta-data.

Gets script and script meta-data.

Gets script meta-data.

Gets script meta-data.

Gets script meta-data.

Gets script meta-data.

Returns a set analysis expression from active selections or from a saved bookmark. Fields on the fly and Calculated dimensions will not be included in the generated expressions, instead a message indicating 'missing fields' will provided within the expression.

| | BookmarkId empty | BookmarkId set |

|-----------------------|--------------------------------------|----------------------------------------------------|

|StateName empty (or $) | Default selections state is returned.| Default state ($) in bookmark with id is returned. |

|StateName set | State selections is returned. | State in bookmark with id is returned. |

Returns a set analysis expression from active selections or from a saved bookmark. Fields on the fly and Calculated dimensions will not be included in the generated expressions, instead a message indicating 'missing fields' will provided within the expression.

| | BookmarkId empty | BookmarkId set |

|-----------------------|--------------------------------------|----------------------------------------------------|

|StateName empty (or $) | Default selections state is returned.| Default state ($) in bookmark with id is returned. |

|StateName set | State selections is returned. | State in bookmark with id is returned. |

Returns a set analysis expression from active selections or from a saved bookmark. Fields on the fly and Calculated dimensions will not be included in the generated expressions, instead a message indicating 'missing fields' will provided within the expression.

| | BookmarkId empty | BookmarkId set |

|-----------------------|--------------------------------------|----------------------------------------------------|

|StateName empty (or $) | Default selections state is returned.| Default state ($) in bookmark with id is returned. |

|StateName set | State selections is returned. | State in bookmark with id is returned. |

Returns a set analysis expression from active selections or from a saved bookmark. Fields on the fly and Calculated dimensions will not be included in the generated expressions, instead a message indicating 'missing fields' will provided within the expression.

| | BookmarkId empty | BookmarkId set |

|-----------------------|--------------------------------------|----------------------------------------------------|

|StateName empty (or $) | Default selections state is returned.| Default state ($) in bookmark with id is returned. |

|StateName set | State selections is returned. | State in bookmark with id is returned. |

Retrieves the data of a specific table.

Retrieves the data of a specific table.

Retrieves the data of a specific table.

Retrieves the data of a specific table.

Returns profile data for a given table.

Returns profile data for a given table.

Returns profile data for a given table.

Returns profile data for a given table.

Returns:

* The list of tables in an app and the fields inside each table.

* The list of derived fields.

* The list of key fields.

Returns:

* The list of tables in an app and the fields inside each table.

* The list of derived fields.

* The list of key fields.

Returns:

* The list of tables in an app and the fields inside each table.

* The list of derived fields.

* The list of key fields.

Returns:

* The list of tables in an app and the fields inside each table.

* The list of derived fields.

* The list of key fields.

Fetches updated variables after a statement execution.

Fetches updated variables after a statement execution.

Fetches updated variables after a statement execution.

Fetches updated variables after a statement execution.

Returns a handle to a variable.

Returns a handle to a variable.

Returns a handle to a variable.

Returns a handle to a variable.

Gets the handle of a variable.

Gets the handle of a variable.

Gets the handle of a variable.

Gets the handle of a variable.

Gets the handle of a variable.

Gets the handle of a variable.

Gets the handle of a variable.

Gets the handle of a variable.

Returns information about the position of the tables in the data model viewer.

Returns information about the position of the tables in the data model viewer.

Returns information about the position of the tables in the data model viewer.

Returns information about the position of the tables in the data model viewer.

Guesses the data format for a given file.

Recognized file formats are:

* CSV for Delimited

* FIX for Fixed Record

* DIF for Data Interchange Format

* EXCEL_BIFF for Microsoft Excel (XLS)

* EXCEL_OOXML for Microsoft Excel (XLSX)

* HTML for HTML

* QVD for QVD file

* XML for XML

* QVX for QVX file

* JSON for JSON format

* KML for KML file

* PARQUET for PARQUET file

FileType

Recognized file formats are:

* CSV for Delimited

* FIX for Fixed Record

* DIF for Data Interchange Format

* EXCEL_BIFF for Microsoft Excel (XLS)

* EXCEL_OOXML for Microsoft Excel (XLSX)

* HTML for HTML

* QVD for QVD file

* XML for XML

* QVX for QVX file

* JSON for JSON format

* KML for KML file

* PARQUET for PARQUET file

Guesses the data format for a given file.

Recognized file formats are:

* CSV for Delimited

* FIX for Fixed Record

* DIF for Data Interchange Format

* EXCEL_BIFF for Microsoft Excel (XLS)

* EXCEL_OOXML for Microsoft Excel (XLSX)

* HTML for HTML

* QVD for QVD file

* XML for XML

* QVX for QVX file

* JSON for JSON format

* KML for KML file

* PARQUET for PARQUET file

FileType

Recognized file formats are:

* CSV for Delimited

* FIX for Fixed Record

* DIF for Data Interchange Format

* EXCEL_BIFF for Microsoft Excel (XLS)

* EXCEL_OOXML for Microsoft Excel (XLSX)

* HTML for HTML

* QVD for QVD file

* XML for XML

* QVX for QVX file

* JSON for JSON format

* KML for KML file

* PARQUET for PARQUET file

Guesses the data format for a given file.

Recognized file formats are:

* CSV for Delimited

* FIX for Fixed Record

* DIF for Data Interchange Format

* EXCEL_BIFF for Microsoft Excel (XLS)

* EXCEL_OOXML for Microsoft Excel (XLSX)

* HTML for HTML

* QVD for QVD file

* XML for XML

* QVX for QVX file

* JSON for JSON format

* KML for KML file

* PARQUET for PARQUET file

FileType

Recognized file formats are:

* CSV for Delimited

* FIX for Fixed Record

* DIF for Data Interchange Format

* EXCEL_BIFF for Microsoft Excel (XLS)

* EXCEL_OOXML for Microsoft Excel (XLSX)

* HTML for HTML

* QVD for QVD file

* XML for XML

* QVX for QVX file

* JSON for JSON format

* KML for KML file

* PARQUET for PARQUET file

Guesses the data format for a given file.

Recognized file formats are:

* CSV for Delimited

* FIX for Fixed Record

* DIF for Data Interchange Format

* EXCEL_BIFF for Microsoft Excel (XLS)

* EXCEL_OOXML for Microsoft Excel (XLSX)

* HTML for HTML

* QVD for QVD file

* XML for XML

* QVX for QVX file

* JSON for JSON format

* KML for KML file

* PARQUET for PARQUET file

FileType

Recognized file formats are:

* CSV for Delimited

* FIX for Fixed Record

* DIF for Data Interchange Format

* EXCEL_BIFF for Microsoft Excel (XLS)

* EXCEL_OOXML for Microsoft Excel (XLSX)

* HTML for HTML

* QVD for QVD file

* XML for XML

* QVX for QVX file

* JSON for JSON format

* KML for KML file

* PARQUET for PARQUET file

Locks all selections in fields for current state.

Locks all selections in fields for current state.

Locks all selections in fields for current state.

Updates a connection.

Updates a connection.

Updates a connection.

Publishes an app.

All app objects are published. Generic objects, bookmarks, dimensions and measures inside the app are published.

Publishes an app.

All app objects are published. Generic objects, bookmarks, dimensions and measures inside the app are published.

Publishes an app.

All app objects are published. Generic objects, bookmarks, dimensions and measures inside the app are published.

Redoes the previous operation.

Redoes the previous operation.

Redoes the previous operation.

Redoes the previous operation.

Removes an alternate state in the app.

Removes an alternate state in the app.

Removes an alternate state in the app.

Removes an session alternate state in the app.

Removes an session alternate state in the app.

Removes an session alternate state in the app.

Removes an session alternate state in the app.

Removes a variable.

Removes a variable.

Removes a variable.

Removes a variable.

Replace a bookmark. Optional inparams to change the original bookmarks properties, original are kept if left out.

Replace a bookmark. Optional inparams to change the original bookmarks properties, original are kept if left out.

Replace a bookmark. Optional inparams to change the original bookmarks properties, original are kept if left out.

Replace a bookmark. Optional inparams to change the original bookmarks properties, original are kept if left out.

Restore a temporary selection state identified by Id.

Restore a temporary selection state identified by Id.

Restore a temporary selection state identified by Id.

Restore a temporary selection state identified by Id.

Resumes the app as the user left it.

Resumes the app as the user left it.

Resumes the app as the user left it.

Save a copy of an app with a different name.

Can be used to save a session app as an ordinary app.

Save a copy of an app with a different name.

Can be used to save a session app as an ordinary app.

Save a copy of an app with a different name.

Can be used to save a session app as an ordinary app.

Save a copy of an app with a different name.

Can be used to save a session app as an ordinary app.

Saves all objects that were modified in the app.

Saves all objects that were modified in the app.

Saves all objects that were modified in the app.

Scrambles a field so the data is not recognizable. Some properties are retained to help debugging. For example, special characters are not changed, and small numbers are scrambled to another small number.

Scrambles a field so the data is not recognizable. Some properties are retained to help debugging. For example, special characters are not changed, and small numbers are scrambled to another small number.

Scrambles a field so the data is not recognizable. Some properties are retained to help debugging. For example, special characters are not changed, and small numbers are scrambled to another small number.

Returns the search matches for one or more search terms.

The search results depend on the search context.

SearchCombinationOptions

SearchMatchCombinations

Please refer to Engine API reference for table definition.

Returns the search matches for one or more search terms.

The search results depend on the search context.

SearchCombinationOptions

SearchMatchCombinations

Please refer to Engine API reference for table definition.

Returns the search matches for one or more search terms.

The search results depend on the search context.

SearchCombinationOptions

SearchMatchCombinations

Please refer to Engine API reference for table definition.

Returns the search matches for one or more search terms.

The search results depend on the search context.

SearchCombinationOptions

SearchMatchCombinations

Please refer to Engine API reference for table definition.

Returns the generic objects corresponding to one or more search terms. The search is performed within the title, subtitle, footnote and type. In addition, associated dimension values are also searched in. For example, if the country “Japan” is selected and the object contains the dimension City, the object will appear in the results for “Osaka” but not for “Johannesburg”. The generic objects with the following types will never appear in the results: slideitem , sheet , story , slide , masterobject , snapshot , LoadModel , appprops and searchhistory .

Returns the generic objects corresponding to one or more search terms. The search is performed within the title, subtitle, footnote and type. In addition, associated dimension values are also searched in. For example, if the country “Japan” is selected and the object contains the dimension City, the object will appear in the results for “Osaka” but not for “Johannesburg”. The generic objects with the following types will never appear in the results: slideitem , sheet , story , slide , masterobject , snapshot , LoadModel , appprops and searchhistory .

Returns the generic objects corresponding to one or more search terms. The search is performed within the title, subtitle, footnote and type. In addition, associated dimension values are also searched in. For example, if the country “Japan” is selected and the object contains the dimension City, the object will appear in the results for “Osaka” but not for “Johannesburg”. The generic objects with the following types will never appear in the results: slideitem , sheet , story , slide , masterobject , snapshot , LoadModel , appprops and searchhistory .

Returns the generic objects corresponding to one or more search terms. The search is performed within the title, subtitle, footnote and type. In addition, associated dimension values are also searched in. For example, if the country “Japan” is selected and the object contains the dimension City, the object will appear in the results for “Osaka” but not for “Johannesburg”. The generic objects with the following types will never appear in the results: slideitem , sheet , story , slide , masterobject , snapshot , LoadModel , appprops and searchhistory .

Returns the search matches for one or more search terms.

Search results are organized in search groups. The type of search group indicates where the search matches come from (from data for example).

Each search group contains search results that correspond to a combination of search terms.

For example, if the search terms are organic , pasta , and America , the possible combination of search groups are:

* organic

* pasta

* America

* organic, pasta, America

* organic, pasta

* organic, America

* pasta, America

For every search group, there are one or more search group items. Each subgroup item contains results that correspond to an item type (for example a field).

For every search group item, there are one or several search matches. The position of the match in each search result is given.

Returns the search matches for one or more search terms.

Search results are organized in search groups. The type of search group indicates where the search matches come from (from data for example).

Each search group contains search results that correspond to a combination of search terms.

For example, if the search terms are organic , pasta , and America , the possible combination of search groups are:

* organic

* pasta

* America

* organic, pasta, America

* organic, pasta

* organic, America

* pasta, America

For every search group, there are one or more search group items. Each subgroup item contains results that correspond to an item type (for example a field).

For every search group item, there are one or several search matches. The position of the match in each search result is given.

Returns the search matches for one or more search terms.

Search results are organized in search groups. The type of search group indicates where the search matches come from (from data for example).

Each search group contains search results that correspond to a combination of search terms.

For example, if the search terms are organic , pasta , and America , the possible combination of search groups are:

* organic

* pasta

* America

* organic, pasta, America

* organic, pasta

* organic, America

* pasta, America

For every search group, there are one or more search group items. Each subgroup item contains results that correspond to an item type (for example a field).

For every search group item, there are one or several search matches. The position of the match in each search result is given.

Returns the search matches for one or more search terms.

Search results are organized in search groups. The type of search group indicates where the search matches come from (from data for example).

Each search group contains search results that correspond to a combination of search terms.

For example, if the search terms are organic , pasta , and America , the possible combination of search groups are:

* organic

* pasta

* America

* organic, pasta, America

* organic, pasta

* organic, America

* pasta, America

For every search group, there are one or more search group items. Each subgroup item contains results that correspond to an item type (for example a field).

For every search group item, there are one or several search matches. The position of the match in each search result is given.

Returns search terms suggestions.

Returns search terms suggestions.

Returns search terms suggestions.

Returns search terms suggestions.

Selects all search hits for a specified group.

The results depend on the search context.

SearchCombinationOptions.

Selects all search hits for a specified group.

The results depend on the search context.

SearchCombinationOptions.

Selects all search hits for a specified group.

The results depend on the search context.

SearchCombinationOptions.

Sends a generic command to a custom connector.

For more information on the commands that can be sent to a custom connector, see the QVX SDK help.

Sends a generic command to a custom connector.

For more information on the commands that can be sent to a custom connector, see the QVX SDK help.

Sends a generic command to a custom connector.

For more information on the commands that can be sent to a custom connector, see the QVX SDK help.

Sends a generic command to a custom connector.

For more information on the commands that can be sent to a custom connector, see the QVX SDK help.

Sets properties to an app.

Sets properties to an app.

Sets properties to an app.

Set some variables as favorite.

Set some variables as favorite.

Set some variables as favorite.

Limits the number of rows of data to load from a data source.

This method works when reloading in debug mode.

Limits the number of rows of data to load from a data source.

This method works when reloading in debug mode.

Limits the number of rows of data to load from a data source.

This method works when reloading in debug mode.

Sets a list of table states, one for each table.

The following states apply:

* 0 The table is not loosely coupled.

* 1 The table is loosely coupled.

* 2 The table is loosely coupled and cannot be changed to another state using the Qlik Engine API.

Sets a list of table states, one for each table.

The following states apply:

* 0 The table is not loosely coupled.

* 1 The table is loosely coupled.

* 2 The table is loosely coupled and cannot be changed to another state using the Qlik Engine API.

Sets a list of table states, one for each table.

The following states apply:

* 0 The table is not loosely coupled.

* 1 The table is loosely coupled.

* 2 The table is loosely coupled and cannot be changed to another state using the Qlik Engine API.

Sets a list of table states, one for each table.

The following states apply:

* 0 The table is not loosely coupled.

* 1 The table is loosely coupled.

* 2 The table is loosely coupled and cannot be changed to another state using the Qlik Engine API.

Prohibit binary load of this app.

An app with prohibit binary load set cannot be loaded binary. For the setting to have effect a save is required.

Prohibit binary load of this app.

An app with prohibit binary load set cannot be loaded binary. For the setting to have effect a save is required.

Prohibit binary load of this app.

An app with prohibit binary load set cannot be loaded binary. For the setting to have effect a save is required.

Sets values in script.

Sets values in script.

Sets values in script.

Set some breakpoints in the script of an app.

Set some breakpoints in the script of an app.

Set some breakpoints in the script of an app.

Sets the positions of the tables in the data model viewer.

Sets the positions of the tables in the data model viewer.

Sets the positions of the tables in the data model viewer.

Store current selection state temporarily.

Store current selection state temporarily.

Store current selection state temporarily.

Store current selection state temporarily.

Transform current app into an instance of the targeted mode

Transform current app into an instance of the targeted mode

Transform current app into an instance of the targeted mode

Transform current app into an instance of the targeted mode

Undoes the previous operation.

Undoes the previous operation.

Undoes the previous operation.

Undoes the previous operation.

Unlocks all selections in fields for current state.

Unlocks all selections in fields for current state.

Unlocks all selections in fields for current state.

Triggered when a communication error occurs on the websocket used by the app.