Qlik.Engine Namespace

A wrapper that can provide a typed interface for a JToken.

App / Doc class

Token to identify a unique Qlik Sense app

Result of applying GroupState to multiple cyclic groups.

Lists the app objects. Is the layout for AppObjectListDef.

Defines the list of objects in an app.

User created handle to asynchronous method request

A class representing binary data.

Defines the range of the bookmark fields that are returned.

Lists the bookmarks. Is the layout for BookmarkListDef.

Defines the list of bookmarks.

Specification and arguments for an individual operation (request) in a bulk request set.

Response for an individual request in a bulk request set.

Lists the children of a generic object. Is the layout for ChildListDef.

Defines the list of children of a generic object.

What is defined in ChildListDef has an impact on what the GetLayout method returns. See Example for more information.

A class providing a paging interface for a pageable structure.

Lists the dimensions. Is the layout for DimensionListDef.

Defines the lists of dimensions.

The DimensionReference structure points to a GenericDimension.

Wrapper for the AbstractStructure class.

Renders the embedded snapshot in an object.

The following is returned:

* Any dynamic properties defined in the bookmark

* Any properties defined in qEmbeddedSnapshot

Properties

"qEmbeddedSnapshot": {}

Defines the embedded snapshot in a generic object.

Properties

"EmbeddedSnapshotDef": {}

Class for identifying the Qlik Sense Engine version that this build of the .Net SDK is based on.

Obsolete, use qrs API's to fetch extensions.

Obsolete, use qrs API's to fetch extensions.

This class describes all the methods that apply at field level.

The handle member in the JSON request for all methods listed in this section is the handle of the field.

Sets the formatting of a field.

The properties of qFieldAttributes and the formatting mechanism are described below.

Formatting mechanism

The formatting mechanism depends on the type set in qType, as shown below:

Type is DATE, TIME, TIMESTAMP or INTERVAL

The following applies:

* If a format pattern is defined in qFmt , the formatting is as defined in qFmt .

* If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).

* The properties qDec , qThou , qnDec , qUseThou are not used.

Type is INTEGER

The following applies:

* If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).

* If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

Type is REAL

The following applies:

* If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).

* If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.

* If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

* If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

Type is FIX

The following applies:

* If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).

* If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

Type is MONEY

The following applies:

* If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).

* If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

Type is ASCII

No formatting, qFmt is ignored.

Lists the fields present in the data model viewer. Is the layout for FieldListDef.

Defines the fields to show.

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

This class describes all the methods that apply at bookmark level.

The handle member in the JSON request for all methods listed in this section is the handle of the bookmark.

Is the layout for GenericBookmarkProperties.

This class describes all the methods that apply at dimension level.

The handle member in the JSON request for all methods listed in this section is the handle of the dimension.

Is the layout for GenericDimensionProperties.

This class describes all the methods that apply at measure level.

The handle member in the JSON request for all methods listed in this section is the handle of the measure.

Is the layout for GenericMeasureProperties.

This class describes all the methods that apply at generic object level.

The handle member in the JSON request for all methods listed in this section is the handle of the generic object.

Is the layout for GenericObjectProperties.

This class describes all the methods that apply at generic variable level.

The handle member in the JSON request for all methods listed in this section is the handle of the generic variable.

Is the layout for GenericVariableProperties.

Represents the hub of a Qlik engine location and is based on the Global class of the engine API.

Renders the properties of a hypercube. Is the layout for HyperCubeDef.

For more information about the definition of a hypercube, see Generic object.

Defines the properties of a hypercube.

For more information about the definition of a hypercube, see Generic object.

A class providing a paging interface for a hypercube.

Exception indicating that a property in an object instance of a class derived from the AbstractStructure class has been accessed twice with incompatible types. Two types are considered compatible in this context if they are identical, if the type of the second type cast is a base class of the type of the first type class or if they are both subclasses of AbstractStructure.

Contains dynamic JSON data specified by the client.

Contains JSON to be excluded from validation.

Meta data about the selection in a field.

