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?: odagLinks.AppStateCondensedV2;
    generatedAppName?: odagLinks.AppNameV2;
    id: odagLinks.RequestIdV2;
    kind: odagLinks.RequestKindV2;
    link: odagLinks.LinkId;
    loadState?: odagLinks.RequestLoadInfoV2;
    modifiedDate: string;
    owner: odagLinks.UserStateCondensedV2;
    parentRequestId?: odagLinks.RequestIdV2;
    purgeAfter?: string;
    retentionTime?: number;
    selectionApp?: odagLinks.AppIdV2;
    selectionAppName?: odagLinks.AppNameV2;
    selectionStateHash?: number;
    sheetname?: string;
    state: odagLinks.RequestStateV2;
    targetSheet?: string;
    templateApp: odagLinks.AppIdV2;
    templateAppName?: odagLinks.AppNameV2;
    timeToLive?: number;
    validation?: string[];
}
Index

Properties

actualRowEst?: number

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

bindingStateHash?: number
createdDate: string
curRowEstExpr?: string
curRowEstHighBound?: number
curRowEstLowBound?: number
errorMessage?: string
generatedAppName?: odagLinks.AppNameV2
modifiedDate: string
parentRequestId?: odagLinks.RequestIdV2
purgeAfter?: string
retentionTime?: number
selectionApp?: odagLinks.AppIdV2
selectionAppName?: odagLinks.AppNameV2
selectionStateHash?: number
sheetname?: string
targetSheet?: string
templateApp: odagLinks.AppIdV2
templateAppName?: odagLinks.AppNameV2
timeToLive?: number
validation?: string[]