Type Alias RequestObjectV2

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 link property refers to that link. Otherwise, a sub-request is created for each link in the navigation point and the link of each sub-request refers to its respective link. If this is a single or singlesub Analytics Application generation request and the request has reached at least the queued stage, the generatedApp property contains the ID of the generated Analytics Application (note that the generated Analytics Application might not yet be populated with data or published if the request is not completed). If this is a single or singlesub request and the data load operation failed, the generatedApp property still contains the ID of the failed Analytics Application to allow viewing of the ODAG-bound script for diagnostic purposes. Generated Analytics Applications for failed requests are purged regularly, so the Analytics Application might no longer be available. If this is a single or singlesub request that was canceled before reaching the loading phase, the generatedApp property is missing because generated Analytics Applications for pre-load phase requests are deleted. If this is a multiple request, the generatedApp property is also missing.

type RequestObjectV2 = {
    actualRowEst?: number;
    bindingStateHash?: number;
    createdDate: string;
    curRowEstExpr?: string;
    curRowEstHighBound?: number;
    curRowEstLowBound?: number;
    errorMessage?: string;
    generatedApp?: odagRequests.AppStateCondensedV2;
    generatedAppName?: odagRequests.AppNameV2;
    id: odagRequests.RequestIdV2;
    kind: odagRequests.RequestKindV2;
    link: odagRequests.LinkId;
    loadState?: odagRequests.RequestLoadInfoV2;
    modifiedDate: string;
    owner: odagRequests.UserStateCondensedV2;
    parentRequestId?: odagRequests.RequestIdV2;
    purgeAfter?: string;
    retentionTime?: number;
    selectionApp?: odagRequests.AppIdV2;
    selectionAppName?: odagRequests.AppNameV2;
    selectionStateHash?: number;
    sheetname?: string;
    state: odagRequests.RequestStateV2;
    targetSheet?: string;
    templateApp: odagRequests.AppIdV2;
    templateAppName?: odagRequests.AppNameV2;
    timeToLive?: number;
    validation?: string[];
}
Index
actualRowEst? bindingStateHash? createdDate curRowEstExpr? curRowEstHighBound? curRowEstLowBound? errorMessage? generatedApp? generatedAppName? id kind link loadState? modifiedDate owner parentRequestId? purgeAfter? retentionTime? selectionApp? selectionAppName? selectionStateHash? sheetname? state targetSheet? templateApp templateAppName? timeToLive? validation?
actualRowEst?: number

The evaluated value of the Link's rowEstExpr measure expression at the time this request was initiated.

bindingStateHash?: number

A 64-bit hash of the bound field state at the time the request was made.

createdDate: string
curRowEstExpr?: string

The Link's rowEstExpr property setting at the time this request was initiated.

curRowEstHighBound?: number

The Link's rowEstRange.highBound value for the user at the time this request was initiated.

curRowEstLowBound?: number

The Link's rowEstRange.lowBound value for the user at the time this request was initiated.

errorMessage?: string

Detailed message if the request failed.

generatedApp?: odagRequests.AppStateCondensedV2

Condensed state of an Analytics Application returned in state for Link, LinkUsage, Request, and ODAG Apps GET calls.

generatedAppName?: odagRequests.AppNameV2

The name of an Analytics Application.

id: odagRequests.RequestIdV2

The system-assigned ID for an ODAG request.

kind: odagRequests.RequestKindV2

For links that do not use any partitioning fields, a single Analytics Application generation request is created. However, for selection Analytics Applications that designate a set of partitioning fields and the user selects multiple values for any of those partitioning fields, ODAG uses a separate singlesub request to generate a separate Analytics Application for each combination of selected partition field values, and tracks the queuing and data load phase of each of those sub-requests separately. Note that singlesub requests share the same link ID as their spawning multiple parent request.

link: odagRequests.LinkId

The system-assigned ID for a link.

loadState?: odagRequests.RequestLoadInfoV2

An object that describes the state of a generated Analytics Application's data load operation. In request objects that include this object as an optional property, the property will be missing for multiple generation requests (see their sub-requests for their data load information) or for single and singlesub requests that have not yet reached their loading phase.

modifiedDate: string
owner: odagRequests.UserStateCondensedV2

Condensed state of a user returned in state of ownable ODAG entities (for example, a link or request).

parentRequestId?: odagRequests.RequestIdV2

The system-assigned ID for an ODAG request.

purgeAfter?: string
retentionTime?: number

The remaining time in minutes this request will be retained (0 means kept forever).

selectionApp?: odagRequests.AppIdV2

The system-assigned ID for an Analytics Application.

selectionAppName?: odagRequests.AppNameV2

The name of an Analytics Application.

selectionStateHash?: number

A 64-bit hash of the selected field values at the time the request was made.

sheetname?: string
state: odagRequests.RequestStateV2

The current state of an ODAG request.

targetSheet?: string

The ID of the target sheet, taken from the link properties, to navigate to when opening the generated Analytics Application (empty for Analytics Application overview).

templateApp: odagRequests.AppIdV2

The system-assigned ID for an Analytics Application.

templateAppName?: odagRequests.AppNameV2

The name of an Analytics Application.

timeToLive?: number

The value of the Link's appRetentionTime property at the time the Analytics Application was generated (0 means no auto-purge).

validation?: string[]

A list of validation errors or warnings.

Settings
Member Visibility

On This Page
Properties