* Key value pairs with metadata. Could be extra information on the nodes or edges.

* Properties contain the node ID as names and the value is an object of type LineageGraphNode.

Renders the properties of a list object. Is the layout for ListObjectDef.

For more information about the definition of a list object, see Generic object.

Defines the properties of a list object.

For more information about the definition of a list object, see Generic object.

A class providing a paging interface for a list object.

Handles the location of the Qlik Sense instance

Some locations need to be accessed in a specific way, the default is using NTML Authentication to connect against a server installation and will not require any specific setup.

An exception indicating an error condition relating to master objects.

Lists the measures. Is the layout for MeasureListDef.

Defines the list of measures.

Lists the media files. Is the layout for MediaListDef.

Defines the list of media files.

Properties

"qMediaListDef": {}

qMediaListDef has an empty structure. No properties need to be set.

The Exception thrown when a method has gone wrong on the server during execution.

Qlik Sense error

Qlik Sense Desktop

In Qlik Sense Desktop, this structure can contain dynamic properties.

Qlik Sense Enterprise

In Qlik Sense Enterprise, only a few dynamic properties at the app level are persisted.

The persisted dynamic properties are the following:

* modifiedDate

* published

* publishTime

* privileges

* description

* dynamicColor

Qlik Sense Desktop

In Qlik Sense Desktop, this structure can contain dynamic properties.

Qlik Sense Enterprise

In Qlik Sense Enterprise, only a few dynamic properties at the app level are persisted.

The persisted dynamic properties are the following:

* modifiedDate

* published

* publishTime

* privileges

* description

* dynamicColor

Layout for NxAttrDimDef.

Layout for NxAttrDimDef.

Layout for NxAttrExprDef.

NxDerivedFieldsdata

Please refer to Engine API reference for table definition.

Information about the library measure. Is the layout for NxLibraryMeasureDef.

Layout for NxInlineMeasureDef.

Layout for NxMetaDef.

Used to collect meta data.

Properties

Semantic type with an empty structure.

Defines an area of the tree to be fetched.

Specifies all the paging filters needed to define the tree to be fetched.

Represents a dimension in the tree.

Represents a measure.

Information about the calculated trendline.

Trendline input definition

Used for paging when getting data from the engine.

Instances of this class represent objects known to the Qlik Sense Engine that follow the properties/layout pattern.

Class for handling connections to Qlik Cloud Services.

Instances of this class represent objects known to the Qlik Sense Engine.

Contains the actual server name for a component

Indicates which selections are currently applied. It gives the current selections. Is the layout for SelectionObjectDef.

To display the current selections.

Can be added to any generic object but is particularly meaningful when using session objects to monitor an app.

Properties

"qSelectionObjectDef": {}

Contains Information to attach to a specific Qlik engine session When connecting to a Qlik Sense app you can work with sessions. Sessions specify who should see changes in an app, and are based on combining userId and session key.

Class for encapsulating the token string used to identify a Qlik Cloud Services session.

Expression class that evaluates to a string

Properties

Abbreviated syntax:

"qStringExpression":"=<expression>"

Extended object syntax:

"qStringExpression":{"qExpr":"=<expression>"}

Where:

* < expression > is a string

The result of the evaluation of the expression can be of any type, as it is returned as a JSON (quoted) string.

Wrapper class for a StringExpression object.

A class representing the diff between two abstract structures for a particular property path.

Exception indicating that a layout has been accessed while suspended.

Renders the properties of a TreeData object. Is the layout for TreeDataDef.

For more information about the definition of TreeData, see Generic object.

Defines the properties of a TreeData object.

For more information about the definition of a TreeData object, see Generic object.

Displays information about the number of possible undos and redos. Is the layout for UndoInfoDef.

Defines if an object should contain information on the number of possible undo and redo.

Properties

"qUndoInfoDef": {}

The numbers of undos and redos are empty when an object is created. The number of possible undos is increased every time an action (for example, create a child, set some properties) on the object is performed. The number of possible redos is increased every time an undo action is performed.

