Lists the app objects. Is the layout for AppObjectListDef.

Defines the list of objects in an app.

Defines the range of the bookmark fields that are returned.

Lists the bookmarks. Is the layout for BookmarkListDef.

Defines the list of bookmarks.

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.

Parameters for a reload.

The result and path to script log for a reload.

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.

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

Is the layout for GenericBookmarkProperties.

Is the layout for GenericDimensionProperties.

Is the layout for GenericMeasureProperties.

Is the layout for GenericObjectProperties.

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 JSON to be excluded from validation.

Meta data about the selection in a field.

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.

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

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.

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”: {}

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.

Renders the properties of a TreeData object. Is the layout for TreeDataDef.
For more information about the definition of TreeData, see Generic object.
To retrieve data from the TreeData object, use the method called GetHyperCubeTreeData.

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.

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

Defines the list of variables in an app.

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.

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.

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.

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.

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.

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.

Mixin

Generated Interface

Defines Options for the Protocoll

RequestInterceptors

ResponseInterceptors

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.