RequestStateFull
The detailed content of an ODAG request object. If this is a summarization of a request initiated from a navigation point that has a single link, its linkId property will refer to that link. Otherwise, a sub-request will be created for each link in the navigation point and the linkIds of those sub-requests will refer to their respective links. If this is a 'single' or 'singlesub' app gen request and the request has at least reached the 'queued' stage, the generatedApp property will contain the ID of the generated app (note that the generated app may not yet be populated with data or published if the request is not completed). If this request is a 'single' or 'sub-single' app gen request but the data load operation failed, the generateApp property will still contain the ID of the failed app to allow viewing of the ODAG-bound script for diagnostic purposes but the generated apps for failed requests are purged on a regaulr basis so the app may no longer be available. If this request is a 'single' or 'sub-single' app gen request that was canceled before reaching the 'loading' phase, the generatedApp property will be missing since the generated apps for pre-load phase requests are deleted. If this is a multiple app generation request, the generatedApp property will also be missing.
Properties
| Name | Description | Type |
|---|---|---|
| id |
The system-assigned ID for an ODAG request. |
String |
| createdDate |
A timestamp indicating when a significant event happend. |
Date |
| modifiedDate |
A timestamp indicating when a significant event happend. |
Date |
| modifiedByUserName | String | |
| owner |
Condensed state of a Qlik Sense user returned in state of ownable ODAG entities (e.g. ModelGroup, Link and EngineGroup). |
UserStateCondensed |
| link |
The system-assigned ID for a link. |
String |
| selectionApp |
The system-assigned ID for an app. Example: b1fcb89a-0f78-45da-9b61-0dbbb6a9d48c |
String |
| selectionAppName |
The name of an app. Example: appname |
String |
| sheetname | String | |
| generatedApp |
The system-assigned ID for an app. Example: b1fcb89a-0f78-45da-9b61-0dbbb6a9d48c |
String |
| generatedAppName |
The name of an app. Example: appname |
String |
| engineGroupId |
The ID for an EngineGroup. |
String |
| engineGroupName |
The name of an engine group. |
String |
| parentRequestId |
The system-assigned ID for an ODAG request. |
String |
| kind |
For links that do not use any partitioning fields, a 'single' app generation request is created. However, for apps that designate a set of partitioning fields and the user selects multiple values for any of those partitioning fields, then the ODAG service uses a separate, 'singlesub' app generation request to generate a separate app for each of the partition field value combinations chosen in the selection app and tracks the queuing and data load phase of each of those sub-apps separately. Note that 'singlesub' requests share the same link ID of their spawning 'multi' parent request.
One of:
|
String |
| state |
The current state of an ODAG request.
One of:
|
String |
| templateApp |
The system-assigned ID for an app. Example: b1fcb89a-0f78-45da-9b61-0dbbb6a9d48c |
String |
| templateAppName |
The name of an app. Example: appname |
String |
| loadState |
An object that describes the state of a generated app's data load operation. In request objects that include this object as an optional property, the property will be missing for 'multiple' app gen requests (see their sub-requests for their data load information) or for 'single' and 'singlesub' requests that have not yet reached their 'loading' phase. |
RequestLoadInfo |
| timeToLive |
The value of the Link's appRetentionTime property at the time the app was generated (0 means no auto-purge). |
Integer |
| retentionTime |
The remaining time in minutes this request will be retained (0 means kept forever). |
Integer |
| purgeAfter |
A timestamp indicating when a significant event happend. |
Date |
| curRowEstExpr |
The Link's rowEstExpr property setting at the time this request was initiated. |
String |
| curRowEstLowBound |
The Link's RowEstRange.lowBound value for the user at the time this request was initiated. |
Integer |
| curRowEstHighBound |
The Link's RowEstRange.highBound value for the user at the time this request was initiated. |
Integer |
| actualRowEst |
The evaluated value of the Link's rowEstExpr measure expression at the time this request was initiated. |
Integer |
| bindSelectionState |
A collection of FieldSelectionState objects. |
Array of FieldSelectionState |
| bindingStateHash |
A 64-bit hash of the bound field state at the time the request was made. |
Integer |
| selectionState |
A collection of FieldSelectionState objects. |
Array of FieldSelectionState |
| selectionStateHash |
A 64-bit hash of the selected field values at the time the request was made. |
Integer |
| validation |
A list of validation errors or warnings. |
Array of String |
| subRequests |
This property only exists for 'multiple' app gen requests. It contains an array of the IDs of sub-requests that were spawned from this multi-request. |
Array of RequestId |
| publishToStreamName |
The name of the stream where the generated app will be published. |
String |
Did this page help you?
If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!