Exception thrown when the system was unable to bind an uri to local qlik sense instance automatically

Describes that a class is static data only. When its parent object updates, this object will no longer be valid.

Expression class that evaluates to a value

Properties

Abbreviated syntax:

"qValueExpression":"=<expression>"

Extended object syntax:

"qValueExpression":{"qExpr":"=<expression>"}

Where:

* < expression > is a string.

The expression is evaluated as a numeric.

Wrapper class for a ValueExpression object.

This class describes all the methods that apply at variable level.

The handle member in the JSON request for all methods listed in this section is the handle of the variable.

Lists the variables in an app. Is the layout for VariableListDef.

Defines the list of variables in an app.

A wrapper that can provide a typed interface for a JToken.

App / Doc class

Token to identify a unique Qlik Sense app

Result of applying GroupState to multiple cyclic groups.

Lists the app objects. Is the layout for AppObjectListDef.

Defines the list of objects in an app.

A class representing binary data.

Defines the range of the bookmark fields that are returned.

Lists the bookmarks. Is the layout for BookmarkListDef.

Defines the list of bookmarks.

Specification and arguments for an individual operation (request) in a bulk request set.

Response for an individual request in a bulk request set.

Interface used by classes that supports change notification.

Lists the children of a generic object. Is the layout for ChildListDef.

Defines the list of children of a generic object.

What is defined in ChildListDef has an impact on what the GetLayout method returns. See Example for more information.

Lists the dimensions. Is the layout for DimensionListDef.

Defines the lists of dimensions.

The DimensionReference structure points to a GenericDimension.

Renders the embedded snapshot in an object.

The following is returned:

* Any dynamic properties defined in the bookmark

* Any properties defined in qEmbeddedSnapshot

Properties

"qEmbeddedSnapshot": {}

Defines the embedded snapshot in a generic object.

Properties

"EmbeddedSnapshotDef": {}

Obsolete, use qrs API's to fetch extensions.

Obsolete, use qrs API's to fetch extensions.

This class describes all the methods that apply at field level.

The handle member in the JSON request for all methods listed in this section is the handle of the field.

Sets the formatting of a field.

The properties of qFieldAttributes and the formatting mechanism are described below.

Formatting mechanism

The formatting mechanism depends on the type set in qType, as shown below:

Type is DATE, TIME, TIMESTAMP or INTERVAL

The following applies:

* If a format pattern is defined in qFmt , the formatting is as defined in qFmt .

* If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).

* The properties qDec , qThou , qnDec , qUseThou are not used.

Type is INTEGER

The following applies:

* If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).

* If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

Type is REAL

The following applies:

* If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).

* If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.

* If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

* If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

Type is FIX

The following applies:

* If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).

* If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

Type is MONEY

The following applies:

* If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).

* If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

Type is ASCII

No formatting, qFmt is ignored.

Lists the fields present in the data model viewer. Is the layout for FieldListDef.

Defines the fields to show.

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

This class describes all the methods that apply at bookmark level.

The handle member in the JSON request for all methods listed in this section is the handle of the bookmark.

Is the layout for GenericBookmarkProperties.

This class describes all the methods that apply at dimension level.

The handle member in the JSON request for all methods listed in this section is the handle of the dimension.

Is the layout for GenericDimensionProperties.

This class describes all the methods that apply at measure level.

The handle member in the JSON request for all methods listed in this section is the handle of the measure.

Is the layout for GenericMeasureProperties.

This class describes all the methods that apply at generic object level.

The handle member in the JSON request for all methods listed in this section is the handle of the generic object.

Is the layout for GenericObjectProperties.

This class describes all the methods that apply at generic variable level.

The handle member in the JSON request for all methods listed in this section is the handle of the generic variable.

Is the layout for GenericVariableProperties.

Renders the properties of a hypercube. Is the layout for HyperCubeDef.

For more information about the definition of a hypercube, see Generic object.

Defines the properties of a hypercube.

For more information about the definition of a hypercube, see Generic object.

Contains dynamic JSON data specified by the client.

