QIX
The JSON-RPC API over websocket that enables you to interact with the Qlik Associative Engine.
The QIX API is the primary API used for working with Qlik apps. It's based on the WebSocket protocol and requires some specific parameters to work correctly as seen below.
WebSockets
When you want to use the API, any websocket client implementation that follows the RFC specification should be supported. The URL format is:
wss://your-tenant.us.qlikcloud.com/app/<app id>
Browser example:
const websocket = new WebSocket('wss://your-tenant.us.qlikcloud.com/app/123e4567-e89b-12d3-a456-426655440000');
Headers
In a non-browser environment, most websocket client implementations support to add headers.
Use header Authorization: Bearer <token>
with
API key for authentication.
Session sharing
When using the QIX API you build up a state in what's called a session. A session is based on a tenant, a user, and the app. When opening a new websocket you'd either get a new unique session, or get attached to an existing session. When sharing a session, the state (like selections), is shared between all websocket connections.
The conditions for sharing a session is:
- The websocket URL needs to be identical (tenant URL and app id)
- The user needs to be the same:
- in a browser environment the same user needs to be signed in
- in a non-browser environment an API key from the same user and tenant needs to be used
JSON-RPC protocol
The QIX API leverages the JSON-RPC protocol. It implements a superset of this specification. All requests sent from the client should contain the following properties:
{
// Protocol descriptor:
"jsonrpc": "2.0",
// Session-unique numeric id, referred to in the response
// to connect the request and response:
"id": 6,
// The handle for the object to interact with:
"handle": 2,
// The object type of the handle above decides
// which API methods you may invoke:
"method": "ApiMethodName",
// Parameters for the invoked API method:
"params": {}
}
Request and response
Here is an example request/response pair. Note that there is only one static
handle in the QIX API, and that's -1
. This handle refers to the Global
API.
In this example request, an app is opened using OpenDoc. If successful, the response contains a reference to the app handle, which can be used to do further requests towards the Doc (app) API, and so forth.
{
"jsonrpc": "2.0",
"id": 1,
"handle": -1,
"method": "OpenDoc",
"params": {
"qDocName": "<app id>"
}
}
If that app exist, the response would look similar to this:
{
"jsonrpc": "2.0",
"id": 1,
"result": {
"qReturn": {
"qType": "Doc",
"qHandle": 1,
"qGenericId": "<app id>"
}
},
"change": [1]
}
Note that qHandle
contains the handle that might be used to make additional
requests to invoke API methods towards the app. A property called change
is also received on the response, an array that can be sent by QIX
Engine on any responses and contains all open handles in your session
that may have been invalidated and you should refetch data to ensure
your application in a valid state.
Session apps
Session apps are non-persisted Qlik Sense apps created on-the-fly in server memory by the Qlik Associative Engine. You have to define a load script and trigger a data reload before any data model is accessible for each user session. Similarly, if you create a session app from an existing app, you have to trigger a reload after retrieving objects from the template app.
Session apps are attached to the active Qlik Associative Engine session. When a session ends, for example, by the user logging out, the session app is terminated and all related resources are released from server memory. Standard Qlik security rules ensure that only authenticated users can access data and visualizations from a session app.
WebSocket URL for session apps
The WebSocket URL for creating a session app has the following format:
wss://my-tenant.us.qlikcloud.com/app/SessionApp_{appId}
You must append a unique app ID to SessionApp_
in the path. The app ID can
be a code-generated random number.
To create a session app from an app, you must add the template app ID as a query parameter to the URL:
wss://my-tenant.us.qlikcloud.com/app/SessionApp_{appId}?from={templateAppId}
Error Handling
When something happens unexpectedly, the WebSocket may be closed with an error code and message. The error code will be a 4-digit number and the message may or may not be empty. The code below should be used for monitoring this.
ws.on("close", (code, message) => {
console.log(code);
console.log(String(message));
});
4204
{"code":"QEP-104","traceId":"491a33e544de8dda40a9fc9b0cb53216"}
The following is a list of error codes and their causes:
- 4202 - the WebSocket request appears to be malformed
- 4203 - the request could not be fulfilled because of a permissions issue
- 4204 - the request failed because something could not be found, this may be because the app id in the URL is wrong or the app has been deleted
- 4205 - the request could not be fulfilled because the system is busy, consider sending the request again later
- 4230 - the request could not be fulfilled because there are too many open apps in your organization
- 4240 - the request could not be fulfilled because there are no available engines
API references
For the API references, see the different classes listed in the left-side menu.
schemas
schemasAlfaNumString
objectProperties
qString optional string | Calculated value. |
qIsNum optional boolean | Is set to true if the value is a numeric. |
schemasAlternateStateData
objectProperties
qStateName optional string | Name of the alternate state. Default is current selections: $ |
qFieldItems optional | List of the selections. |
schemasAppEntry
objectProperties
qID optional string | Identifier of the app. |
qTitle optional string | Title of the app. |
qPath optional string | Path of the app. |
qLastReloadTime optional string | Last reload time of the app. |
qReadOnly optional boolean | Is set to true if the app is read-only. |
qMeta optional | Layout for NxMetaDef. |
qThumbnail optional | In addition, this structure can return dynamic properties. |
qFileSize optional integer<int64> | No description |
qHasSectionAccess optional boolean | If true the app has section access configured. |
schemasAppObjectList
objectLists the app objects. Is the layout for AppObjectListDef.
Properties
qItems optional | Information about the list of dimensions. |
schemasAppObjectListDef
objectDefines the list of objects in an app.
Properties
qType optional string | Type of the app list. |
qData optional | Contains dynamic JSON data specified by the client. |
schemasAppScript
objectProperties
qScript optional string | Script text. |
qMeta optional | Layout for NxMetaDef. |
qIsLocked optional boolean | True if user is temporarily locked from modifying the script. Meta contains the ID of the last modifier. Only applicable to QCS. |
schemasAppScriptMeta
objectProperties
qMeta optional | Layout for NxMetaDef. |
qIsLocked optional boolean | True if user is temporarily locked from modifying the script. Meta contains the ID of the last modifier. Only applicable to QCS. |
schemasArrayOfNxValuePoint
Array<NxPivotValuePoint>schemasAssociationScore
objectProperties
qFieldPairName optional string | Pair of fields. < FieldName1> / < FieldName2> Where: < FieldName1 > is a field in the table 1 (defined in qTable1 ) < FieldName2 > is a field in the table 2 (defined in qTable2 ) If the field is a synthetic key, the name of the field is preceded by [Synthetic key]: . |
qScoreSummary optional integer<int32> | Flag used to interpret calculated scores. One of the following values or sum of values that apply:
Example: The number of rows of the field FieldName1 is zero, and the number of distinct values of the field FieldName2 is zero, then qScoreSummary is -18. |
qField1Scores optional | No description |
qField2Scores optional | No description |
schemasBNFDef
objectProperties
qBnf optional Array<integer<int32>> | Array of token references that all together build up the definition of the current token. Generally, if the array is not empty, the definition is a BNF rule (qIsBnfRule is set to true). However, some BNF rules do have an empty array (qIsBnfRule is set to true, but qBnf is empty). |
qNbr optional integer<int32> | Number of the current token definition. |
qPNbr optional integer<int32> | Number of the parent rule definition. |
qHelpId optional integer<int32> | Reference identifier to a function described in the documentation. The identifier is stored in the definition of the token containing the function name. Is not used in Qlik Sense. |
qName optional string | Token name. One of:
|
qStr optional string | Literal string of the token. Examples: 'Round' and '('. |
qIsBnfRule optional, default=false boolean | If set to true, a list of related rule tokens is assigned to qBnf . This parameter is optional. The default value is false. |
qScriptStatement optional, default=false boolean | If set to true, the definition specifies a script statement. This parameter is optional. The default value is false. |
qControlStatement optional, default=false boolean | If set to true, the definition specifies a control statement. This parameter is optional. The default value is false. |
qBnfLiteral optional, default=false boolean | If set to true, the definition specifies a literal token. This parameter is optional. The default value is false. |
qQvFunc optional, default=false boolean | If set to true, the definition is related to a Qlik Sense function. It cannot be an aggregation function. This parameter is optional. The default value is false. |
qAggrFunc optional, default=false boolean | If set to true, the definition is related to an aggregation function. This parameter is optional. The default value is false. |
qFG optional | No description |
qFieldFlag optional, default=false boolean | If set to true, the definition is related to a field. This parameter is optional. The default value is false. |
qMT optional | No description |
qDepr optional, default=false boolean | Indicates whether a script statement, a chart or a script function is deprecated (not recommended for use). If set to true, the script statement or the function is not recommended for use in Qlik Sense. This parameter is optional. The default value is false. |
qFGList optional Array<FunctionGroup> | List of groups the function belongs to. |
schemasBNFDefMetaType
stringoneOf
N optional | NOT_META |
D optional | META_DOC_NAME |
R optional | META_RET_TYPE |
V optional | META_DEFAULT_VALUE |
schemasBNFType
stringoneOf
S optional | SCRIPT_TEXT_SCRIPT |
E optional | SCRIPT_TEXT_EXPRESSION |
schemasBlob
Array<integer<byte>>schemasBookmark
objectProperties
qId optional string | No description |
qName optional string | No description |
qUtcModifyTime optional number<double> | No description |
qUtcRecallTime optional number<double> | No description |
qRecallCount optional integer<int32> | No description |
qApplyAdditive optional boolean | No description |
qFieldItems optional | No description |
qVariableItems optional | No description |
qSheetId optional string | No description |
qObjects optional | No description |
qApplyLayoutState optional, default=false boolean | No description |
qShowPopupInfo optional, default=false boolean | No description |
qInfoText optional string | No description |
qOwner optional string | No description |
qGroups optional | No description |
qShow optional | No description |
qApplyInputFieldValues optional, default=true boolean | No description |
qInputFieldItems optional | No description |
qObjectsLayout optional | No description |
qIncludeSelectionState optional, default=true boolean | No description |
qIncludeScrollPosition optional boolean | No description |
qAlternateStateData optional | No description |
qForAnnotations optional boolean | No description |
qIncludeAllVariables optional, default=false boolean | No description |
schemasBookmarkApplyAndVerifyResult
objectProperties
qApplySuccess optional boolean | Apply successfully or not * |
qWarnings optional | Field values verfication result * |
schemasBookmarkFieldItem
objectProperties
qDef optional | No description |
qLocked optional boolean | Indicates if the field is locked. Default is false. |
qSelectInfo optional | No description |
qValues optional | No description |
qExcludedValues optional | List of excluded values. Either the list of selected values or the list of excluded values is displayed. |
qAndMode optional boolean | If set to true, selections within a list object are made in AND mode; If you have a list object that lists all customers, by selecting Customer 1 and Customer 2 while in and-mode, all records that are associated with Customer 1 and Customer 2 are selected. The default value is false; selections within a list object are made in OR mode. If you have a list object that lists all customers, by selecting Customer 1 and Customer 2 while in or-mode, all records that are associated with either Customer 1 or Customer 2 are selected. This parameter is not returned if set to false. |
qOneAndOnlyOne optional boolean | If set to true, the field has always one selection (not 0 and not more than 1). If another value is selected, the previous one is unselected. The default value is false. This parameter is not returned if set to false. |
schemasBookmarkFieldPage
objectDefines the range of the bookmark fields that are returned.
Properties
qStartIndex optional integer<int32> | The start value of the range. |
qEndIndex optional integer<int32> | The end value of the range. |
schemasBookmarkFieldVerifyResultState
stringoneOf
NOT_VERIFIED optional | No description |
FIELD_VALUE_MATCH_ALL optional | No description |
FIELD_MISSING optional | No description |
FIELD_VALUE_MISSING optional | No description |
STATE_MISSING optional | No description |
schemasBookmarkFieldVerifyWarning
objectProperties
qState optional string | Alternate State * |
qField optional string | Field Name * |
qVerifyResult optional | No description |
qMissingValues optional Array<string> | No description |
schemasBookmarkList
objectLists the bookmarks. Is the layout for BookmarkListDef.
Properties
qItems optional | Information about the list of bookmarks. |
schemasBookmarkListDef
objectDefines the list of bookmarks.
Properties
qType optional string | Type of the list. |
qData optional | Contains dynamic JSON data specified by the client. |
qIncludePatches optional boolean | Include the bookmark patches. Patches can be very large and may make the list result unmanageable. |
schemasBookmarkVariableItem
objectProperties
qName optional string | Name of the variable. |
qValue optional | No description |
qDefinition optional string | The Reporting mode definition of the variable. |
schemasCalendarStrings
objectProperties
qDayNames optional Array<string> | List of short day names. |
qMonthNames optional Array<string> | List of short month names. |
qLongDayNames optional Array<string> | List of long day names. |
qLongMonthNames optional Array<string> | List of long month names. |
schemasCharEncodingType
stringoneOf
Utf8 optional | CHAR_ENCODING_UTF8 |
Utf16 optional | CHAR_ENCODING_UTF16 |
schemasCharRange
objectProperties
qCharPos optional integer<int32> | Position of the first search occurrence. |
qCharCount optional integer<int32> | Number of occurrences found. |
schemasChildList
objectLists the children of a generic object. Is the layout for ChildListDef.
Properties
qItems optional | Information about the items in the app object. |
schemasChildListDef
objectDefines 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.
Properties
qData optional | Contains dynamic JSON data specified by the client. |
schemasCodePage
objectProperties
qNumber optional integer<int32> | Number of the code page. |
qName optional string | Name of the code page. |
qDescription optional string | Description of the code page. |
schemasCondDef
objectProperties
qAlways optional, default=true boolean | No description |
qExpression optional | No description |
schemasConnection
objectProperties
qId optional string | Identifier of the connection. Is generated by the engine and is unique. |
qName optional string | Name of the connection. This parameter is mandatory and must be set when creating or modifying a connection. |
qConnectionString optional string | One of:
Connection string. This parameter is mandatory and must be set when creating or modifying a connection. |
qType optional string | One of:
Type of the connection. This parameter is mandatory and must be set when creating or modifying a connection. For ODBC, OLEDB and custom connections, the engine checks that the connection type matches the connection string. The type is not case sensitive. |
qUserName optional string | Name of the user who creates the connection. This parameter is optional; it is only used for OLEDB, ODBC and CUSTOM connections. A call to GetConnection Method does not return the user name. |
qPassword optional string | Password of the user who creates the connection. This parameter is optional; it is only used for OLEDB, ODBC and CUSTOM connections. A call to GetConnection Method does not return the password. |
qModifiedDate optional string | Is generated by the engine. Creation date of the connection or last modification date of the connection. |
qMeta optional | Layout for NxMetaDef. |
qLogOn optional | No description |
schemasContentLibraryList
objectProperties
qItems optional | Information about the content library. |
schemasContentLibraryListItem
objectProperties
qName optional string | Name of the library. |
qAppSpecific optional boolean | Is set to true if the library is specific to the app (not a global content library). |
qMeta optional | Layout for NxMetaDef. |
schemasCustomConnector
objectProperties
qProvider optional string | Name of the custom connector file. |
qParent optional string | Name of the parent folder that contains the custom connector file. |
qDisplayName optional string | Name of the custom connector as displayed in the Qlik interface. |
qMachineMode optional | No description |
qSupportFileStreaming optional boolean | No description |
schemasDataField
objectProperties
qName optional string | Name of the field. |
qIsKey optional, default=false boolean | Is set to true if the field is a primary key. |
qOriginalFieldName optional string | Is shown for fixed records. qOriginalFieldName and qName are identical if no field names are used in the file. qOriginalFieldName differs from qName if embedded file names are used in the file. |
schemasDataRecord
objectProperties
qValues optional Array<string> | List of values inside the table. The first values (in result/qPreview/0/qValues ) correspond to the field names in the table. The following values (from result/qPreview/1/qValues ) are the values of the fields in the table. |
schemasDataTable
objectProperties
qName optional string | Name of the table. |
qType optional string | Type of the table. For example: Table or View. |
schemasDataTableEx
objectProperties
qName optional string | Name of the table. |
qFields optional | List of the fields in the table. |
qFormatSpec optional string | List of format specification items, within brackets. Examples of specification items:
|
schemasDatabase
objectProperties
qName optional string | Name of the database. |
qIsDefault optional boolean | Is set to true if the database is set by default. |
schemasDatabaseInfo
objectProperties
qDBMSName optional string | Name of the product accessed by the provider. |
qDBUsage optional boolean | If set to true, it means that the data source contains some databases. |
qOwnerUsage optional boolean | If set to true, it means that the data source contains some owners. |
qDBSeparator optional string | Character string used after the database name. Example with separator " . ": FROM LinkedTablesData.dbo.Months Where:
|
qOwnerSeparator optional string | Character string used after the owner name. Example with separator " . ": FROM LinkedTablesData.dbo.Months Where:
|
qDBFirst optional boolean | If set to true, it means that the database is displayed first, before the owners and tables. |
qQuotePreffix optional string | Prefix used with field, database or owner names that contain special characters or keywords. |
qQuoteSuffix optional string | Suffix used with field, database or owner names that contain special characters or keywords. |
qSpecialChars optional string | List of the special characters. |
qDefaultDatabase optional string | Name of the default database. |
qKeywords optional Array<string> | List of the script keywords. |
schemasDatabaseOwner
objectProperties
qName optional string | Name of the owner. |
schemasDelimiterInfo
objectProperties
qName optional string | Name of the delimiter. Example: "Tab_DELIMITER" |
qScriptCode optional string | Representation of the delimiter value that is used in the script. Example: "'\t'" |
qNumber optional integer<int32> | Delimiter character number used by the engine to determine how to separate the values. |
qIsMultiple optional boolean | Is set to true if multiple spaces are used to separate the values. |
schemasDerivedFieldsInTableData
objectProperties
qDefinitionName optional string | Name of the derived definition. |
qTags optional Array<string> | List of tags. |
qActive optional boolean | Is set to true is the derived field is in use. |
schemasDimensionList
objectLists the dimensions. Is the layout for DimensionListDef.
Properties
qItems optional | Information about the list of dimensions. |
schemasDimensionListDef
objectDefines the lists of dimensions.
Properties
qType optional string | Type of the list. |
qData optional | Contains dynamic JSON data specified by the client. |
schemasDoReloadExParams
objectParameters for a reload.
Properties
qMode optional, default=0 integer<int32> | 0: for default mode. 1: for ABEND; the reload of the script ends if an error occurs. 2: for ignore; the reload of the script continues even if an error is detected in the script. |
qPartial optional, default=false boolean | Set to true for partial reload. The default value is false. |
qDebug optional, default=false boolean | Set to true to debug reload. The default value is false. |
qReloadId optional string | Optional reload ID. ID will be automatically generated if not set. |
schemasDoReloadExResult
objectThe result and path to script log for a reload.
Properties
qSuccess optional boolean | The reload is successful if True. |
qScriptLogFile optional string | Path to the script log file. |
qEndedWithMemoryConstraint optional boolean | true if memory limits were exhausted during reload. |
schemasDocListEntry
objectProperties
qDocName optional string | Name of the app. |
qConnectedUsers optional integer<int32> | Not used. |
qFileTime optional number<double> | Last modified time stamp of the app. This property is used only with Qlik Sense Desktop. It is set to 0 for Qlik Sense Enterprise. |
qFileSize optional number<double> | Size of remote app. This property is used only with Qlik Sense Desktop. It is set to 0 for Qlik Sense Enterprise. |
qDocId optional string | Identifier of the app.
|
qMeta optional | Layout for NxMetaDef. |
qLastReloadTime optional string | Last reload time of the app. |
qReadOnly optional boolean | If set to true, the app is read-only. |
qTitle optional string | Title of the app. |
qThumbnail optional | In addition, this structure can return dynamic properties. |
qHasSectionAccess optional boolean | If true the app has section access configured. |
qIsDirectQueryMode optional boolean | Is the app a Direct Query app? |
schemasDriveInfo
objectProperties
qDrive optional string | Value of the drive. Examples: C:\, E:\\ |
qType optional string | Type of the drive. Fixed means physical drive. |
qName optional string | Name of the drive. |
qTypeIdentifier optional | No description |
qUnnamedDrive optional boolean | No description |
schemasDriveType
stringoneOf
REMOVABLE optional | No description |
FIXED optional | No description |
NETWORK optional | No description |
CD_ROM optional | No description |
RAM optional | No description |
UNKNOWN_TYPE optional | No description |
schemasEditorBreakpoint
objectProperties
qbufferName optional string | Name of the breakpoint. |
qlineIx optional integer<int32> | Line number in the script where the breakpoint is set. |
qEnabled optional boolean | If set to true then the breakpoint is enabled (in use). |
schemasEmbeddedSnapshot
objectRenders the embedded snapshot in an object. The following is returned:
- Any dynamic properties defined in the bookmark
- Any properties defined in qEmbeddedSnapshot
Properties
"qEmbeddedSnapshot": {}
schemasEmbeddedSnapshotDef
objectDefines the embedded snapshot in a generic object.
Properties
"EmbeddedSnapshotDef": {}
schemasErrorData
objectProperties
qErrorString optional string | Detailed information about the error message. |
qLineEnd optional string | Line termination characters. |
qLine optional string | Script statement where the error occurs. |
qErrorDataCode optional | No description |
qMessage optional | No description |
schemasErrorDataCode
stringoneOf
EDC_ERROR optional | No description |
EDC_WARNING optional | No description |
EDC_CIRCULAR_REFERENCE optional | No description |
schemasExpansionData
objectProperties
qExcludeList optional boolean | No description |
qPos optional | No description |
schemasExtendedLayoutBookmarkData
objectProperties
qId optional string | No description |
qActive optional boolean | No description |
qShowMode optional integer<byte> | No description |
qScrollPos optional | No description |
qExpansionInfo optional | No description |
qLeftCollapsed optional boolean | No description |
qTopCollapsed optional boolean | No description |
qSortData optional | No description |
qDimensionGroupPos optional | No description |
qExpressionGroupPos optional | No description |
qUseGraphMode optional boolean | No description |
qGraphMode optional | No description |
qActiveContainerChildObjectId optional string | No description |
qExtendedPivotState optional | No description |
schemasExtendedPivotStateData
objectProperties
qExpressionPosition optional integer<byte> | No description |
qNumberOfLeftDimensions optional integer<byte> | No description |
qDimensionNames optional Array<string> | No description |
qEnableConditions optional Array<string> | No description |
schemasExtensionList
objectObsolete, use qrs API's to fetch extensions.
Properties
qItems optional Array<string> | No description |
schemasExtensionListDef
objectObsolete, use qrs API's to fetch extensions.
schemasFieldAttrType
stringoneOf
U optional | UNKNOWN |
A optional | ASCII |
I optional | INTEGER |
R optional | REAL |
F optional | FIX |
M optional | MONEY |
D optional | DATE |
T optional | TIME |
TS optional | TIMESTAMP |
IV optional | INTERVAL |
schemasFieldAttributes
objectSets 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.
Properties
qType optional | No description |
qnDec optional, default=10 integer<int32> | Number of decimals. Default is 10. |
qUseThou optional, default=0 integer<int32> | Defines whether or not a thousands separator must be used. Default is 0. |
qFmt optional string | Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date. |
qDec optional string | Defines the decimal separator. Example: . |
qThou optional string | Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: , |
schemasFieldDefEx
objectProperties
qName optional string | Name of the field. |
qType optional | No description |
schemasFieldDescription
objectProperties
qInternalNumber optional integer<int32> | Internal number of the field. |
qName optional string | Name of the field. |
qSrcTables optional Array<string> | List of table names. |
qIsSystem optional boolean | If set to true, it means that the field is a system field. The default value is false. |
qIsHidden optional boolean | If set to true, it means that the field is hidden. The default value is false. |
qIsSemantic optional boolean | If set to true, it means that the field is a semantic. The default value is false. |
qDistinctOnly optional boolean | If set to true, only distinct field values are shown. The default value is false. |
qCardinal optional integer<int32> | Number of distinct field values. |
qTotalCount optional integer<int64> | Total number of field values. |
qPossibleCount_OBSOLETE optional integer<int32> | No description |
qHasInfo_OBSOLETE optional boolean | No description |
qIsLocked optional boolean | If set to true, it means that the field is locked. The default value is false. |
qAlwaysOneSelected optional boolean | If set to true, it means that the field has one and only one selection (not 0 and not more than 1). If this property is set to true, the field cannot be cleared anymore and no more selections can be performed in that field. The default value is false. |
qAndMode optional boolean | If set to true a logical AND (instead of a logical OR) is used when making selections in a field. The default value is false. |
qIsNumeric optional boolean | Is set to true if the value is a numeric. The default value is false. |
qComment optional string | Field comment. |
qTags optional Array<string> | Gives information on a field. For example, it can return the type of the field. Examples: key, text, ASCII. |
qIsDefinitionOnly optional boolean | If set to true, it means that the field is a field on the fly. The default value is false. |
qByteSize optional integer<int64> | Static RAM memory used in bytes. |
schemasFieldInTableData
objectProperties
qName optional string | Name of the field. |
qOriginalFields optional Array<string> | Is shown for fixed records. qOriginalFieldName and qName are identical if no field names are used in the file. qOriginalFieldName differs from qName if embedded file names are used in the file. |
qPresent optional boolean | No description |
qHasNull optional boolean | This property is set to true if the field contains some Null values. |
qHasWild optional boolean | No description |
qHasDuplicates optional boolean | This property is set to true if the field contains some duplicate values. |
qIsSynthetic optional boolean | This property is set to true if the field contains a synthetic key. |
qInformationDensity optional number<double> | Number of records that have values (for example, not NULL) in the field as compared to the total number of records in the table. |
qnNonNulls optional integer<int64> | Number of values that are non Null. |
qnRows optional integer<int64> | Number of rows in the field. |
qSubsetRatio optional number<double> | Number of distinct values in the field (in the current table) as compared to the total number of distinct values of this field (in all tables). |
qnTotalDistinctValues optional integer<int32> | Number of distinct values in the field. |
qnPresentDistinctValues optional integer<int32> | No description |
qKeyType optional | No description |
qComment optional string | Comment related to the field. |
qTags optional Array<string> | List of tags related to the field. |
qDerivedFields optional | List of the derived fields. |
qIsFieldOnTheFly optional, default=false boolean | No description |
qReadableName optional string | No description |
schemasFieldInTableProfilingData
objectProperties
qName optional string | Name of the field. |
qFieldTags optional Array<string> | List of tags related to the field. |
qNumberFormat optional | Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below. Formatting mechanismThe formatting mechanism depends on the type set in qType, as shown below: In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.
Type is DATE, TIME, TIMESTAMP or INTERVALThe following applies:
Type is INTEGERThe following applies:
Type is REALThe following applies:
Type is FIXThe following applies:
Type is MONEYThe following applies:
Type is ASCIINo formatting, qFmt is ignored. |
qDistinctValues optional integer<int64> | Number of distinct values |
qDistinctNumericValues optional integer<int64> | Number of distinct numeric values |
qDistinctTextValues optional integer<int64> | Number of distinct text values |
qNumericValues optional integer<int64> | Number of numeric values |
qNullValues optional integer<int64> | Number of null values |
qTextValues optional integer<int64> | Number of textual values |
qNegValues optional integer<int64> | Number of negative values |
qPosValues optional integer<int64> | Number of positive values |
qZeroValues optional integer<int64> | Number of zero values for numerical values |
qSum optional number<double> | Sum of all numerical values. NaN otherwise. |
qSum2 optional number<double> | Squared sum of all numerical values. NaN otherwise. |
qAverage optional number<double> | Average of all numerical values. NaN otherwise. |
qMedian optional number<double> | Median of all numerical values. NaN otherwise. |
qStd optional number<double> | Standard deviation of numerical values. NaN otherwise. |
qMin optional number<double> | Minimum value of numerical values. NaN otherwise. |
qMax optional number<double> | Maximum value of numerical values. NaN otherwise. |
qSkewness optional number<double> | Skewness of the numerical values. NaN otherwise. |
qKurtosis optional number<double> | Kurtosis of the numerical values. NaN otherwise. |
qFractiles optional Array<number<double>> | The .01, .05, .1, .25, .5, .75, .9, .95, .99 fractiles. Array of NaN otherwise. |
qEmptyStrings optional integer<int64> | Number of empty strings |
qMaxStringLen optional integer<int64> | Maximum string length of textual values. 0 otherwise. |
qMinStringLen optional integer<int64> | Minimum string length of textual values. 0 otherwise. |
qSumStringLen optional integer<int64> | Sum of all characters in strings in the field |
qAvgStringLen optional number<double> | Average string length of textual values. 0 otherwise. |
qFirstSorted optional string | For textual values the first sorted string. |
qLastSorted optional string | For textual values the last sorted string. |
qMostFrequent optional | Three most frequent values and their frequencies |
qFrequencyDistribution optional | No description |
schemasFieldList
objectLists the fields present in the data model viewer. Is the layout for FieldListDef.
Properties
qItems optional | Array of items. |
schemasFieldListDef
objectDefines the fields to show.
Properties
qShowSystem optional, default=false boolean | Shows the system tables if set to true. Default is false. |
qShowHidden optional, default=false boolean | Shows the hidden fields if set to true. Default is false. |
qShowSemantic optional, default=false boolean | Show the semantic fields if set to true. Default is false. |
qShowSrcTables optional, default=false boolean | Shows the tables and fields present in the data model viewer if set to true. Default is false. |
qShowDefinitionOnly optional, default=false boolean | Shows the fields defined on the fly if set to true. Default is false. |
qShowDerivedFields optional, default=false boolean | Shows the fields and derived fields if set to true. Default is false. |
qShowImplicit optional, default=false boolean | Shows the Direct Discovery measure fields if set to true. Default is false. |
schemasFieldOrColumn
objectProperties
qFieldName optional string | Name of the field or column to be matched. |
qTableName optional string | Name of the table to be matched on. This parameter is optional. If TableName is set, FieldName represent the Table column with that name. If TableName is not set, FieldName represents the the field with that name. |
schemasFieldScores
objectProperties
qFieldName optional string | Field name. One of the field names defined in qFieldPairName. |
qReadableName optional string | No description |
qCardinalRatio optional number<double> | Cardinality of a column/field divided by the number of rows in the table. If the cardinal ratio is 1, it means that the column is a candidate/primary key. |
qSymbolScore optional number<double> | Number of distinct matches between the two fields defined in qFieldPairName divided by the number of distinct values in the field qFieldName . If 0, it means that there are no common values between the two fields defined in qFieldPairName . |
qRowScore optional number<double> | Number of matches between the two fields defined in qFieldPairName divided by the number of values in the field qFieldName . If 0, it means that there are no common values between the two fields defined in qFieldPairName . |
schemasFieldType
stringoneOf
NOT_PRESENT optional | No description |
PRESENT optional | No description |
IS_CYCLIC_GROUP optional | No description |
IS_DRILL_GROUP optional | No description |
IS_VAR optional | No description |
IS_EXPR optional | No description |
IS_IMPLICIT optional | No description |
IS_DETAIL optional | No description |
schemasFieldValue
objectProperties
qText optional string | Text related to the field value. This parameter is optional. |
qIsNumeric optional boolean | Is set to true if the value is a numeric. This parameter is optional. Default is false. |
qNumber optional number<double> | Numeric value of the field. This parameter is displayed if qIsNumeric is set to true. This parameter is optional. |
schemasFileDataFormat
objectFileType
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
Properties
qType optional | No description |
qLabel optional string | One of:
|
qQuote optional string | One of:
This property is used for delimited files. |
qComment optional string | String that marks the beginning of the comment line. Example: “#” or “//” The engine ignores the commented lines during the data load. This property is only used for delimited files. |
qDelimiter optional | No description |
qCodePage optional integer<int32> | Character set used in the file. |
qHeaderSize optional integer<int32> | Size of the header. Example: If the header size is 2, the first two rows in the file are considered as header and not as data. The header can contain the field names. |
qRecordSize optional integer<int32> | Record length. Each record (row of data) contains a number of columns with a fixed field size. This property is used for fixed record data files. |
qTabSize optional integer<int32> | Number of spaces that one tab character represents in the table file. This property is used for fixed record data files. |
qIgnoreEOF optional boolean | Is set to true, the end-of-file character is not taken into account during reload. This property is used for delimited files and fixed record data files. |
qFixedWidthDelimiters optional string | Positions of the field breaks in the table. This property is used for fixed record data files. |
schemasFileType
stringoneOf
CSV optional | FILE_TYPE_CSV |
FIX optional | FILE_TYPE_FIX |
DIF optional | FILE_TYPE_DIF |
EXCEL_BIFF optional | FILE_TYPE_EXCEL_BIFF |
EXCEL_OOXML optional | FILE_TYPE_EXCEL_OOXML |
HTML optional | FILE_TYPE_HTML |
QVD optional | FILE_TYPE_QVD |
XML optional | FILE_TYPE_XML |
QVX optional | FILE_TYPE_QVX |
JSON optional | FILE_TYPE_JSON |
KML optional | FILE_TYPE_KML |
PARQUET optional | FILE_TYPE_PARQUET |
schemasFilterInfo
objectProperties
qType optional | No description |
qWherePredicate optional string | No description |
schemasFilterType
stringoneOf
NONE optional | FILTER_TYPE_NONE |
RAW optional | FILTER_TYPE_RAW |
schemasFolderItem
objectProperties
qName optional string | Name of the folder item. |
qType optional | No description |
schemasFolderItemType
stringoneOf
FOLDER optional | FOLDER_ITEM_FOLDER |
FILE optional | FOLDER_ITEM_FILE |
OTHER optional | FOLDER_ITEM_OTHER |
schemasFrequencyDistributionData
objectProperties
qNumberOfBins optional integer<int32> | Number of bins. |
qBinsEdges optional Array<number<double>> | Bins edges. |
qFrequencies optional Array<integer<int32>> | Bins frequencies. |
schemasFunction
objectProperties
qName optional string | Name of the script function. |
qGroup optional | No description |
qSignature optional string | Signature of the script function. Gives general information about the function. |
schemasFunctionGroup
stringoneOf
ALL optional | FUNC_GROUP_ALL |
U optional | FUNC_GROUP_UNKNOWN |
NONE optional | FUNC_GROUP_NONE |
AGGR optional | FUNC_GROUP_AGGR |
NUM optional | FUNC_GROUP_NUMERIC |
RNG optional | FUNC_GROUP_RANGE |
EXP optional | FUNC_GROUP_EXPONENTIAL_AND_LOGARITHMIC |
TRIG optional | FUNC_GROUP_TRIGONOMETRIC_AND_HYPERBOLIC |
FIN optional | FUNC_GROUP_FINANCIAL |
MATH optional | FUNC_GROUP_MATH_CONSTANT_AND_PARAM_FREE |
COUNT optional | FUNC_GROUP_COUNTER |
STR optional | FUNC_GROUP_STRING |
MAPP optional | FUNC_GROUP_MAPPING |
RCRD optional | FUNC_GROUP_INTER_RECORD |
CND optional | FUNC_GROUP_CONDITIONAL |
LOG optional | FUNC_GROUP_LOGICAL |
NULL optional | FUNC_GROUP_NULL |
SYS optional | FUNC_GROUP_SYSTEM |
FILE optional | FUNC_GROUP_FILE |
TBL optional | FUNC_GROUP_TABLE |
DATE optional | FUNC_GROUP_DATE_AND_TIME |
NUMI optional | FUNC_GROUP_NUMBER_INTERPRET |
FRMT optional | FUNC_GROUP_FORMATTING |
CLR optional | FUNC_GROUP_COLOR |
RNK optional | FUNC_GROUP_RANKING |
GEO optional | FUNC_GROUP_GEO |
EXT optional | FUNC_GROUP_EXTERNAL |
PROB optional | FUNC_GROUP_PROBABILITY |
ARRAY optional | FUNC_GROUP_ARRAY |
LEG optional | FUNC_GROUP_LEGACY |
DB optional | FUNC_GROUP_DB_NATIVE |
schemasGenericBookmarkEntry
objectProperties
qProperties optional | No description |
qBookmark optional | No description |
qClassicBookmark optional | No description |
qClassicMetadata optional | No description |
schemasGenericBookmarkLayout
objectIs the layout for GenericBookmarkProperties.
Properties
qInfo optional | No description |
qMeta optional | Layout for NxMetaDef. |
qBookmark optional | No description |
qFieldInfos optional | Information about the field selections associated with the bookmark. |
schemasGenericBookmarkProperties
objectProperties
qInfo optional | No description |
qMetaDef optional | Used to collect meta data. PropertiesSemantic type with an empty structure. |
qIncludeVariables optional, default=false boolean | If true all variables will be stored in the bookmark. |
qDistinctValues optional, default=false boolean | If true all selected values will be stored distinct, i.e. searchstrings will not be kept. |
schemasGenericConnectMachine
stringoneOf
CONNECT_DEFAULT optional | No description |
CONNECT_64 optional | No description |
CONNECT_32 optional | No description |
schemasGenericDimensionInfo
objectProperties
qApprMaxGlyphCount optional integer<int32> | Length of the longest value in the field. |
qCardinal optional integer<int32> | Number of distinct field values |
qTags optional Array<string> | Gives information on a field. For example, it can return the type of the field. Examples: key, text, ASCII |
qIsSemantic optional boolean | If set to true, it means that the field is a semantic. |
qAndMode optional boolean | If set to true a logical AND (instead of a logical OR) is used when making selections in a field. The default value is false. |
schemasGenericDimensionLayout
objectIs the layout for GenericDimensionProperties.
Properties
qInfo optional | No description |
qMeta optional | Layout for NxMetaDef. |
qDim optional | No description |
qDimInfos optional | Cardinal and tags related to the dimension. Length of the longest value in the field. |
schemasGenericDimensionProperties
objectProperties
qInfo optional | No description |
qDim optional | No description |
qMetaDef optional | Used to collect meta data. PropertiesSemantic type with an empty structure. |
schemasGenericMeasureLayout
objectIs the layout for GenericMeasureProperties.
Properties
qInfo optional | No description |
qMeasure optional | Information about the library measure. Is the layout for NxLibraryMeasureDef. |
qMeta optional | Layout for NxMetaDef. |
schemasGenericMeasureProperties
objectProperties
qInfo optional | No description |
qMeasure optional | No description |
qMetaDef optional | Used to collect meta data. PropertiesSemantic type with an empty structure. |
schemasGenericObjectEntry
objectProperties
qProperty optional | No description |
qChildren optional | Information about the children of the generic object. |
qEmbeddedSnapshotRef optional | No description |
schemasGenericObjectLayout
objectIs the layout for GenericObjectProperties.
Properties
qInfo optional | No description |
qMeta optional | Layout for NxMetaDef. |
qExtendsId optional string | Should be set to create an object that is linked to another object. Enter the identifier of the object you want to link to. If you do not want to link your object, set this parameter to an empty string. |
qHasSoftPatches optional boolean | Is set to true if the generic object contains some properties that are not persistent (a soft patch was applied). |
qError optional | No description |
qSelectionInfo optional | No description |
qStateName optional string | Name of the alternate state. Default is current selections $ . |
schemasGenericObjectProperties
objectProperties
qInfo optional | No description |
qExtendsId optional string | Should be set to create an object that is linked to another object. Enter the identifier of the linking object (i.e the object you want to link to). If you do not want to link your object, set this parameter to an empty string. |
qMetaDef optional | Used to collect meta data. PropertiesSemantic type with an empty structure. |
qStateName optional string | Name of the alternate state. Default is current selections $ . |
schemasGenericVariableLayout
objectIs the layout for GenericVariableProperties.
Properties
qInfo optional | No description |
qMeta optional | Layout for NxMetaDef. |
qText optional string | Some text. |
qNum optional number<double> | A value. |
qIsScriptCreated optional boolean | If set to true, it means that the variable was defined via script. |
schemasGenericVariableProperties
objectProperties
qInfo optional | No description |
qMetaDef optional | Used to collect meta data. PropertiesSemantic type with an empty structure. |
qName optional string | Name of the variable. The name must be unique. This parameter is mandatory. |
qComment optional string | Comment related to the variable. This parameter is optional. |
qNumberPresentation optional | Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below. Formatting mechanismThe formatting mechanism depends on the type set in qType, as shown below: In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.
Type is DATE, TIME, TIMESTAMP or INTERVALThe following applies:
Type is INTEGERThe following applies:
Type is REALThe following applies:
Type is FIXThe following applies:
Type is MONEYThe following applies:
Type is ASCIINo formatting, qFmt is ignored. |
qIncludeInBookmark optional, default=false boolean | Set this property to true to update the variable when applying a bookmark. The variable value will be persisted in the bookmark. The value of a variable can affect the state of the selections. Script variables cannot be persisted in the bookmark. The default value is false. |
qDefinition optional string | Definition of the variable. |
schemasGraphMode
stringoneOf
GRAPH_MODE_BAR optional | No description |
GRAPH_MODE_PIE optional | No description |
GRAPH_MODE_PIVOTTABLE optional | No description |
GRAPH_MODE_SCATTER optional | No description |
GRAPH_MODE_LINE optional | No description |
GRAPH_MODE_STRAIGHTTABLE optional | No description |
GRAPH_MODE_COMBO optional | No description |
GRAPH_MODE_RADAR optional | No description |
GRAPH_MODE_GAUGE optional | No description |
GRAPH_MODE_GRID optional | No description |
GRAPH_MODE_BLOCK optional | No description |
GRAPH_MODE_FUNNEL optional | No description |
GRAPH_MODE_MEKKO optional | No description |
GRAPH_MODE_LAST optional | No description |
schemasGroupBookmarkData
objectProperties
qId optional string | No description |
qCyclePos optional integer<int32> | No description |
schemasGroupStateInfo
objectProperties
qGroupName optional string | No description |
qCurrentItemName optional string | No description |
schemasHyperCube
objectRenders the properties of a hypercube. Is the layout for HyperCubeDef. For more information about the definition of a hypercube, see Generic object.
Properties
qStateName optional string | Name of the alternate state. Default is current selections $ . |
qSize optional | No description |
qError optional | No description |
qDimensionInfo optional | Information on the dimension. |
qMeasureInfo optional | Information on the measure. |
qEffectiveInterColumnSortOrder optional Array<integer<int32>> | Sort order of the columns in the hypercube. Column numbers are separated by a comma. Example: [1,0,2] means that the first column to be sorted was the column 1, followed by the column 0 and the column 2. |
qGrandTotalRow optional | Aggregate for measures of all values in the field. The result value depends on the qAggrFunc defined in HyperCubeDef. |
qDataPages optional | Set of data. Is empty if nothing has been defined in qInitialDataFetch in HyperCubeDef. |
qPivotDataPages optional | Set of data for pivot tables. Is empty if nothing has been defined in qInitialDataFetch in HyperCubeDef. |
qStackedDataPages optional | Set of data for stacked tables. Is empty if nothing has been defined in qInitialDataFetch in HyperCubeDef. |
qMode optional | No description |
qNoOfLeftDims optional integer<int32> | Number of left dimensions. Default value is -1. The index related to each left dimension depends on the position of the pseudo dimension (if any). For example, a pivot table with:
implies that:
Another example:
implies that:
|
qIndentMode optional boolean | Is used for pivot tables only. If set to true, the formatting of the results is slightly different. This property is optional. |
qLastExpandedPos optional | No description |
qHasOtherValues optional boolean | True if other row exists. |
qTitle optional string | Title of the hypercube, for example the title of a chart. |
qTreeNodesOnDim optional Array<integer<int32>> | The total number of nodes on each dimension (only applicable when qMode = T ). |
qCalcCondMsg optional string | The message displayed if calculation condition is not fulfilled. |
qColumnOrder optional Array<integer<int32>> | The order of the columns. |
schemasHyperCubeDef
objectDefines the properties of a hypercube. For more information about the definition of a hypercube, see Generic object.
Properties
qStateName optional string | Name of the alternate state. Default is current selections $ . |
qDimensions optional | Array of dimensions. |
qMeasures optional | Array of measures. |
qInterColumnSortOrder optional Array<integer<int32>> | Defines the sort order of the columns in the hypercube. Column numbers are separated by a comma. Example: [1,0,2] means that the first column to be sorted should be the column 1, followed by the column 0 and the column 2. The default sort order is the order in which the dimensions and measures have been defined in the hypercube. By default, the pseudo-dimension (if any) is the most to the right in the array. The index of the pseudo-dimension (if any) is -1. Pseudo dimensions only apply for pivot tables with more than one measure. A pseudo dimension groups together the measures defined in a pivot table. You can neither collapse/expand a pseudo dimension nor make any selections in it. Stacked pivot tables can only contain one measure. |
qSuppressZero optional, default=false boolean | Removes zero values. |
qSuppressMissing optional, default=false boolean | Removes missing values. |
qInitialDataFetch optional | Initial data set. |
qReductionMode optional | No description |
qMode optional | No description |
qPseudoDimPos optional, default=-1 integer<int32> | No description |
qNoOfLeftDims optional, default=-1 integer<int32> | Number of left dimensions. Default value is -1. In that case, all dimensions are left dimensions. Hidden dimensions (e.g. due to unfulfilled calc condition on dimension level) is still counted in this context. The index related to each left dimension depends on the position of the pseudo dimension (if any). For example, a pivot table with:
implies that:
Another example:
Implies that:
|
qAlwaysFullyExpanded optional, default=false boolean | If this property is set to true, the cells are always expanded. It implies that it is not possible to collapse any cells. The default value is false. |
qMaxStackedCells optional, default=5000 integer<int32> | Maximum number of cells for an initial data fetch (set in qInitialDataFetch ) when in stacked mode ( qMode is K). The default value is 5000. |
qPopulateMissing optional, default=false boolean | If this property is set to true, the missing symbols (if any) are replaced by 0 if the value is a numeric and by an empty string if the value is a string. The default value is false. |
qShowTotalsAbove optional, default=false boolean | If set to true, the total (if any) is shown on the first row. The default value is false. |
qIndentMode optional, default=false boolean | This property applies for pivot tables and allows to change the layout of the table. An indentation is added to the beginning of each row. The default value is false. |
qCalcCond optional | No description |
qSortbyYValue optional, default=0 integer<int8> | To enable the sorting by ascending or descending order in the values of a measure. This property applies to pivot tables and stacked pivot tables. In the case of a pivot table, the measure or pseudo dimension should be defined as a top dimension. The sorting is restricted to the values of the first measure in a pivot table. |
qTitle optional | No description |
qCalcCondition optional | No description |
qColumnOrder optional Array<integer<int32>> | The order of the columns. |
qExpansionState optional | Expansion state per dimension for pivot mode ( qMode is P). |
qDynamicScript optional Array<string> | Hypercube Modifier Dynamic script string |
qContextSetExpression optional string | Set Expression valid for the whole cube. Used to limit computations to the set specified. |
schemasInputFieldItem
objectProperties
qFieldName optional string | No description |
qValues optional | No description |
qPackedHashKeys optional Array<integer<byte>> | No description |
schemasInterFieldSortData
objectProperties
qName optional string | No description |
qReversed optional boolean | No description |
schemasInteractDef
objectProperties
qType optional | No description |
qTitle optional string | Title used in the message box dialog. This property is relevant if qType is IT_MSGBOX. |
qMsg optional string | Message used in the message box dialog. This property is relevant if qType is IT_MSGBOX. |
qButtons optional integer<int32> | Buttons displayed in the message box dialog. This property is relevant if qType is IT_MSGBOX. One of:
|
qLine optional string | Next script statement to be executed. This property is used if the type of interaction is IT_SCRIPTLINE. |
qOldLineNr optional integer<int32> | First line number of the previously executed statement. This property is used if the type of interaction is IT_SCRIPTLINE. |
qNewLineNr optional integer<int32> | First line number of the next statement to be executed. This property is used if the type of interaction is IT_SCRIPTLINE. |
qPath optional string | Path specified by the Include script variable. This property is used if the type of interaction is IT_SCRIPTLINE. Example of an Include variable: $(Include=lib:\\MyDataFiles\abc.txt); |
qHidden optional boolean | This property is set to true if the returned statement is an hidden script statement. |
qResult optional integer<int32> | Not relevant for describing the requested user interaction. |
qInput optional string | Is not used in Qlik Sense. |
schemasInteractType
stringoneOf
IT_MSGBOX optional | No description |
IT_SCRIPTLINE optional | No description |
IT_BREAK optional | No description |
IT_INPUT optional | No description |
IT_END optional | No description |
IT_PASSWD optional | No description |
IT_USERNAME optional | No description |
schemasJsonObject
objectContains dynamic JSON data specified by the client.
schemasKeyType
stringoneOf
NOT_KEY optional | No description |
ANY_KEY optional | No description |
PRIMARY_KEY optional | No description |
PERFECT_KEY optional | No description |
schemasLayoutBookmarkData
objectProperties
qId optional string | No description |
qActive optional boolean | No description |
qShowMode optional integer<byte> | No description |
qScrollPos optional | No description |
schemasLayoutExclude
objectContains JSON to be excluded from validation.
schemasLayoutFieldInfo
objectMeta data about the selection in a field.
Properties
qFieldName optional string | The name of the field. |
qValuesCount optional integer<int32> | Number of selected values in the field. |
qExcludedValuesCount optional integer<int32> | Number of excluded values in the field. |
schemasLineageInfo
objectProperties
qDiscriminator optional string | A string indicating the origin of the data:
|
qStatement optional string | The LOAD and SELECT script statements from the data load script. |
schemasListObject
objectRenders the properties of a list object. Is the layout for ListObjectDef. For more information about the definition of a list object, see Generic object.
Properties
qStateName optional string | Name of the alternate state. Default is current selections $ . |
qSize optional | No description |
qError optional | No description |
qDimensionInfo optional | No description |
qExpressions optional | Lists the expressions in the list object. |
qDataPages optional | Set of data. Is empty if nothing has been defined in qInitialDataFetch in ListObjectDef. |
schemasListObjectDef
objectDefines the properties of a list object. For more information about the definition of a list object, see Generic object.
Properties
qStateName optional string | Name of the alternate state. Default is current selections $ . |
qLibraryId optional string | Refers to a dimension stored in the library. |
qDef optional | No description |
qAutoSortByState optional | No description |
qFrequencyMode optional | No description |
qShowAlternatives optional boolean | If set to true, alternative values are allowed in qData . If set to false, no alternative values are displayed in qData . Values are excluded instead. The default value is false. Note that on the contrary, the qStateCounts parameter counts the excluded values as alternative values. This parameter is optional. |
qInitialDataFetch optional | Fetches an initial data set. |
qExpressions optional | Lists the expressions in the list object. This parameter is optional. |
qDirectQuerySimplifiedView optional boolean | If set to true, reduces the set of states returned. Supported for Direct Query mode only. Default is false. |
schemasLocaleInfo
objectProperties
qDecimalSep optional string | Decimal separator. |
qThousandSep optional string | Thousand separator. |
qListSep optional string | List separator. |
qMoneyDecimalSep optional string | Money decimal separator. |
qMoneyThousandSep optional string | Money thousand separator. |
qCurrentYear optional integer<int32> | Current year. |
qMoneyFmt optional string | Money format. Example: #.##0,00 kr;-#.##0,00 kr |
qTimeFmt optional string | Time format. Example: hh:mm:ss |
qDateFmt optional string | Date format. Example: YYYY-MM-DD |
qTimestampFmt optional string | Time stamp format. Example: YYYY-MM-DD hh:mm:ss[.fff] |
qCalendarStrings optional | No description |
qFirstWeekDay optional integer<int32> | First day of the week, starting from 0. According to ISO 8601, Monday is the first day of the week.
If this property has not been set in a script, the returned value comes from the Windows operating system. |
qBrokenWeeks optional boolean | Is set to true if broken weeks are allowed in a year. According to ISO 8601, no broken weeks should be allowed. This property is not shown if set to false. If qBrokenWeeks is set to true, qReferenceDay is irrelevant. If this property has not been set in a script, the returned value comes from the Windows operating system. |
qReferenceDay optional integer<int32> | Day in the year that is always in week 1. According to ISO 8601, January 4th should always be part of the first week of the year ( qReferenceDay =4). Recommended values are in the range 1 and 7. If this property has not been set in a script, the returned value comes from the Windows operating system. This property is not relevant if there are broken weeks in the year. |
qFirstMonthOfYear optional integer<int32> | First month of the year, starting from 1. According to ISO 8601, January is the first month of the year.
If this property has not been set in a script, the returned value comes from the Windows operating system. |
qCollation optional string | Locale name (following language tagging convention RFC 4646): < language>-<REGION> Where:
If this property has not been set in a script, the returned value comes from the Windows operating system. |
qNumericalAbbreviation optional string | Number format. Example: 3:k;6:M;9:G;12:T;15:P;18:E;21:Z;24:Y;-3:m;-6:μ;-9:n;-12:p;-15:f;-18:a;-21:z;-24:y |
schemasLogOnType
stringoneOf
LOG_ON_SERVICE_USER optional | No description |
LOG_ON_CURRENT_USER optional | No description |
schemasMeasureList
objectLists the measures. Is the layout for MeasureListDef.
Properties
qItems optional | Information about the list of measures. |
schemasMeasureListDef
objectDefines the list of measures.
Properties
qType optional string | Type of the list. |
qData optional | Contains dynamic JSON data specified by the client. |
schemasMediaList
objectLists the media files. Is the layout for MediaListDef.
Properties
qItems optional | Information about the list of media files. In Qlik Sense Desktop, the media files are retrieved from: %userprofile%\Documents\Qlik\Sense\Content\Default In Qlik Sense Enterprise, the media files are retrieved from: <installation_directory>\Qlik\Sense\Repository\Content\Default The default installation directory is ProgramData . |
schemasMediaListDef
objectDefines the list of media files.
Properties
"qMediaListDef": {} qMediaListDef has an empty structure. No properties need to be set.
schemasMediaListItem
objectProperties
qUrlDef optional string | Relative path to the media file. The URL is static. Media files located:
|
qUrl optional string | Relative path to the media file. Media files located:
|
schemasMetaData
objectProperties
qShared optional boolean | No description |
qUtcModifyTime optional number<double> | No description |
qSheetId optional string | No description |
qTemporary optional boolean | No description |
qRestrictedAccess optional boolean | No description |
qAccessList optional Array<string> | No description |
qPersonalEditionHash_OBSOLETE optional string | No description |
qHidden optional, default=false boolean | No description |
qLinkedTo optional Array<string> | No description |
schemasNxAppLayout
objectQlik 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
Properties
qTitle optional string | Title of the app. |
qFileName optional string | In Qlik Sense Enterprise, this property corresponds to the app identifier (GUID). In Qlik Sense Desktop, this property corresponds to the full path of the app. |
qLastReloadTime optional string | Date and time of the last reload of the app in ISO format. |
qModified optional boolean | Is set to true if the app has been updated since the last save. |
qHasScript optional boolean | Is set to true if a script is defined in the app. |
qStateNames optional Array<string> | Array of alternate states. |
qMeta optional | Layout for NxMetaDef. |
qLocaleInfo optional | No description |
qHasData optional boolean | Is set to true if the app contains data following a script reload. |
qReadOnly optional boolean | If set to true, it means that the app is read-only. |
qIsOpenedWithoutData optional boolean | If set to true, it means that the app was opened without loading its data. |
qIsSessionApp optional boolean | If set to true, the app is a Session App, i.e. not persistent. |
qThumbnail optional | In addition, this structure can return dynamic properties. |
qIsBDILiveMode optional boolean | If set to true, the app is in BDI Direct Query Mode. |
qIsDirectQueryMode optional boolean | If set to true, the app is in Direct Query Mode. |
qUnsupportedFeatures optional Array<NxFeature> | Array of features not supported by the app. |
schemasNxAppProperties
objectQlik 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
Properties
qTitle optional string | App title. |
qLastReloadTime optional string | Last reload time of the app. |
qMigrationHash optional string | Internal property reserved for app migration. Patch version of the app. Do not update. |
qSavedInProductVersion optional string | Internal property reserved for app migration. The app is saved in this version of the product. Do not update. |
qThumbnail optional | In addition, this structure can contain dynamic properties. |
qHasSectionAccess optional boolean | If true the app has section access configured. |
schemasNxAttrDimDef
objectLayout for NxAttrDimDef.
Properties
qDef optional string | Expression or field name. |
qLibraryId optional string | LibraryId for dimension. |
qSortBy optional | No description |
qAttribute optional boolean | If set to true, this attribute will not affect the number of rows in the cube. |
schemasNxAttrDimInfo
objectLayout for NxAttrDimDef.
Properties
qCardinal optional integer<int32> | Cardinality of the attribute expression. |
qSize optional | No description |
qFallbackTitle optional string | The title for the attribute dimension. |
qLocked optional boolean | The Locked value of the dimension. |
qError optional | No description |
qIsCalculated optional, default=false boolean | True if this is a calculated dimension. |
schemasNxAttrExprDef
objectProperties
qExpression optional string | Definition of the attribute expression. Example: "Max(OrderID)" |
qLibraryId optional string | Definition of the attribute expression stored in the library. Example: "MyGenericMeasure" |
qAttribute optional boolean | If set to true, this measure will not affect the number of rows in the cube. |
qNumFormat optional | Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below. Formatting mechanismThe formatting mechanism depends on the type set in qType, as shown below: In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.
Type is DATE, TIME, TIMESTAMP or INTERVALThe following applies:
Type is INTEGERThe following applies:
Type is REALThe following applies:
Type is FIXThe following applies:
Type is MONEYThe following applies:
Type is ASCIINo formatting, qFmt is ignored. |
qLabel optional string | Label of the attribute expression. |
qLabelExpression optional string | Optional expression used for dynamic label. |
schemasNxAttrExprInfo
objectLayout for NxAttrExprDef.
Properties
qMin optional number<double> | Minimum value. |
qMax optional number<double> | Maximum value. |
qFallbackTitle optional string | No description |
qMinText optional string | String version of the minimum Value. |
qMaxText optional string | String version of the maximum Value. |
qNumFormat optional | Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below. Formatting mechanismThe formatting mechanism depends on the type set in qType, as shown below: In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.
Type is DATE, TIME, TIMESTAMP or INTERVALThe following applies:
Type is INTEGERThe following applies:
Type is REALThe following applies:
Type is FIXThe following applies:
Type is MONEYThe following applies:
Type is ASCIINo formatting, qFmt is ignored. |
qIsAutoFormat optional boolean | This parameter is set to true if qNumFormat is set to U (unknown). The engine guesses the type of the field based on the field's expression. |
schemasNxAttributeDimValues
objectProperties
qValues optional | List of values. |
schemasNxAttributeExpressionValues
objectProperties
qValues optional | List of attribute expressions values. |
schemasNxAutoSortByStateDef
objectProperties
qDisplayNumberOfRows optional integer<int32> | This parameter applies to list objects. If the number of selected values in the list object is greater than the value set in qDisplayNumberOfRows , the selected lines are promoted at the top of the list object. If qDisplayNumberOfRows is set to a negative value or to 0, the sort by state is disabled. |
schemasNxAxisData
objectProperties
qAxis optional | List of axis data. |
schemasNxAxisTicks
objectProperties
qName optional string | Name of the derived definition. |
qTags optional Array<string> | List of tags. |
qTicks optional | List of ticks. |
schemasNxBookmark
objectProperties
qStateData optional | List of selections for each state. |
qUtcModifyTime optional number<double> | Time when the bookmark was created. |
qVariableItems optional | List of the variables in the app at the time the bookmark was created. |
qPatches optional | Softpatches to be applied with this bookmark. |
schemasNxCalcCond
objectProperties
qCond optional | No description |
qMsg optional | No description |
schemasNxCardinalities
objectProperties
qCardinal optional integer<int32> | Number of distinct field values. |
qHypercubeCardinal optional integer<int32> | Number of distinct hypercube values. |
qAllValuesCardinal optional, default=-1 integer<int32> | Number of distinct values when paging for AllValues in a Tree Structure. Default is -1 if not part of a Tree structure. |
schemasNxCell
objectProperties
qText optional string | Some text. This parameter is optional. |
qNum optional number<double> | A value. This parameter is optional. |
qElemNumber optional integer<int32> | Rank number of the value, starting from 0. If the element number is a negative number, it means that the returned value is not an element number. You can get the following negative values:
|
qState optional | No description |
qIsEmpty optional boolean | Is set to true , if qText and qNum are empty. This parameter is optional. The default value is false . |
qIsTotalCell optional boolean | Is set to true if a total is displayed in the cell. This parameter is optional. The default value is false . Not applicable to list objects. |
qIsOtherCell optional boolean | Is set to true if the cell belongs to the group Others . Dimension values can be set as Others depending on what has been defined in OtherTotalSpecProp . This parameter is optional. The default value is false . Not applicable to list objects. |
qFrequency optional string | Frequency of the value. This parameter is optional. |
qHighlightRanges optional | No description |
qAttrExps optional | No description |
qAttrDims optional | No description |
qIsNull optional boolean | Is set to true if the value is Null. |
qMiniChart optional | No description |
qInExtRow optional boolean | No description |
schemasNxCellPosition
objectProperties
qx optional integer<int32> | Position of the cell on the x-axis. |
qy optional integer<int32> | Position of the cell on the y-axis. |
schemasNxCellRows
Array<NxCell>schemasNxContainerEntry
objectProperties
qInfo optional | No description |
qMeta optional | Layout for NxMetaDef. |
qData optional | Contains dynamic JSON data specified by the client. |
schemasNxContinuousDataOptions
objectProperties
qStart optional number<double> | Start value. |
qEnd optional number<double> | End value. |
qNbrPoints optional integer<int32> | Number of bins for binning. |
qMaxNbrTicks optional integer<int32> | Maximum number of ticks. |
qMaxNumberLines optional, default=-1 integer<int32> | Maximum number of lines. |
schemasNxContinuousMode
stringoneOf
Never optional | CONTINUOUS_NEVER |
Possible optional | CONTINUOUS_IF_POSSIBLE |
Time optional | CONTINUOUS_IF_TIME |
schemasNxContinuousRangeSelectInfo
objectProperties
qRange optional | No description |
qDimIx optional integer<int32> | Dimension index. |
schemasNxCurrentSelectionItem
objectProperties
qTotal optional integer<int32> | Number of values in the field. |
qIsNum optional boolean | This parameter is displayed if its value is true. Is set to true if the field is a numeric. This parameter is optional. |
qField optional string | Name of the field that is selected. |
qLocked optional boolean | This parameter is displayed if its value is true. Is set to true if the field is locked. This parameter is optional. |
qOneAndOnlyOne optional boolean | This parameter is displayed if its value is true. Property that is set to a field. Is set to true if the field cannot be unselected. This parameter is optional. |
qTextSearch optional string | Text that was used for the search. This parameter is filled when searching for a value and selecting it. This parameter is optional. |
qSelectedCount optional integer<int32> | Number of values that are selected. |
qSelected optional string | Values that are selected. |
qRangeInfo optional | Information about the range of selected values. Is empty if there is no range of selected values. |
qSortIndex optional integer<int32> | Sort index of the field. Indexing starts from 0. |
qStateCounts optional | No description |
qSelectedFieldSelectionInfo optional | Information about the fields that are selected. |
qNotSelectedFieldSelectionInfo optional | Information about the fields that are not selected. |
qSelectionThreshold optional integer<int32> | Maximum values to show in the current selections. The default value is 6. |
qReadableName optional string | Label that, if defined, is displayed in current selections instead of the actual expression. |
qIsHidden optional boolean | Optional parameter. Indicates if the selection is to be hidden in the Selections bar. Is set to true if the current selection is hidden. |
schemasNxDataAreaPage
objectProperties
qLeft optional number<double> | Position from the left. Corresponds to the lowest possible value of the first measure (the measure on the x-axis). |
qTop optional number<double> | Position from the top. Corresponds to the highest possible value of the second measure (the measure on the y-axis). |
qWidth optional number<double> | Width of the page. Corresponds to the highest possible value of the first measure (the measure on the x-axis). |
qHeight optional number<double> | Height of the page. The difference between qTop and qHeight gives the lowest possible value of the second measure (the measure on the y-axis). |
schemasNxDataPage
objectProperties
qMatrix optional Array<Array<NxCell>> | Array of data. |
qTails optional | Array of tails. Is used for hypercube objects with multiple dimensions. It might happen that due to the window size some elements in a group cannot be displayed in the same page as the other elements of the group. Elements of a group of dimensions can be part of the previous or the next tail. If there is no tail, the array is empty [ ] . |
qArea optional | No description |
qIsReduced optional, default=false boolean | Is set to true, if the data have been reduced. The default value is false. |
schemasNxDataReductionMode
stringoneOf
N optional | DATA_REDUCTION_NONE |
D1 optional | DATA_REDUCTION_ONEDIM |
S optional | DATA_REDUCTION_SCATTERED |
C optional | DATA_REDUCTION_CLUSTERED |
ST optional | DATA_REDUCTION_STACKED |
schemasNxDerivedField
objectProperties
qId optional string | Identifier of the derived field. The identifier is unique. |
qName optional string | Combination of field name, definition and method. Example: OrderDate.MyDefinition.Year |
qMethod optional string | Method name associated to the derived field. |
qExpr optional string | Expression of the derived field. Example: If qName is OrderDate.MyDefinition.Year , the expression is as follows: =${Mydefinition(OrderDate).Year} |
qTags optional Array<string> | List of tags. |
schemasNxDerivedFieldDescriptionList
objectProperties
qDerivedFieldLists optional | Information about the derived fields. |
schemasNxDerivedFieldsData
objectProperties
qDerivedDefinitionName optional string | Name of the derived definition. |
qFieldDefs optional | List of the derived fields. |
qGroupDefs optional | List of the derived groups. |
qTags optional Array<string> | List of tags on the derived fields. |
schemasNxDerivedGroup
objectProperties
qId optional string | Identifier of the group. |
qName optional string | Name of the derived group. |
qGrouping optional | No description |
qFieldDefs optional Array<string> | List of the derived fields in the group. |
schemasNxDimCellType
stringoneOf
V optional | NX_DIM_CELL_VALUE |
E optional | NX_DIM_CELL_EMPTY |
N optional | NX_DIM_CELL_NORMAL |
T optional | NX_DIM_CELL_TOTAL |
O optional | NX_DIM_CELL_OTHER |
A optional | NX_DIM_CELL_AGGR |
P optional | NX_DIM_CELL_PSEUDO |
R optional | NX_DIM_CELL_ROOT |
U optional | NX_DIM_CELL_NULL |
G optional | NX_DIM_CELL_GENERATED |
schemasNxDimension
objectProperties
qLibraryId optional string | Refers to a dimension stored in the library. |
qDef optional | No description |
qNullSuppression optional boolean | If set to true, no null values are returned. |
qIncludeElemValue optional boolean | No description |
qOtherTotalSpec optional | No description |
qShowTotal optional boolean | No description |
qShowAll optional boolean | If set to true, all dimension values are shown. |
qOtherLabel optional | No description |
qTotalLabel optional | No description |
qCalcCond optional | No description |
qAttributeExpressions optional | List of attribute expressions. |
qAttributeDimensions optional | List of attribute dimensions. |
qCalcCondition optional | No description |
schemasNxDimensionInfo
objectProperties
qFallbackTitle optional string | Corresponds to the label of the dimension that is selected. If the label is not defined then the field name is used. |
qApprMaxGlyphCount optional integer<int32> | Length of the longest value in the field. |
qCardinal deprecated optional integer<int32> | Number of distinct field values. |
qLocked optional boolean | Is set to true if the field is locked. |
qSortIndicator optional | No description |
qGroupFallbackTitles optional Array<string> | Array of dimension labels. Contains the labels of all dimensions in a hierarchy group (for example the labels of all dimensions in a drill down group). |
qGroupPos optional integer<int32> | Index of the dimension that is currently in use. qGroupPos is set to 0 if there are no hierarchical groups (drill-down groups) or cycle groups. |
qStateCounts optional | No description |
qTags optional Array<string> | Gives information on a field. For example, it can return the type of the field. Examples: key, text, ASCII |
qError optional | No description |
qDimensionType optional | No description |
qReverseSort optional boolean | If set to true, it inverts the sort criteria in the field. |
qGrouping optional | No description |
qIsSemantic optional boolean | If set to true, it means that the field is a semantic. |
qNumFormat optional | Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below. Formatting mechanismThe formatting mechanism depends on the type set in qType, as shown below: In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.
Type is DATE, TIME, TIMESTAMP or INTERVALThe following applies:
Type is INTEGERThe following applies:
Type is REALThe following applies:
Type is FIXThe following applies:
Type is MONEYThe following applies:
Type is ASCIINo formatting, qFmt is ignored. |
qIsAutoFormat optional boolean | This parameter is set to true if qNumFormat is set to U (unknown). The engine guesses the type of the field based on the field's definition. |
qGroupFieldDefs optional Array<string> | Array of field names. |
qMin optional number<double> | Minimum value. |
qMax optional number<double> | Maximum value. |
qContinuousAxes optional boolean | Is continuous axis used. |
qIsCyclic optional boolean | Is a cyclic dimension used. |
qDerivedField optional boolean | Is derived field is used as a dimension. |
qAttrExprInfo optional | Array of attribute expressions. |
qAttrDimInfo optional | Array of attribute dimensions. |
qCalcCondMsg optional string | The message displayed if calculation condition is not fulfilled. |
qIsCalculated optional, default=false boolean | True if this is a calculated dimension. |
qIsOneAndOnlyOne optional boolean | If set to true, it means that the field always has one and only one selected value. |
qCardinalities optional | No description |
qLibraryId optional string | Refers to a dimension stored in the library. |
schemasNxDimensionType
stringoneOf
D optional | NX_DIMENSION_TYPE_DISCRETE |
N optional | NX_DIMENSION_TYPE_NUMERIC |
T optional | NX_DIMENSION_TYPE_TIME |
schemasNxDownloadInfo
objectProperties
qUrl optional string | URL to download the reduced app on. |
qFileSize optional, default=-1 integer<int32> | The filesize of the reduced app. |
schemasNxDownloadOptions
objectProperties
qBookmarkId optional string | Bookmark Id to apply before reducing the application. |
qExpires optional, default=3600 integer<int32> | Time in seconds for how long the download link is valid. |
qServeOnce optional, default=false boolean | No description |
schemasNxEngineVersion
objectProperties
qComponentVersion optional string | Version number of the Qlik engine component. |
schemasNxExportFileType
stringoneOf
CSV_C optional | EXPORT_CSV_C |
CSV_T optional | EXPORT_CSV_T |
OOXML optional | EXPORT_OOXML |
schemasNxExportState
stringoneOf
P optional | EXPORT_POSSIBLE |
A optional | EXPORT_ALL |
schemasNxFeature
stringoneOf
binningData optional | FEATURE_BINNING_DATA |
bookmarks optional | FEATURE_BOOKMARKS |
calculatedFields optional | FEATURE_CALCULATED_FIELDS |
continuousData optional | FEATURE_CONTINUOUS_DATA |
invertedSelections optional | FEATURE_INVERTED_SELECTIONS |
rangeSelections optional | FEATURE_RANGE_SELECTIONS |
reducingData optional | FEATURE_REDUCING_DATA |
search optional | FEATURE_SEARCH |
selectionCount optional | FEATURE_SELECTION_COUNT |
selectionInsights optional | FEATURE_SELECTION_INSIGHTS |
tableMiniChart optional | FEATURE_TABLE_MINI_CHART |
trendlines optional | FEATURE_TRENDLINES |
calculatedDimensions optional | FEATURE_CALCULATED_DIMENSIONS |
includeZeroValues optional | FEATURE_INCLUDE_ZERO_VALUES |
includeNullValues optional | FEATURE_INCLUDE_NULL_VALUES |
filterPanePaging optional | FEATURE_FILTER_PANE_PAGING |
filterPaneCustomSorting optional | FEATURE_FILTER_PANE_CUSTOM_SORTING |
showFrequency optional | FEATURE_SHOW_FREQUENCY |
limitation optional | FEATURE_LIMITATION |
totals optional | FEATURE_TOTALS |
schemasNxFieldDescription
objectNxDerivedFieldsdata
Name | Description | Type |
---|---|---|
qDerivedDefinitionName | Name of the derived definition. | String |
qFieldDefs | List of the derived fields. | Array of NxDerivedField |
qGroupDefs | List of the derived groups. | Array of NxDerivedGroup |
qTags | List of tags on the derived fields. | Array of String |
Properties
qIsSemantic optional boolean | If set to true, it means that the field is a semantic. |
qIsHidden optional boolean | If set to true, it means that the field is hidden. |
qIsSystem optional boolean | If set to true, it means that the field is a system field. |
qAndMode optional boolean | If set to true a logical AND (instead of a logical OR) is used when making selections in a field. The default value is false. |
qName optional string | Name of the field |
qCardinal optional integer<int32> | Number of distinct field values |
qTags optional Array<string> | Gives information on a field. For example, it can return the type of the field. Examples: key, text, ASCII |
qIsDefinitionOnly optional boolean | If set to true, it means that the field is a field on the fly. |
qDerivedFieldData optional | No description |
qIsDetail optional boolean | Is used for Direct Discovery. If set to true, it means that the type of the field is detail. |
qIsImplicit optional boolean | Is used for Direct Discovery. If set to true, it means that the type of the field is measure. |
qReadableName optional string | No description |
schemasNxFieldProperties
objectProperties
qOneAndOnlyOne optional boolean | This parameter is set to true, if the field has one and only one selection (not 0 and not more than 1). If this property is set to true, the field cannot be cleared anymore and no more selections can be performed in that field. The property _OneAndOnlyOne_ can be set to true if one and only value has been selected in the field prior to setting the property. |
schemasNxFieldResourceId
objectProperties
qName optional string | Name of the field to get the resource id for. |
qResourceIds optional | Field level resource Id per table that the field is part of |
schemasNxFieldSelectionInfo
objectProperties
qName optional string | Name of the field. |
qFieldSelectionMode optional | No description |
schemasNxFieldSelectionMode
stringoneOf
NORMAL optional | SELECTION_MODE_NORMAL |
AND optional | SELECTION_MODE_AND |
NOT optional | SELECTION_MODE_NOT |
schemasNxFieldTableResourceId
objectProperties
qTable optional string | Name of the table that the field belongs to get the resource id for |
qResourceId optional string | Resource identifier for the field |
schemasNxFrequencyMode
stringoneOf
N optional | NX_FREQUENCY_NONE |
V optional | NX_FREQUENCY_VALUE |
P optional | NX_FREQUENCY_PERCENT |
R optional | NX_FREQUENCY_RELATIVE |
schemasNxGetBookmarkOptions
objectProperties
qTypes optional Array<string> | List of object types. |
qData optional | Contains dynamic JSON data specified by the client. |
qIncludePatches optional boolean | Include the bookmark patches. Patches can be very large and may make the list result unmanageable. |
schemasNxGetObjectOptions
objectProperties
qTypes optional Array<string> | List of object types. |
qIncludeSessionObjects optional, default=false boolean | Set to true to include session objects. The default value is false. |
qData optional | Contains dynamic JSON data specified by the client. |
schemasNxGroupTail
objectProperties
qUp optional integer<int32> | Number of elements that are part of the previous tail. This number depends on the paging, more particularly it depends on the values defined in qTop and qHeight . Is not shown if the value is 0. This parameter is optional. |
qDown optional integer<int32> | Number of elements that are part of the next tail. This number depends on the paging, more particularly it depends on the values defined in qTop and qHeight Is not shown if the value is 0. This parameter is optional. |
schemasNxGrpType
stringoneOf
N optional | GRP_NX_NONE |
H optional | GRP_NX_HIEARCHY |
C optional | GRP_NX_COLLECTION |
schemasNxHighlightRanges
objectProperties
qRanges optional | Ranges of highlighted values. |
schemasNxHypercubeMode
stringoneOf
S optional | DATA_MODE_STRAIGHT |
P optional | DATA_MODE_PIVOT |
K optional | DATA_MODE_PIVOT_STACK |
T optional | DATA_MODE_TREE |
D optional | DATA_MODE_DYNAMIC |
schemasNxInfo
objectProperties
qId optional string | Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional. |
qType optional string | Type of the object. This parameter is mandatory. |
schemasNxInlineDimensionDef
objectProperties
qGrouping optional | No description |
qFieldDefs optional Array<string> | Array of field names. When creating a grouped dimension, more than one field name is defined. This parameter is optional. |
qFieldLabels optional Array<string> | Array of field labels. This parameter is optional. |
qSortCriterias optional | Defines the sorting criteria in the field. Default is to sort by alphabetical order, ascending. This parameter is optional. |
qNumberPresentations optional | Defines the format of the value. This parameter is optional. |
qReverseSort optional boolean | If set to true, it inverts the sort criteria in the field. |
qActiveField optional integer<int32> | Index of the active field in a cyclic dimension. This parameter is optional. The default value is 0. This parameter is used in case of cyclic dimensions ( qGrouping is C). |
qLabelExpression optional string | Label expression. This parameter is optional. |
schemasNxInlineMeasureDef
objectProperties
qLabel optional string | Name of the measure. An empty string is returned as a default value. This parameter is optional. |
qDescription optional string | Description of the measure. An empty string is returned as a default value. This parameter is optional. |
qTags optional Array<string> | Name connected to the measure that is used for search purposes. A measure can have several tags. This parameter is optional. |
qGrouping optional | No description |
qDef optional string | Definition of the expression in the measure. Example: Sum (OrderTotal) This parameter is mandatory. |
qNumFormat optional | Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below. Formatting mechanismThe formatting mechanism depends on the type set in qType, as shown below: In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.
Type is DATE, TIME, TIMESTAMP or INTERVALThe following applies:
Type is INTEGERThe following applies:
Type is REALThe following applies:
Type is FIXThe following applies:
Type is MONEYThe following applies:
Type is ASCIINo formatting, qFmt is ignored. |
qRelative optional boolean | If set to true, percentage values are returned instead of absolute numbers. Default value is false. This parameter is optional. |
qBrutalSum optional boolean | If set to true, the sum of rows total should be used rather than real expression total. This parameter is optional and applies to straight tables. Default value is false. If using the Qlik Sense interface, it means that the total mode is set to Expression Total . |
qAggrFunc optional string | Aggregate function. For more information on the aggregate function syntax, see the section Working with Qlik Sense on the online help portal. The default value is 0 (Sum of rows) This parameter is optional. |
qAccumulate optional integer<int32> |
|
qReverseSort optional boolean | If set to true, it inverts the sort criteria in the field. |
qActiveExpression optional integer<int32> | Index of the active expression in a cyclic measure. The indexing starts from 0. The default value is 0. This parameter is optional. |
qExpressions optional Array<string> | Array of expressions. This parameter is used in case of cyclic measures ( qGrouping is C). List of the expressions in the cyclic group. |
qLabelExpression optional string | Label expression. This parameter is optional. |
schemasNxLTrendlineType
stringoneOf
AVERAGE optional | Average |
LINEAR optional | Linear |
POLYNOMIAL2 optional | Polynomial2 |
POLYNOMIAL3 optional | Polynomial3 |
POLYNOMIAL4 optional | Polynomial4 |
EXPONENTIAL optional | Exponential |
POWER optional | Power |
LOG optional | Logarithmic |
schemasNxLayoutErrors
objectProperties
qErrorCode optional integer<int32> | Error code. |
schemasNxLibraryDimension
objectProperties
qGrouping optional | No description |
qFieldDefs optional Array<string> | Array of dimension names. |
qFieldLabels optional Array<string> | Array of dimension labels. |
qLabelExpression optional string | No description |
schemasNxLibraryDimensionDef
objectProperties
qGrouping optional | No description |
qFieldDefs optional Array<string> | Array of dimension names. |
qFieldLabels optional Array<string> | Array of dimension labels. |
qLabelExpression optional string | No description |
schemasNxLibraryMeasure
objectInformation about the library measure. Is the layout for NxLibraryMeasureDef.
Properties
qLabel optional string | No description |
qDef optional string | No description |
qGrouping optional | No description |
qExpressions optional Array<string> | No description |
qActiveExpression optional integer<int32> | No description |
qLabelExpression optional string | No description |
qNumFormat optional | Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below. Formatting mechanismThe formatting mechanism depends on the type set in qType, as shown below: In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.
Type is DATE, TIME, TIMESTAMP or INTERVALThe following applies:
Type is INTEGERThe following applies:
Type is REALThe following applies:
Type is FIXThe following applies:
Type is MONEYThe following applies:
Type is ASCIINo formatting, qFmt is ignored. |
schemasNxLibraryMeasureDef
objectProperties
qLabel optional string | Label of the measure. |
qDef optional string | Definition of the measure. |
qGrouping optional | No description |
qExpressions optional Array<string> | Array of expressions. |
qActiveExpression optional integer<int32> | Index to the active expression in a measure. |
qLabelExpression optional string | Optional expression used for dynamic label. |
qNumFormat optional | Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below. Formatting mechanismThe formatting mechanism depends on the type set in qType, as shown below: In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.
Type is DATE, TIME, TIMESTAMP or INTERVALThe following applies:
Type is INTEGERThe following applies:
Type is REALThe following applies:
Type is FIXThe following applies:
Type is MONEYThe following applies:
Type is ASCIINo formatting, qFmt is ignored. |
schemasNxLinkedObjectInfo
objectProperties
qRootId optional string | Identifier of the root object. If the linked object is a child, the root identifier is the identifier of the parent. If the linked object is an app object, the root identifier is the same than the identifier of the linked object since the linked object is a root object. |
qInfo optional | No description |
schemasNxListObjectExpression
objectProperties
qExpr optional string | Value of the expression. |
qError optional | No description |
schemasNxListObjectExpressionDef
objectProperties
qExpr optional string | Value of the expression. |
qLibraryId optional string | Refers to an expression stored in the library. |
schemasNxLocalizedErrorCode
stringoneOf
LOCERR_INTERNAL_ERROR optional | No description |
LOCERR_GENERIC_UNKNOWN optional | No description |
LOCERR_GENERIC_OK optional | No description |
LOCERR_GENERIC_NOT_SET optional | No description |
LOCERR_GENERIC_NOT_FOUND optional | No description |
LOCERR_GENERIC_ALREADY_EXISTS optional | No description |
LOCERR_GENERIC_INVALID_PATH optional | No description |
LOCERR_GENERIC_ACCESS_DENIED optional | No description |
LOCERR_GENERIC_OUT_OF_MEMORY optional | No description |
LOCERR_GENERIC_NOT_INITIALIZED optional | No description |
LOCERR_GENERIC_INVALID_PARAMETERS optional | No description |
LOCERR_GENERIC_EMPTY_PARAMETERS optional | No description |
LOCERR_GENERIC_INTERNAL_ERROR optional | No description |
LOCERR_GENERIC_CORRUPT_DATA optional | No description |
LOCERR_GENERIC_MEMORY_INCONSISTENCY optional | No description |
LOCERR_GENERIC_INVISIBLE_OWNER_ABORT optional | No description |
LOCERR_GENERIC_PROHIBIT_VALIDATE optional | No description |
LOCERR_GENERIC_ABORTED optional | No description |
LOCERR_GENERIC_CONNECTION_LOST optional | No description |
LOCERR_GENERIC_UNSUPPORTED_IN_PRODUCT_VERSION optional | No description |
LOCERR_GENERIC_REST_CONNECTION_FAILURE optional | No description |
LOCERR_GENERIC_MEMORY_LIMIT_REACHED optional | No description |
LOCERR_GENERIC_NOT_IMPLEMENTED optional | No description |
LOCERR_HTTP_400 optional | No description |
LOCERR_HTTP_401 optional | No description |
LOCERR_HTTP_402 optional | No description |
LOCERR_HTTP_403 optional | No description |
LOCERR_HTTP_404 optional | No description |
LOCERR_HTTP_405 optional | No description |
LOCERR_HTTP_406 optional | No description |
LOCERR_HTTP_407 optional | No description |
LOCERR_HTTP_408 optional | No description |
LOCERR_HTTP_409 optional | No description |
LOCERR_HTTP_410 optional | No description |
LOCERR_HTTP_411 optional | No description |
LOCERR_HTTP_412 optional | No description |
LOCERR_HTTP_413 optional | No description |
LOCERR_HTTP_414 optional | No description |
LOCERR_HTTP_415 optional | No description |
LOCERR_HTTP_416 optional | No description |
LOCERR_HTTP_417 optional | No description |
LOCERR_HTTP_422 optional | No description |
LOCERR_HTTP_429 optional | No description |
LOCERR_HTTP_500 optional | No description |
LOCERR_HTTP_501 optional | No description |
LOCERR_HTTP_502 optional | No description |
LOCERR_HTTP_503 optional | No description |
LOCERR_HTTP_504 optional | No description |
LOCERR_HTTP_505 optional | No description |
LOCERR_HTTP_509 optional | No description |
LOCERR_HTTP_COULD_NOT_RESOLVE_HOST optional | No description |
LOCERR_APP_ALREADY_EXISTS optional | No description |
LOCERR_APP_INVALID_NAME optional | No description |
LOCERR_APP_ALREADY_OPEN optional | No description |
LOCERR_APP_NOT_FOUND optional | No description |
LOCERR_APP_IMPORT_FAILED optional | No description |
LOCERR_APP_SAVE_FAILED optional | No description |
LOCERR_APP_CREATE_FAILED optional | No description |
LOCERR_APP_INVALID optional | No description |
LOCERR_APP_CONNECT_FAILED optional | No description |
LOCERR_APP_ALREADY_OPEN_IN_DIFFERENT_MODE optional | No description |
LOCERR_APP_MIGRATION_COULD_NOT_CONTACT_MIGRATION_SERVICE optional | No description |
LOCERR_APP_MIGRATION_COULD_NOT_START_MIGRATION optional | No description |
LOCERR_APP_MIGRATION_FAILURE optional | No description |
LOCERR_APP_SCRIPT_MISSING optional | No description |
LOCERR_APP_EXPORT_FAILED optional | No description |
LOCERR_APP_SIZE_EXCEEDED optional | No description |
LOCERR_APP_DIRECT_QUERY_WORKLOAD_NOT_SUPPORTED optional | No description |
LOCERR_CONNECTION_ALREADY_EXISTS optional | No description |
LOCERR_CONNECTION_NOT_FOUND optional | No description |
LOCERR_CONNECTION_FAILED_TO_LOAD optional | No description |
LOCERR_CONNECTION_FAILED_TO_IMPORT optional | No description |
LOCERR_CONNECTION_NAME_IS_INVALID optional | No description |
LOCERR_CONNECTION_MISSING_CREDENTIALS optional | No description |
LOCERR_CONNECTOR_NO_FILE_STREAMING_SUPPORT optional | No description |
LOCERR_CONNECTOR_FILESIZE_EXCEEDED_BUFFER_SIZE optional | No description |
LOCERR_FILE_ACCESS_DENIED optional | No description |
LOCERR_FILE_NAME_INVALID optional | No description |
LOCERR_FILE_CORRUPT optional | No description |
LOCERR_FILE_NOT_FOUND optional | No description |
LOCERR_FILE_FORMAT_UNSUPPORTED optional | No description |
LOCERR_FILE_OPENED_IN_UNSUPPORTED_MODE optional | No description |
LOCERR_FILE_TABLE_NOT_FOUND optional | No description |
LOCERR_USER_ACCESS_DENIED optional | No description |
LOCERR_USER_IMPERSONATION_FAILED optional | No description |
LOCERR_SERVER_OUT_OF_SESSION_AND_USER_CALS optional | No description |
LOCERR_SERVER_OUT_OF_SESSION_CALS optional | No description |
LOCERR_SERVER_OUT_OF_USAGE_CALS optional | No description |
LOCERR_SERVER_OUT_OF_CALS optional | No description |
LOCERR_SERVER_OUT_OF_NAMED_CALS optional | No description |
LOCERR_SERVER_OFF_DUTY optional | No description |
LOCERR_SERVER_BUSY optional | No description |
LOCERR_SERVER_LICENSE_EXPIRED optional | No description |
LOCERR_SERVER_AJAX_DISABLED optional | No description |
LOCERR_SERVER_NO_TOKEN optional | No description |
LOCERR_HC_INVALID_OBJECT optional | No description |
LOCERR_HC_RESULT_TOO_LARGE optional | No description |
LOCERR_HC_INVALID_OBJECT_STATE optional | No description |
LOCERR_HC_MODAL_OBJECT_ERROR optional | No description |
LOCERR_CALC_INVALID_DEF optional | No description |
LOCERR_CALC_NOT_IN_LIB optional | No description |
LOCERR_CALC_HEAP_ERROR optional | No description |
LOCERR_CALC_TOO_LARGE optional | No description |
LOCERR_CALC_TIMEOUT optional | No description |
LOCERR_CALC_EVAL_CONDITION_FAILED optional | No description |
LOCERR_CALC_MIXED_LINKED_AGGREGATION optional | No description |
LOCERR_CALC_MISSING_LINKED optional | No description |
LOCERR_CALC_INVALID_COL_SORT optional | No description |
LOCERR_CALC_PAGES_TOO_LARGE optional | No description |
LOCERR_CALC_SEMANTIC_FIELD_NOT_ALLOWED optional | No description |
LOCERR_CALC_VALIDATION_STATE_INVALID optional | No description |
LOCERR_CALC_PIVOT_DIMENSIONS_ALREADY_EXISTS optional | No description |
LOCERR_CALC_MISSING_LINKED_FIELD optional | No description |
LOCERR_CALC_NOT_CALCULATED optional | No description |
LOCERR_LAYOUT_EXTENDS_INVALID_ID optional | No description |
LOCERR_LAYOUT_LINKED_OBJECT_NOT_FOUND optional | No description |
LOCERR_LAYOUT_LINKED_OBJECT_INVALID optional | No description |
LOCERR_PERSISTENCE_WRITE_FAILED optional | No description |
LOCERR_PERSISTENCE_READ_FAILED optional | No description |
LOCERR_PERSISTENCE_DELETE_FAILED optional | No description |
LOCERR_PERSISTENCE_NOT_FOUND optional | No description |
LOCERR_PERSISTENCE_UNSUPPORTED_VERSION optional | No description |
LOCERR_PERSISTENCE_MIGRATION_FAILED_READ_ONLY optional | No description |
LOCERR_PERSISTENCE_MIGRATION_CANCELLED optional | No description |
LOCERR_PERSISTENCE_MIGRATION_BACKUP_FAILED optional | No description |
LOCERR_PERSISTENCE_DISK_FULL optional | No description |
LOCERR_PERSISTENCE_NOT_SUPPORTED_FOR_SESSION_APP optional | No description |
LOCERR_PERSISTENCE_MOVE_FAILED optional | No description |
LOCERR_PERSISTENCE_SYNC_SET_CHUNK_INVALID_PARAMETERS optional | No description |
LOCERR_PERSISTENCE_SYNC_GET_CHUNK_INVALID_PARAMETERS optional | No description |
LOCERR_SCRIPT_DATASOURCE_ACCESS_DENIED optional | No description |
LOCERR_RELOAD_IN_PROGRESS optional | No description |
LOCERR_RELOAD_TABLE_X_NOT_FOUND optional | No description |
LOCERR_RELOAD_UNKNOWN_STATEMENT optional | No description |
LOCERR_RELOAD_EXPECTED_SOMETHING_FOUND_UNKNOWN optional | No description |
LOCERR_RELOAD_EXPECTED_NOTHING_FOUND_UNKNOWN optional | No description |
LOCERR_RELOAD_EXPECTED_ONE_OF_1_TOKENS_FOUND_UNKNOWN optional | No description |
LOCERR_RELOAD_EXPECTED_ONE_OF_2_TOKENS_FOUND_UNKNOWN optional | No description |
LOCERR_RELOAD_EXPECTED_ONE_OF_3_TOKENS_FOUND_UNKNOWN optional | No description |
LOCERR_RELOAD_EXPECTED_ONE_OF_4_TOKENS_FOUND_UNKNOWN optional | No description |
LOCERR_RELOAD_EXPECTED_ONE_OF_5_TOKENS_FOUND_UNKNOWN optional | No description |
LOCERR_RELOAD_EXPECTED_ONE_OF_6_TOKENS_FOUND_UNKNOWN optional | No description |
LOCERR_RELOAD_EXPECTED_ONE_OF_7_TOKENS_FOUND_UNKNOWN optional | No description |
LOCERR_RELOAD_EXPECTED_ONE_OF_8_OR_MORE_TOKENS_FOUND_UNKNOWN optional | No description |
LOCERR_RELOAD_FIELD_X_NOT_FOUND optional | No description |
LOCERR_RELOAD_MAPPING_TABLE_X_NOT_FOUND optional | No description |
LOCERR_RELOAD_LIB_CONNECTION_X_NOT_FOUND optional | No description |
LOCERR_RELOAD_NAME_ALREADY_TAKEN optional | No description |
LOCERR_RELOAD_WRONG_FILE_FORMAT_DIF optional | No description |
LOCERR_RELOAD_WRONG_FILE_FORMAT_BIFF optional | No description |
LOCERR_RELOAD_WRONG_FILE_FORMAT_ENCRYPTED optional | No description |
LOCERR_RELOAD_OPEN_FILE_ERROR optional | No description |
LOCERR_RELOAD_AUTO_GENERATE_COUNT optional | No description |
LOCERR_RELOAD_PE_ILLEGAL_PREFIX_COMB optional | No description |
LOCERR_RELOAD_MATCHING_CONTROL_STATEMENT_ERROR optional | No description |
LOCERR_RELOAD_MATCHING_LIBPATH_X_NOT_FOUND optional | No description |
LOCERR_RELOAD_MATCHING_LIBPATH_X_INVALID optional | No description |
LOCERR_RELOAD_MATCHING_LIBPATH_X_OUTSIDE optional | No description |
LOCERR_RELOAD_NO_QUALIFIED_PATH_FOR_FILE optional | No description |
LOCERR_RELOAD_MODE_STATEMENT_ONLY_FOR_LIB_PATHS optional | No description |
LOCERR_RELOAD_INCONSISTENT_USE_OF_SEMANTIC_FIELDS optional | No description |
LOCERR_RELOAD_NO_OPEN_DATABASE optional | No description |
LOCERR_RELOAD_AGGREGATION_REQUIRED_BY_GROUP_BY optional | No description |
LOCERR_RELOAD_CONNECT_MUST_USE_LIB_PREFIX_IN_THIS_MODE optional | No description |
LOCERR_RELOAD_ODBC_CONNECT_FAILED optional | No description |
LOCERR_RELOAD_OLEDB_CONNECT_FAILED optional | No description |
LOCERR_RELOAD_CUSTOM_CONNECT_FAILED optional | No description |
LOCERR_RELOAD_ODBC_READ_FAILED optional | No description |
LOCERR_RELOAD_OLEDB_READ_FAILED optional | No description |
LOCERR_RELOAD_CUSTOM_READ_FAILED optional | No description |
LOCERR_RELOAD_BINARY_LOAD_PROHIBITED optional | No description |
LOCERR_RELOAD_CONNECTOR_START_FAILED optional | No description |
LOCERR_RELOAD_CONNECTOR_NOT_RESPONDING optional | No description |
LOCERR_RELOAD_CONNECTOR_REPLY_ERROR optional | No description |
LOCERR_RELOAD_CONNECTOR_CONNECT_ERROR optional | No description |
LOCERR_RELOAD_CONNECTOR_NOT_FOUND_ERROR optional | No description |
LOCERR_RELOAD_INPUT_FIELD_WITH_DUPLICATE_KEYS optional | No description |
LOCERR_RELOAD_CONCATENATE_LOAD_NO_PREVIOUS_TABLE optional | No description |
LOCERR_RELOAD_WRONG_FILE_FORMAT_QVD optional | No description |
LOCERR_RELOAD_ACTION_BLOCKED_ENTITLEMENT optional | No description |
LOCERR_PERSONAL_NEW_VERSION_AVAILABLE optional | No description |
LOCERR_PERSONAL_VERSION_EXPIRED optional | No description |
LOCERR_PERSONAL_SECTION_ACCESS_DETECTED optional | No description |
LOCERR_PERSONAL_APP_DELETION_FAILED optional | No description |
LOCERR_USER_AUTHENTICATION_FAILURE optional | No description |
LOCERR_EXPORT_OUT_OF_MEMORY optional | No description |
LOCERR_EXPORT_NO_DATA optional | No description |
LOCERR_SYNC_INVALID_OFFSET optional | No description |
LOCERR_SEARCH_TIMEOUT optional | No description |
LOCERR_DIRECT_DISCOVERY_LINKED_EXPRESSION_FAIL optional | No description |
LOCERR_DIRECT_DISCOVERY_ROWCOUNT_OVERFLOW optional | No description |
LOCERR_DIRECT_DISCOVERY_EMPTY_RESULT optional | No description |
LOCERR_DIRECT_DISCOVERY_DB_CONNECTION_FAILED optional | No description |
LOCERR_DIRECT_DISCOVERY_MEASURE_NOT_ALLOWED optional | No description |
LOCERR_DIRECT_DISCOVERY_DETAIL_NOT_ALLOWED optional | No description |
LOCERR_DIRECT_DISCOVERY_NOT_SYNTH_CIRCULAR_ALLOWED optional | No description |
LOCERR_DIRECT_DISCOVERY_ONLY_ONE_DD_TABLE_ALLOWED optional | No description |
LOCERR_DIRECT_DISCOVERY_DB_AUTHORIZATION_FAILED optional | No description |
LOCERR_SMART_LOAD_TABLE_NOT_FOUND optional | No description |
LOCERR_SMART_LOAD_TABLE_DUPLICATED optional | No description |
LOCERR_VARIABLE_NO_NAME optional | No description |
LOCERR_VARIABLE_DUPLICATE_NAME optional | No description |
LOCERR_VARIABLE_INCONSISTENCY optional | No description |
LOCERR_MEDIA_LIBRARY_LIST_FAILED optional | No description |
LOCERR_MEDIA_LIBRARY_CONTENT_FAILED optional | No description |
LOCERR_MEDIA_BUNDLING_FAILED optional | No description |
LOCERR_MEDIA_UNBUNDLING_FAILED optional | No description |
LOCERR_MEDIA_LIBRARY_NOT_FOUND optional | No description |
LOCERR_FEATURE_DISABLED optional | No description |
LOCERR_JSON_RPC_INVALID_REQUEST optional | No description |
LOCERR_JSON_RPC_METHOD_NOT_FOUND optional | No description |
LOCERR_JSON_RPC_INVALID_PARAMETERS optional | No description |
LOCERR_JSON_RPC_INTERNAL_ERROR optional | No description |
LOCERR_JSON_RPC_PARSE_ERROR optional | No description |
LOCERR_MQ_SOCKET_CONNECT_FAILURE optional | No description |
LOCERR_MQ_SOCKET_OPEN_FAILURE optional | No description |
LOCERR_MQ_PROTOCOL_NO_RESPONE optional | No description |
LOCERR_MQ_PROTOCOL_LIBRARY_EXCEPTION optional | No description |
LOCERR_MQ_PROTOCOL_CONNECTION_CLOSED optional | No description |
LOCERR_MQ_PROTOCOL_CHANNEL_CLOSED optional | No description |
LOCERR_MQ_PROTOCOL_UNKNOWN_ERROR optional | No description |
LOCERR_MQ_PROTOCOL_INVALID_STATUS optional | No description |
LOCERR_EXTENGINE_GRPC_STATUS_OK optional | No description |
LOCERR_EXTENGINE_GRPC_STATUS_CANCELLED optional | No description |
LOCERR_EXTENGINE_GRPC_STATUS_UNKNOWN optional | No description |
LOCERR_EXTENGINE_GRPC_STATUS_INVALID_ARGUMENT optional | No description |
LOCERR_EXTENGINE_GRPC_STATUS_DEADLINE_EXCEEDED optional | No description |
LOCERR_EXTENGINE_GRPC_STATUS_NOT_FOUND optional | No description |
LOCERR_EXTENGINE_GRPC_STATUS_ALREADY_EXISTS optional | No description |
LOCERR_EXTENGINE_GRPC_STATUS_PERMISSION_DENIED optional | No description |
LOCERR_EXTENGINE_GRPC_STATUS_RESOURCE_EXHAUSTED optional | No description |
LOCERR_EXTENGINE_GRPC_STATUS_FAILED_PRECONDITION optional | No description |
LOCERR_EXTENGINE_GRPC_STATUS_ABORTED optional | No description |
LOCERR_EXTENGINE_GRPC_STATUS_OUT_OF_RANGE optional | No description |
LOCERR_EXTENGINE_GRPC_STATUS_UNIMPLEMENTED optional | No description |
LOCERR_EXTENGINE_GRPC_STATUS_INTERNAL optional | No description |
LOCERR_EXTENGINE_GRPC_STATUS_UNAVAILABLE optional | No description |
LOCERR_EXTENGINE_GRPC_STATUS_DATA_LOSS optional | No description |
LOCERR_EXTENGINE_GRPC_STATUS_UNAUTHENTICATED optional | No description |
LOCERR_LXW_INVALID_OBJ optional | No description |
LOCERR_LXW_INVALID_FILE optional | No description |
LOCERR_LXW_INVALID_SHEET optional | No description |
LOCERR_LXW_INVALID_EXPORT_RANGE optional | No description |
LOCERR_LXW_ERROR optional | No description |
LOCERR_LXW_ERROR_MEMORY_MALLOC_FAILED optional | No description |
LOCERR_LXW_ERROR_CREATING_XLSX_FILE optional | No description |
LOCERR_LXW_ERROR_CREATING_TMPFILE optional | No description |
LOCERR_LXW_ERROR_ZIP_FILE_OPERATION optional | No description |
LOCERR_LXW_ERROR_ZIP_FILE_ADD optional | No description |
LOCERR_LXW_ERROR_ZIP_CLOSE optional | No description |
LOCERR_LXW_ERROR_NULL_PARAMETER_IGNORED optional | No description |
LOCERR_LXW_ERROR_MAX_STRING_LENGTH_EXCEEDED optional | No description |
LOCERR_LXW_ERROR_255_STRING_LENGTH_EXCEEDED optional | No description |
LOCERR_LXW_ERROR_SHARED_STRING_INDEX_NOT_FOUND optional | No description |
LOCERR_LXW_ERROR_WORKSHEET_INDEX_OUT_OF_RANGE optional | No description |
LOCERR_LXW_ERROR_WORKSHEET_MAX_NUMBER_URLS_EXCEEDED optional | No description |
LOCERR_BDI_STATUS_OK optional | No description |
LOCERR_BDI_GENERIC_ERROR_NOT_TRANSLATED optional | No description |
LOCERR_TRENDLINE_INVALID_DEF optional | No description |
LOCERR_TRENDLINE_INVALID_MATH_ERROR optional | No description |
LOCERR_CURL_UNSUPPORTED_PROTOCOL optional | No description |
LOCERR_CURL_COULDNT_RESOLVE_PROXY optional | No description |
LOCERR_CURL_COULDNT_CONNECT optional | No description |
LOCERR_CURL_REMOTE_ACCESS_DENIED optional | No description |
LOCERR_CURL_FTP_ACCEPT_FAILED optional | No description |
LOCERR_CURL_FTP_ACCEPT_TIMEOUT optional | No description |
LOCERR_CURL_FTP_CANT_GET_HOST optional | No description |
LOCERR_CURL_PARTIAL_FILE optional | No description |
LOCERR_CURL_QUOTE_ERROR optional | No description |
LOCERR_CURL_WRITE_ERROR optional | No description |
LOCERR_CURL_UPLOAD_FAILED optional | No description |
LOCERR_CURL_OUT_OF_MEMORY optional | No description |
LOCERR_CURL_OPERATION_TIMEDOUT optional | No description |
LOCERR_CURL_FTP_COULDNT_USE_REST optional | No description |
LOCERR_CURL_HTTP_POST_ERROR optional | No description |
LOCERR_CURL_SSL_CONNECT_ERROR optional | No description |
LOCERR_CURL_FILE_COULDNT_READ_FILE optional | No description |
LOCERR_CURL_LDAP_CANNOT_BIND optional | No description |
LOCERR_CURL_LDAP_SEARCH_FAILED optional | No description |
LOCERR_CURL_TOO_MANY_REDIRECTS optional | No description |
LOCERR_CURL_PEER_FAILED_VERIFICATION optional | No description |
LOCERR_CURL_GOT_NOTHING optional | No description |
LOCERR_CURL_SSL_ENGINE_NOTFOUND optional | No description |
LOCERR_CURL_SSL_ENGINE_SETFAILED optional | No description |
LOCERR_CURL_SSL_CERTPROBLEM optional | No description |
LOCERR_CURL_SSL_CIPHER optional | No description |
LOCERR_CURL_SSL_CACERT optional | No description |
LOCERR_CURL_BAD_CONTENT_ENCODING optional | No description |
LOCERR_CURL_LDAP_INVALID_URL optional | No description |
LOCERR_CURL_USE_SSL_FAILED optional | No description |
LOCERR_CURL_SSL_ENGINE_INITFAILED optional | No description |
LOCERR_CURL_LOGIN_DENIED optional | No description |
LOCERR_CURL_TFTP_NOTFOUND optional | No description |
LOCERR_CURL_TFTP_ILLEGAL optional | No description |
LOCERR_CURL_SSH optional | No description |
LOCERR_SETEXPRESSION_TOO_LARGE optional | No description |
LOCERR_RELOAD_MERGE_LOAD_ERROR optional | No description |
LOCERR_WIN_FTP_DROPPED optional | No description |
LOCERR_WIN_FTP_NO_PASSIVE_MODE optional | No description |
LOCERR_WIN_HTTP_DOWNLEVEL_SERVER optional | No description |
LOCERR_WIN_HTTP_INVALID_SERVER_RESPONSE optional | No description |
LOCERR_WIN_HTTP_REDIRECT_NEEDS_CONFIRMATION optional | No description |
LOCERR_WIN_INTERNET_FORCE_RETRY optional | No description |
LOCERR_WIN_INTERNET_CANNOT_CONNECT optional | No description |
LOCERR_WIN_INTERNET_CONNECTION_ABORTED optional | No description |
LOCERR_WIN_INTERNET_CONNECTION_RESET optional | No description |
LOCERR_WIN_INTERNET_DISCONNECTED optional | No description |
LOCERR_WIN_INTERNET_INCORRECT_FORMAT optional | No description |
LOCERR_WIN_INTERNET_INVALID_CA optional | No description |
LOCERR_WIN_INTERNET_INVALID_OPERATION optional | No description |
LOCERR_WIN_INTERNET_INVALID_URL optional | No description |
LOCERR_WIN_INTERNET_ITEM_NOT_FOUND optional | No description |
LOCERR_WIN_INTERNET_LOGIN_FAILURE optional | No description |
LOCERR_WIN_INTERNET_NAME_NOT_RESOLVED optional | No description |
LOCERR_WIN_INTERNET_NEED_UI optional | No description |
LOCERR_WIN_INTERNET_SEC_CERT_CN_INVALID optional | No description |
LOCERR_WIN_INTERNET_SEC_CERT_DATE_INVALID optional | No description |
LOCERR_WIN_INTERNET_SEC_CERT_ERRORS optional | No description |
LOCERR_WIN_INTERNET_SEC_INVALID_CERT optional | No description |
LOCERR_WIN_INTERNET_SERVER_UNREACHABLE optional | No description |
schemasNxLocalizedWarningCode
stringoneOf
LOCWARN_PERSONAL_RELOAD_REQUIRED optional | No description |
LOCWARN_PERSONAL_VERSION_EXPIRES_SOON optional | No description |
LOCWARN_EXPORT_DATA_TRUNCATED optional | No description |
LOCWARN_COULD_NOT_OPEN_ALL_OBJECTS optional | No description |
LOCWARN_SEARCH_INVALID_SEARCHFIELD_DETECTED optional | No description |
schemasNxMatchingFieldInfo
objectProperties
qName optional string | Name of the field. |
qTags optional Array<string> | List of tags. |
schemasNxMatchingFieldMode
stringoneOf
MATCHINGFIELDMODE_MATCH_ALL optional | No description |
MATCHINGFIELDMODE_MATCH_ONE optional | No description |
schemasNxMeasure
objectProperties
qLibraryId optional string | Refers to a measure stored in the library. |
qDef optional | No description |
qSortBy optional | No description |
qAttributeExpressions optional | List of attribute expressions. |
qAttributeDimensions optional | List of attribute dimensions. |
qCalcCond optional | No description |
qCalcCondition optional | No description |
qTrendLines optional | Specifies trendlines for this measure. |
qMiniChartDef optional | No description |
schemasNxMeasureInfo
objectLayout for NxInlineMeasureDef.
Properties
qFallbackTitle optional string | Corresponds to the label of the measure. If the label is not defined then the measure name is used. |
qApprMaxGlyphCount optional integer<int32> | Length of the longest value in the field. |
qCardinal optional integer<int32> | Number of distinct field values. |
qSortIndicator optional | No description |
qNumFormat optional | Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below. Formatting mechanismThe formatting mechanism depends on the type set in qType, as shown below: In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.
Type is DATE, TIME, TIMESTAMP or INTERVALThe following applies:
Type is INTEGERThe following applies:
Type is REALThe following applies:
Type is FIXThe following applies:
Type is MONEYThe following applies:
Type is ASCIINo formatting, qFmt is ignored. |
qMin optional number<double> | Lowest value in the range. |
qMax optional number<double> | Highest value in the range. |
qError optional | No description |
qReverseSort optional boolean | If set to true, it inverts the sort criteria in the field. |
qIsAutoFormat optional boolean | This parameter is set to true if qNumFormat is set to U (unknown). The engine guesses the type of the field based on the field's expression. |
qAttrExprInfo optional | List of attribute expressions. |
qAttrDimInfo optional | List of attribute dimensions. |
qCalcCondMsg optional string | The message displayed if calculation condition is not fulfilled. |
qLibraryId optional string | Refers to a dimension stored in the library. |
qTrendLines optional | Calculated trendlines |
qMiniChart optional | No description |
schemasNxMeta
objectLayout for NxMetaDef.
Properties
qName optional string | Name. This property is optional. |
schemasNxMetaDef
objectUsed to collect meta data.
Properties
Semantic type with an empty structure.
schemasNxMiniChart
objectProperties
qYMin optional number<double> | No description |
qYMax optional number<double> | No description |
qXMin optional number<double> | No description |
qXMax optional number<double> | No description |
qAttrExprInfo optional | List of attribute expressions. |
qError optional | No description |
schemasNxMiniChartCell
objectProperties
qText optional string | Some text. |
qNum optional number<double> | A value. This parameter is optional. |
qElemNumber optional integer<int32> | Rank number of the value, starting from 0. If the element number is a negative number, it means that the returned value is not an element number. You can get the following negative values:
|
qAttrExps optional | No description |
schemasNxMiniChartData
objectProperties
qMatrix optional Array<Array<NxMiniChartCell>> | Array of data. |
qMin optional number<double> | No description |
qMax optional number<double> | No description |
qError optional | No description |
schemasNxMiniChartDef
objectProperties
qDef optional string | Expression or field name. |
qLibraryId optional string | LibraryId for dimension. |
qSortBy optional | No description |
qOtherTotalSpec optional | No description |
qMaxNumberPoints optional, default=-1 integer<int32> | No description |
qAttributeExpressions optional | List of attribute expressions. |
qNullSuppression optional boolean | If set to true, no null values are returned. |
schemasNxMiniChartRows
Array<NxMiniChartCell>schemasNxMultiRangeSelectInfo
objectProperties
qRanges optional | No description |
qColumnsToSelect optional Array<integer<int32>> | No description |
schemasNxPage
objectProperties
qLeft optional integer<int32> | Position from the left. Corresponds to the first column. |
qTop optional integer<int32> | Position from the top. Corresponds to the first row. |
qWidth optional integer<int32> | Number of columns in the page. The indexing of the columns may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ). |
qHeight optional integer<int32> | Number of rows or elements in the page. The indexing of the rows may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ). |
schemasNxPageTreeLevel
objectProperties
qLeft optional integer<int32> | The first dimension that is to be part of the tree, counted from the left. For example, if qLeft is equal to 1, omit nodes from the first dimension in the current sort order. |
qDepth optional, default=-1 integer<int32> | Number of dimensions to include in the tree. |
schemasNxPageTreeNode
objectDefines an area of the tree to be fetched.
Properties
qArea optional | No description |
qAllValues optional boolean | When set to true, generated nodes (based on current selection) will be inserted into the returned tree even when there is no actual value. For example, suppose you are looking for hybrid car sales at all car dealerships. Normally, only dealerships where hybrid cars are sold would be part of the returned tree but with qAllValues set to true, all available dealerships will be included regardless if they sold any hybrid cars or not. |
schemasNxPatch
objectProperties
qOp optional | No description |
qPath optional string | Path to the property to add, remove or replace. |
qValue optional string | This parameter is not used in a remove operation. Corresponds to the value of the property to add or to the new value of the property to update. Examples: "false", "2", ""New title"" |
schemasNxPatchOperationType
stringoneOf
add optional | Add |
remove optional | Remove |
replace optional | Replace |
schemasNxPatches
objectProperties
qInfo optional | No description |
qPatches optional | Array with patches. |
qChildren optional | Array with child objects and their patches. |
schemasNxPivotDimensionCell
objectProperties
qText optional string | Some text. |
qElemNo optional integer<int32> | Rank number of the value. If set to -1, it means that the value is not an element number. |
qValue optional number<double> | Value of the cell. Is set to NaN , if the value is not a number. |
qCanExpand optional boolean | If set to true, it means that the cell can be expanded. This parameter is not returned if it is set to false. |
qCanCollapse optional boolean | If set to true, it means that the cell can be collapsed. This parameter is not returned if it is set to false. |
qType optional | No description |
qUp optional integer<int32> | Number of elements that are part of the previous tail. This number depends on the paging, more particularly it depends on the values defined in qTop and qHeight . |
qDown optional integer<int32> | Number of elements that are part of the next tail. This number depends on the paging, more particularly it depends on the values defined in qTop and qHeight . |
qSubNodes optional | Information about sub nodes (or sub cells). The array is empty [ ] when there is no sub nodes. |
qAttrExps optional | No description |
qAttrDims optional | No description |
schemasNxPivotPage
objectProperties
qLeft optional | Information about the left dimension values of a pivot table. |
qTop optional | Information about the top dimension values of a pivot table. If there is no top dimension in the pivot table, information about the measures are given. |
qData optional Array<Array<NxPivotValuePoint>> | Array of data. |
qArea optional | No description |
schemasNxPivotValuePoint
objectProperties
qLabel optional string | Label of the cell. This parameter is optional. |
qText optional string | Some text related to the cell. |
qNum optional number<double> | Value of the cell. |
qType optional | No description |
qAttrExps optional | No description |
qAttrDims optional | No description |
schemasNxRange
objectProperties
qFrom optional integer<int32> | Position in the expression of the first character of the field name. |
qCount optional integer<int32> | Number of characters in the field name. |
schemasNxRangeSelectInfo
objectProperties
qRange optional | No description |
qMeasureIx optional integer<int32> | Number of the measure to select. Numbering starts from 0. |
schemasNxSelectionCell
objectProperties
qType optional | No description |
qCol optional integer<int32> | Column index to select. Indexing starts from 0. If the cell's type is:
|
qRow optional integer<int32> | Row index to select. Indexing starts from 0. If the cell's type is:
|
schemasNxSelectionCellType
stringoneOf
D optional | NX_CELL_DATA |
T optional | NX_CELL_TOP |
L optional | NX_CELL_LEFT |
schemasNxSelectionInfo
objectProperties
qInSelections optional boolean | Is set to true if the visualization is in selection mode. For more information about the selection mode, see BeginSelections Method. |
qMadeSelections optional boolean | Is set to true if the visualization is in selection mode and if some selections have been made while in selection mode. For more information about the selection mode, see BeginSelections Method. |
schemasNxSimpleDimValue
objectProperties
qText optional string | Text related to the attribute expression value. This property is optional. No text is returned if the attribute expression value is a numeric. |
qElemNo optional integer<int32> | Element number. |
schemasNxSimpleValue
objectProperties
qText optional string | Text related to the attribute expression value. |
qNum optional number<double> | Numeric value of the attribute expression. Set to NaN (Not a Number) if the attribute expression value is not numeric. |
schemasNxSortIndicatorType
stringoneOf
N optional | NX_SORT_INDICATE_NONE |
A optional | NX_SORT_INDICATE_ASC |
D optional | NX_SORT_INDICATE_DESC |
schemasNxStackPage
objectProperties
qData optional | Array of data. |
qArea optional | No description |
schemasNxStackedPivotCell
objectProperties
qText optional string | Some text. |
qElemNo optional integer<int32> | Rank number of the value. If set to -1, it means that the value is not an element number. |
qValue optional number<double> | Value of the cell. Is set to NaN , if the value is not a number. |
qCanExpand optional boolean | If set to true, it means that the cell can be expanded. This parameter is not returned if it is set to false. |
qCanCollapse optional boolean | If set to true, it means that the cell can be collapsed. This parameter is not returned if it is set to false. |
qType optional | No description |
qMaxPos optional number<double> | Total of the positive values in the current group of cells. |
qMinNeg optional number<double> | Total of the negative values in the current group of cells. |
qUp optional integer<int32> | Number of elements that are part of the previous tail. |
qDown optional integer<int32> | Number of elements that are part of the next tail. |
qRow optional integer<int32> | Row index in the data matrix. The indexing starts from 0. |
qSubNodes optional | Information about sub nodes (or sub cells). The array is empty [ ] when there are no sub nodes. |
qAttrExps optional | No description |
qAttrDims optional | No description |
schemasNxStateCounts
objectProperties
qLocked optional integer<int32> | Number of values in locked state. |
qSelected optional integer<int32> | Number of values in selected state. |
qOption optional integer<int32> | Number of values in optional state. |
qDeselected optional integer<int32> | Number of values in deselected state. |
qAlternative optional integer<int32> | Number of values in alternative state. |
qExcluded optional integer<int32> | Number of values in excluded state. |
qSelectedExcluded optional integer<int32> | Number of values in selected excluded state. |
qLockedExcluded optional integer<int32> | Number of values in locked excluded state. |
schemasNxStreamListEntry
objectProperties
qName optional string | Name of the stream. |
qId optional string | Identifier of the stream. |
schemasNxTempBookmarkOptions
objectProperties
qIncludeVariables optional boolean | IncludeVariables If true all variables will be stored in the temporary bookmark |
qIncludeAllPatches optional boolean | IncludeAllPatches If true all patches will be stored in the temporary bookmark, if false ObjectIdsToPatch will determine what patches to include |
schemasNxTickCell
objectProperties
qText optional string | Tick's label. |
qStart optional number<double> | Start value. |
qEnd optional number<double> | End value. |
schemasNxTreeDataOption
objectSpecifies all the paging filters needed to define the tree to be fetched.
Properties
qMaxNbrOfNodes optional integer<int32> | Maximum number of nodes in the tree. If this limit is exceeded, no nodes are returned. All nodes are counted. |
qTreeNodes optional | Defines areas of the tree to be fetched. Areas must be defined left to right. |
qTreeLevels optional | No description |
schemasNxTreeDimensionDef
objectProperties
qLibraryId optional string | Refers to a dimension stored in the library. |
qDef optional | No description |
qValueExprs optional | List of measures. |
qNullSuppression optional boolean | If set to true, no null values are returned. |
qOtherTotalSpec optional | No description |
qShowAll optional boolean | If set to true, all dimension values are shown. |
qOtherLabel optional | No description |
qTotalLabel optional | No description |
qCalcCondition optional | No description |
qAttributeExpressions optional | List of attribute expressions. |
qAttributeDimensions optional | List of attribute dimensions. |
schemasNxTreeDimensionInfo
objectProperties
qFallbackTitle optional string | Corresponds to the label of the dimension that is selected. If the label is not defined then the field name is used. |
qApprMaxGlyphCount optional integer<int32> | Length of the longest value in the field. |
qCardinal deprecated optional integer<int32> | Number of distinct field values. |
qLocked optional boolean | Is set to true if the field is locked. |
qSortIndicator optional | No description |
qGroupFallbackTitles optional Array<string> | Array of dimension labels. Contains the labels of all dimensions in a hierarchy group (for example the labels of all dimensions in a drill down group). |
qGroupPos optional integer<int32> | Index of the dimension that is currently in use. qGroupPos is set to 0 if there are no hierarchical groups (drill-down groups) or cycle groups. |
qStateCounts optional | No description |
qTags optional Array<string> | Gives information on a field. For example, it can return the type of the field. Examples: key, text, ASCII |
qError optional | No description |
qDimensionType optional | No description |
qReverseSort optional boolean | If set to true, it inverts the sort criteria in the field. |
qGrouping optional | No description |
qIsSemantic optional boolean | If set to true, it means that the field is a semantic. |
qNumFormat optional | Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below. Formatting mechanismThe formatting mechanism depends on the type set in qType, as shown below: In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.
Type is DATE, TIME, TIMESTAMP or INTERVALThe following applies:
Type is INTEGERThe following applies:
Type is REALThe following applies:
Type is FIXThe following applies:
Type is MONEYThe following applies:
Type is ASCIINo formatting, qFmt is ignored. |
qIsAutoFormat optional boolean | This parameter is set to true if qNumFormat is set to U (unknown). The engine guesses the type of the field based on the field's definition. |
qGroupFieldDefs optional Array<string> | Array of field names. |
qMin optional number<double> | Minimum value. |
qMax optional number<double> | Maximum value. |
qContinuousAxes optional boolean | Is continuous axis used. |
qIsCyclic optional boolean | Is a cyclic dimension used. |
qDerivedField optional boolean | Is derived field is used as a dimension. |
qMeasureInfo optional | A List of measures to be calculated on this TreeDimension. |
qAttrExprInfo optional | List of attribute expressions. |
qAttrDimInfo optional | List of attribute dimensions. |
qCalcCondMsg optional string | The message displayed if calculation condition is not fulfilled. |
qIsCalculated optional, default=false boolean | True if this is a calculated dimension. |
qIsOneAndOnlyOne optional boolean | If set to true, it means that the field always has one and only one selected value. |
qCardinalities optional | No description |
qLibraryId optional string | Refers to a dimension stored in the library. |
schemasNxTreeMultiRangeSelectInfo
objectProperties
qRanges optional | An array of Ranges. |
schemasNxTreeNode
objectRepresents a dimension in the tree.
Properties
qText optional string | The text version of the value, if available. |
qValue optional number<double> | Value of the cell. Is set to NaN , if the value is not a number. |
qElemNo optional integer<int32> | Element number. |
qGroupPos optional integer<int32> | The position of this node inside it's group in the complete tree, i.e. Not dependant om what part is fetched. |
qGroupSize optional integer<int32> | Nbr of nodes connected to this node on the next level of the tree. Not dependant on what part is fetched. |
qRow optional integer<int32> | Row index in the data matrix. The indexing starts from 0. |
qType optional | No description |
qValues optional | The measures for this node. |
qNodes optional | The children of this node in the fetched tree structure. |
qAttrExps optional | No description |
qAttrDims optional | No description |
qMaxPos optional Array<number<double>> | Total of the positive values in the current group of cells. |
qMinNeg optional Array<number<double>> | Total of the negative values in the current group of cells. |
qCanExpand optional boolean | If set to true, it means that the cell can be expanded. This parameter is not returned if it is set to false. |
qCanCollapse optional boolean | If set to true, it means that the cell can be collapsed. This parameter is not returned if it is set to false. |
qState optional | No description |
qTreePath optional Array<integer<int32>> | The GroupPos of all prior nodes connected to this one, one position for each level of the tree. If this node is attached directly to the root, this array is empty. |
schemasNxTreeRangeSelectInfo
objectProperties
qRange optional | No description |
qMeasureIx optional integer<int32> | Number of the measure to select. Numbering starts from 0. |
qDimensionIx optional integer<int32> | Number of the dimension to select measure from. Numbering starts from 0. |
schemasNxTreeValue
objectRepresents a measure.
Properties
qText optional string | The text version of the value, if available. |
qValue optional number<double> | Value of the cell. Is set to NaN , if the value is not a number. |
qAttrExps optional | No description |
qAttrDims optional | No description |
schemasNxTrendline
objectInformation about the calculated trendline.
Properties
qType optional | No description |
qError optional | No description |
qCoeff optional Array<number<double>> | Coefficent c0..cN depending on the trendline type. |
qR2 optional number<double> | R2 score. Value between 0..1 that shows the correlation between the trendline and the data. Higher value means higher correlation. |
qExpression optional string | Trendline expression |
qElemNo optional integer<int32> | Inner Dim elem no |
schemasNxTrendlineDef
objectTrendline input definition
Properties
qType optional | No description |
qXColIx optional, default=-1 integer<int32> | The column in the hypercube to be used as x axis. Can point to either a dimension (numeric or text) or a measure |
qCalcR2 optional, default=false boolean | Set to true to calulatate the R2 score |
qContinuousXAxis optional | No description |
qMultiDimMode optional | No description |
schemasNxTrendlineMode
stringoneOf
Multi optional | TRENDLINE_MULTILINE |
Sum optional | TRENDLINE_SUM |
schemasNxValidationError
objectProperties
qErrorCode optional integer<int32> | Error code. This parameter is always displayed in case of error. |
qContext optional string | Context related to the error, from the user app domain. It can be the identifier of an object, a field name, a table name. This parameter is optional. |
qExtendedMessage optional string | Internal information from the server. This parameter is optional. |
schemasNxVariableListItem
objectProperties
qName optional string | Name of the variable. |
qDescription optional string | Description of the variable. |
qDefinition optional string | Definition of the variable. It can be a value or an expression. |
qIsConfig optional, default=false boolean | If set to true, it means that the variable is a system variable. A system variable provides information about the system and is set by the engine. The content cannot be changed by the user. This parameter is optional. The default value is false. |
qIsReserved optional, default=false boolean | If set to true, it means that the variable is reserved. The default value is false. This parameter is optional. Examples:
|
qMeta optional | Layout for NxMetaDef. |
qInfo optional | No description |
qData optional | Contains dynamic JSON data specified by the client. |
qIsScriptCreated optional boolean | If set to true, it means that the variable was defined via script. |
schemasNxVariableProperties
objectProperties
qName optional string | Name of the variable. |
qNumberPresentation optional | Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below. Formatting mechanismThe formatting mechanism depends on the type set in qType, as shown below: In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.
Type is DATE, TIME, TIMESTAMP or INTERVALThe following applies:
Type is INTEGERThe following applies:
Type is REALThe following applies:
Type is FIXThe following applies:
Type is MONEYThe following applies:
Type is ASCIINo formatting, qFmt is ignored. |
qIncludeInBookmark optional, default=false boolean | Set this property to true to update the variable when applying a bookmark. The value of a variable can affect the state of the selections. The default value is false. |
qUsePredefListedValues optional boolean | The value of a variable can be an enumeration. Set this property to true to reflect the predefined values in an enumeration. |
qPreDefinedList optional Array<string> | List of enumerations. This property is used if qUsePredefListedValues is set to true. |
schemasNxViewPort
objectProperties
qWidth optional integer<int32> | Width of the canvas in pixels. |
qHeight optional integer<int32> | Height of the canvas in pixels. |
qZoomLevel optional integer<int32> | Zoom level. |
schemasObjectInterface
objectProperties
qType optional string | The native type of the object. |
qHandle optional integer<int32> | The handle used to connect to object. |
qGenericType optional string | The type of the object. |
qGenericId optional string | Object ID. |
schemasOdbcDsn
objectProperties
qName optional string | Name of the ODBC connection. |
qDescription optional string | Description of the ODBC connection. |
qBit32 optional, default=false boolean | Is set to true if the version of ODBC is 32-bit. This parameter is optional. Default is false. |
qUserOnly optional, default=false boolean | Is set to true if the connection is User DSN. The connection works only for a specific user. Default is false. This parameter is optional. |
schemasOleDbProvider
objectProperties
qName optional string | Name of the OLEDB provider. |
qDescription optional string | Description of the OLEDB provider. |
qBit32 optional, default=false boolean | Is set to true if the version of the OLEDB provider is 32-bit. Default is false. This parameter is optional. |
schemasOtherLimitMode
stringoneOf
OTHER_GE_LIMIT optional | No description |
OTHER_LE_LIMIT optional | No description |
OTHER_GT_LIMIT optional | No description |
OTHER_LT_LIMIT optional | No description |
schemasOtherMode
stringoneOf
OTHER_OFF optional | No description |
OTHER_COUNTED optional | No description |
OTHER_ABS_LIMITED optional | No description |
OTHER_ABS_ACC_TARGET optional | No description |
OTHER_REL_LIMITED optional | No description |
OTHER_REL_ACC_TARGET optional | No description |
schemasOtherSortMode
stringoneOf
OTHER_SORT_DEFAULT optional | No description |
OTHER_SORT_DESCENDING optional | No description |
OTHER_SORT_ASCENDING optional | No description |
schemasOtherTotalSpecProp
objectProperties
qOtherMode optional | No description |
qOtherCounted optional | No description |
qOtherLimit optional | No description |
qOtherLimitMode optional | No description |
qSuppressOther optional, default=false boolean | If set to true, the group Others is not displayed as a dimension value. The default value is false. |
qForceBadValueKeeping optional, default=true boolean | This parameter is used when qOtherMode is set to:
and when the dimension values include not numeric values. Set this parameter to true to include text values in the returned values. The default value is true. |
qApplyEvenWhenPossiblyWrongResult optional, default=true boolean | Set this parameter to true to allow the calculation of Others even if the engine detects some potential mistakes. For example the country Russia is part of the continent Europe and Asia. If you have an hypercube with two dimensions Country and Continent and one measure Population, the engine can detect that the population of Russia is included in both the continent Asia and Europe. The default value is true. |
qGlobalOtherGrouping optional, default=false boolean | This parameter applies to inner dimensions. If this parameter is set to true, the restrictions are calculated on the selected dimension only. All previous dimensions are ignored. The default value is false. |
qOtherCollapseInnerDimensions optional, default=false boolean | If set to true, it collapses the inner dimensions (if any) in the group Others . The default value is false. |
qOtherSortMode optional | No description |
qTotalMode optional | No description |
qReferencedExpression optional | No description |
schemasPoint
objectProperties
qx optional integer<int32> | x-coordinate in pixels. The origin is the top left of the screen. |
qy optional integer<int32> | y-coordinate in pixels. The origin is the top left of the screen. |
schemasPositionMark
objectProperties
qDimName optional string | No description |
qElemNo optional Array<integer<int32>> | No description |
qElemValues optional Array<Array<integer<byte>>> | No description |
schemasProgressData
objectProperties
qStarted optional boolean | True if the request is started. |
qFinished optional boolean | True if the request is finished. |
qCompleted optional integer<int64> | This property is not used. |
qTotal optional integer<int64> | This property is not used. |
qKB optional integer<int32> | This property is not used. |
qMillisecs optional integer<int32> | Request duration in milliseconds. |
qUserInteractionWanted optional boolean | True when the engine pauses the script execution and waits for a user interaction. |
qPersistentProgress optional string | A progress message is persistent when it informs about the start or end of a statement. For example, it can inform about the total number of lines fetched from a data source or tell that the app was saved. All persistent progress messages between two GetProgress calls are summarized in this string. Contrarily to qPersistentProgressMessages, the content of the localized message string is displayed (not its message code). |
qTransientProgress optional string | A progress message is transient when it informs about the progress of an ongoing statement. For example, it can tell how many lines are currently fetched from a data source. All transient progress messages between two GetProgress calls are summarized in this string. Contrarily to qTransientProgressMessage, the content of the localized message string is displayed (not its message code). |
qErrorData optional | Information about the error messages that occur during the script execution. |
qPersistentProgressMessages optional | List of persistent progress messages. |
qTransientProgressMessage optional | No description |
schemasProgressMessage
objectProperties
qMessageCode optional integer<int32> | Code number to the corresponding localized message string. |
qMessageParameters optional Array<string> | Parameters to be inserted in the localized message string. |
schemasRange
objectProperties
qMin optional number<double> | Lowest value in the range |
qMax optional number<double> | Highest value in the range |
qMinInclEq optional boolean | If set to true, the range includes the lowest value in the range of selections (Equals to ). [bn(50500)] Example: The range is [1,10]. If qMinInclEq is set to true it means that 1 is included in the range of selections. |
qMaxInclEq optional boolean | If set to true, the range includes the highest value in the range of selections (Equals to ). [bn(50500)] Example: The range is [1,10]. If qMinInclEq is set to true it means that 10 is included in the range of selections. |
schemasRangeSelectInfo
objectProperties
qRangeLo optional, default=-1e+300 number<double> | Lowest value in the range. |
qRangeHi optional, default=-1e+300 number<double> | Highest value in the range. |
qMeasure optional string | Label of the measure. |
schemasRect
objectProperties
qLeft optional integer<int32> | Position from the left. Corresponds to the first column. |
qTop optional integer<int32> | Position from the top. Corresponds to the first row. |
qWidth optional integer<int32> | Number of columns in the page. The indexing of the columns may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ). |
qHeight optional integer<int32> | Number of rows or elements in the page. The indexing of the rows may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ). |
schemasSampleResult
objectProperties
qFieldOrColumn optional | No description |
qValues optional | Matched values part of the sample. |
schemasScriptSyntaxError
objectProperties
qErrLen optional, default=0 integer<int32> | Length of the word where the error is located. |
qTabIx optional, default=0 integer<int32> | Number of the faulty section. |
qLineInTab optional, default=0 integer<int32> | Line number in the section where the error is located. |
qColInLine optional, default=0 integer<int32> | Position of the erroneous text from the beginning of the line. |
qTextPos optional, default=0 integer<int32> | Position of the erroneous text from the beginning of the script. |
qSecondaryFailure optional boolean | The default value is false. |
schemasScrollPosition
objectProperties
qUsePosition optional boolean | No description |
qPos optional | No description |
schemasSearchAssociationResult
objectProperties
qFieldNames optional Array<string> | List of the fields that contains search associations. |
qSearchTerms optional Array<string> | List of the search terms. |
qFieldDictionaries optional | Information about the fields containing search hits. |
qSearchTermsMatched optional Array<Array<SearchMatchCombination>> | List of search results. The maximum number of search results in this list is set by qPage/qCount . |
qTotalSearchResults optional integer<int32> | Total number of search results. This number is not limited by qPage/qCount . |
schemasSearchAttribute
objectProperties
qKey optional string | String corresponding to SearchObjectOptions.qAttributes. It will be qProperty for SearchObjectOptions. |
qValue optional string | String corresponding to qKey for the current SearchGroupItemMatch. For example, if the match is Make by Price found in the title of a generic object, qValue will be qMetaDef/title. |
schemasSearchCharRange
objectProperties
qCharPos optional integer<int32> | Starting position of the match in the search result, starting from 0. |
qCharCount optional integer<int32> | Length of the match in the search result. |
qTerm optional integer<int32> | Position of the term in the list of search terms, starting from 0. |
schemasSearchCombinationOptions
objectProperties
qSearchFields optional Array<string> | List of the search fields. If empty, the search is performed in all fields of the app. |
qContext optional | No description |
qCharEncoding optional | No description |
qAttributes optional Array<string> | Optional.
|
schemasSearchContextType
stringoneOf
Cleared optional | CONTEXT_CLEARED |
LockedFieldsOnly optional | CONTEXT_LOCKED_FIELDS_ONLY |
CurrentSelections optional | CONTEXT_CURRENT_SELECTIONS |
schemasSearchFieldDictionary
objectProperties
qField optional integer<int32> | Position of the field in the list of fields, starting from 0. The list of fields is defined in qResults/qFieldNames and contains the search associations. |
qResult optional | List of the matching values. The maximum number of values in this list is set by qMaxNbrFieldMatches . |
schemasSearchFieldMatch
objectProperties
qField optional integer<int32> | Position of the field in the list of fields, starting from 0. The list of fields is defined in qResults/qFieldNames and contains the search associations. |
qValues optional Array<integer<int64>> | Positions of the matching values in the search results. The maximum number of values in this list is defined by qMaxNbrFieldMatches . |
qTerms optional Array<integer<int32>> | Positions of the search terms, starting from 0. |
qNoOfMatches optional integer<int32> | Number of search hits in the field. The number of values in qValues and the value of qNoOfMatches are equal if qMaxNbrFieldMatches is -1. |
schemasSearchFieldMatchType
stringoneOf
FieldMatchNone optional | FM_NONE |
FieldMatchSubString optional | FM_SUBSTRING |
FieldMatchWord optional | FM_WORD |
FieldMatchExact optional | FM_EXACT |
FieldMatchLast optional | FM_LAST |
schemasSearchFieldMatchesItem
objectProperties
qText optional string | No description |
qElemNo optional integer<int32> | No description |
qSearchTermsMatched optional Array<integer<int32>> | No description |
schemasSearchFieldSelectionMode
stringoneOf
OneAndOnlyOne optional | ONE_AND_ONLY_ONE |
schemasSearchFieldValueItem
objectProperties
qFieldName optional string | Field name of matches. |
qValues optional | List of search matches. |
schemasSearchGroup
objectProperties
qId optional integer<int32> | Identifier of the search group. |
qGroupType optional | No description |
qSearchTermsMatched optional Array<integer<int32>> | Indexes of the search terms that are included in the group. These search terms are related to the list of terms defined in SearchResult.qSearchTerms . |
qTotalNumberOfItems optional integer<int32> | Total number of distinct items in the search group. |
qItems optional | List of items in the search group. The group items are numbered from the value of SearchGroupOptions.qOffset to the value of SearchGroupOptions.qOffset + SearchGroupOptions.qCount |
schemasSearchGroupItem
objectProperties
qItemType optional | No description |
qTotalNumberOfMatches optional integer<int32> | Total number of distinct matches in the search group item. |
qIdentifier optional string | Identifier of the item. It corresponds to:
|
qItemMatches optional | List of matches in the search group item. The group item matches are numbered from the value of SearchGroupItemOptions.qOffset to the value of SearchGroupItemOptions.qOffset + SearchGroupItemOptions.qCount . |
qSearchTermsMatched optional Array<integer<int32>> | Indexes of the search terms that are included in the group item. These search terms are related to the list of terms defined in SearchResult.qSearchTerms . |
qMatchType optional | No description |
schemasSearchGroupItemMatch
objectProperties
qText optional string | Search match value. Value of the search group item. If the match is found in a field, it corresponds to the value of the field. If the match is found in a generic object property, it corresponds to the property value. |
qFieldSelectionMode optional | No description |
qRanges optional | List of ranges. For example, if the search terms are Price and Make, and the search group item value is Make by Price vs Mileage, then there are two ranges: one for Price and one for Make. |
qAttributes optional | Provides detail of the match as requested by the user in SearchObjectsOptions.qAttributes or SearchCombinationOptions.qAttributes If the user requests SearchObjects or SearchResults with an empty qAttributes option, the outputted qAttributes is returned empty. For SearchObjects requested with qProperty , the SearchGroupItemMatch.qAttributes return value contains [“qProperty”, "qMetaDef/title”] if the match has been found in the title of the item. For dimension values, the returned qProperty will be “*” . For SearchResults requested with qNum , the SearchGroupItemMatch.qAttributes return value contains ["qNum", N] where N is the numeric value of the element or NaN if the value is not numeric. For SearchResults requested with qElemNum , the SearchGroupItemMatch.qAttributes return value contains ["qElemNum", N] where N is the value index of the element. |
schemasSearchGroupItemOptions
objectProperties
qGroupItemType optional | No description |
qOffset optional, default=0 integer<int32> | Position starting from 0. The default value is 0. |
qCount optional, default=-1 integer<int32> | Maximum number of matches per item (in qItemMatches[ ] ). The default value is -1: all values are returned. |
schemasSearchGroupItemType
stringoneOf
Field optional | FIELD |
GenericObject optional | GENERIC_OBJECT |
schemasSearchGroupOptions
objectProperties
qGroupType optional | No description |
qOffset optional, default=0 integer<int32> | Position starting from 0. The default value is 0. |
qCount optional, default=-1 integer<int32> | Maximum number of items per group (in qItems[ ] ). The default value is -1; all values are returned. |
schemasSearchGroupType
stringoneOf
DatasetType optional | DATASET_GROUP |
GenericObjectsType optional | GENERIC_OBJECTS_GROUP |
schemasSearchMatchCombination
objectProperties
qId optional integer<int32> | Index of the search result, starting from 0. |
qFieldMatches optional | Information about the search matches. |
schemasSearchMatchCombinations
Array<SearchMatchCombination>schemasSearchObjectOptions
objectProperties
qAttributes optional Array<string> | This array is either empty or contains qProperty . |
qCharEncoding optional | No description |
schemasSearchPage
objectProperties
qOffset optional integer<int32> | Position from the top, starting from 0. If the offset is set to 0, the first search result to be returned is at position 0. |
qCount optional integer<int32> | Number of search groups to return (in qSearchGroupArray ). |
qMaxNbrFieldMatches optional, default=-1 integer<int32> | Maximum number of matching values to return per search result. The default value is -1; all values are returned. This property is to be used with the SearchAssociations method. |
qGroupOptions optional | Options of the search groups. If this property is not set, all values are returned. This property is to be used with the SearchResults method or the SearchObjects method. |
qGroupItemOptions optional | Options of the search group items. If this property is not set, all values are returned. This property is to be used with the SearchResults method or the SearchObjects method. |
schemasSearchResult
objectProperties
qSearchTerms optional Array<string> | List of the search terms. |
qTotalNumberOfGroups optional integer<int32> | Total number of groups. |
qSearchGroupArray optional | List of search groups. The groups are numbered from the value of SearchPage.qOffset to the value of SearchPage.qOffset + SearchPage.qCount . |
schemasSearchSuggestItem
objectProperties
qValue optional string | Value of the suggestion. |
qTerm optional integer<int32> | Index of the suggestion value. The indexing starts from 0 and from the left. |
schemasSearchSuggestionResult
objectProperties
qSuggestions optional | List of suggestions. |
qFieldNames optional Array<string> | List of field names that contain search hits. |
schemasSearchTermResult
objectProperties
qText optional string | Text of the associated value. |
qElemNumber optional integer<int32> | Element number of the associated value. |
qRanges optional | List of ranges. For example, if the user searches the term read and the associative value is Reading , then the corresponding range would be Read in Reading . |
schemasSearchValueOptions
objectProperties
qSearchFields optional Array<string> | List of the search fields. If empty, the search is performed in all fields of the app. |
schemasSearchValuePage
objectProperties
qOffset optional integer<int32> | Position from the top, starting from 0. If the offset is set to 0, the first search result to be returned is at position 0. |
qCount optional integer<int32> | Number of search fields to return |
qMaxNbrFieldMatches optional, default=-1 integer<int32> | Maximum number of matching values to return per search result. |
schemasSearchValueResult
objectProperties
qSearchTerms optional Array<string> | List of the search terms. |
qFieldMatches optional | List of search groups. The groups are numbered from the value of SearchPage.qOffset to the value of SearchPage.qOffset + SearchPage.qCount . |
schemasSelectInfo
objectProperties
qTextSearch optional string | Text search string. Everything that matches the text is selected. This parameter is optional. |
qRangeLo optional, default=-1e+300 number<double> | Lower value of the search range. This parameter is used when performing range selections or text searches in dimensions. Default is Null. |
qRangeHi optional, default=-1e+300 number<double> | Highest value of the search range. This parameter is used when performing range selections or text searches in dimensions. Default is Null. |
qNumberFormat optional | Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below. Formatting mechanismThe formatting mechanism depends on the type set in qType, as shown below: In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.
Type is DATE, TIME, TIMESTAMP or INTERVALThe following applies:
Type is INTEGERThe following applies:
Type is REALThe following applies:
Type is FIXThe following applies:
Type is MONEYThe following applies:
Type is ASCIINo formatting, qFmt is ignored. |
qRangeInfo optional | This parameter is used when performing range selections or text searches in measures. Gives information about the range of selections. |
qSoftLock optional, default=false boolean | Set to true to ignore locks; in that case, locked fields can be selected. The default value is false. |
qContinuousRangeInfo optional |