Contains JSON to be excluded from validation.

Meta data about the selection in a field.

* Key value pairs with metadata. Could be extra information on the nodes or edges.

* Properties contain the node ID as names and the value is an object of type LineageGraphNode.

Renders the properties of a list object. Is the layout for ListObjectDef.

For more information about the definition of a list object, see Generic object.

Defines the properties of a list object.

For more information about the definition of a list object, see Generic object.

Interface for Qlik Sense instance location handling

Lists the measures. Is the layout for MeasureListDef.

Defines the list of measures.

Lists the media files. Is the layout for MediaListDef.

Defines the list of media files.

Properties

"qMediaListDef": {}

qMediaListDef has an empty structure. No properties need to be set.

Qlik Sense Desktop

In Qlik Sense Desktop, this structure can contain dynamic properties.

Qlik Sense Enterprise

In Qlik Sense Enterprise, only a few dynamic properties at the app level are persisted.

The persisted dynamic properties are the following:

* modifiedDate

* published

* publishTime

* privileges

* description

* dynamicColor

Qlik Sense Desktop

In Qlik Sense Desktop, this structure can contain dynamic properties.

Qlik Sense Enterprise

In Qlik Sense Enterprise, only a few dynamic properties at the app level are persisted.

The persisted dynamic properties are the following:

* modifiedDate

* published

* publishTime

* privileges

* description

* dynamicColor

Layout for NxAttrDimDef.

Layout for NxAttrDimDef.

Layout for NxAttrExprDef.

NxDerivedFieldsdata

Please refer to Engine API reference for table definition.

Information about the library measure. Is the layout for NxLibraryMeasureDef.

Layout for NxInlineMeasureDef.

Layout for NxMetaDef.

Used to collect meta data.

Properties

Semantic type with an empty structure.

Defines an area of the tree to be fetched.

Specifies all the paging filters needed to define the tree to be fetched.

Represents a dimension in the tree.

Represents a measure.

Information about the calculated trendline.

Trendline input definition

Interface for handling connections to Qlik Cloud Services.

Indicates which selections are currently applied. It gives the current selections. Is the layout for SelectionObjectDef.

To display the current selections.

Can be added to any generic object but is particularly meaningful when using session objects to monitor an app.

Properties

"qSelectionObjectDef": {}

Contains Information to attach to a specific qlik engine session When connecting to a Qlik Sense app you can work with sessions. Sessions specify who should see changes in an app, and are based on combining userId and session key.

Properties

Abbreviated syntax:

"qStringExpression":"=<expression>"

Extended object syntax:

"qStringExpression":{"qExpr":"=<expression>"}

Where:

* < expression > is a string

The result of the evaluation of the expression can be of any type, as it is returned as a JSON (quoted) string.

A class representing the diff between two abstract structures for a particular property path.

Interface for tagging an object as transient. Typically used to ensure that session objects are automatically destroyed during dispose.

Renders the properties of a TreeData object. Is the layout for TreeDataDef.

For more information about the definition of TreeData, see Generic object.

Defines the properties of a TreeData object.

For more information about the definition of a TreeData object, see Generic object.

Displays information about the number of possible undos and redos. Is the layout for UndoInfoDef.

Defines if an object should contain information on the number of possible undo and redo.

Properties

"qUndoInfoDef": {}

The numbers of undos and redos are empty when an object is created. The number of possible undos is increased every time an action (for example, create a child, set some properties) on the object is performed. The number of possible redos is increased every time an undo action is performed.

Properties

Abbreviated syntax:

"qValueExpression":"=<expression>"

Extended object syntax:

"qValueExpression":{"qExpr":"=<expression>"}

Where:

* < expression > is a string.

The expression is evaluated as a numeric.

This class describes all the methods that apply at variable level.

The handle member in the JSON request for all methods listed in this section is the handle of the variable.

Lists the variables in an app. Is the layout for VariableListDef.

Defines the list of variables in an app.

Constants used in the DrawText (User32) API

Session type

Enumeration value indicating the type of diff.