Type Alias RequestPostPayloadV2

Payload to send when creating an ODAG request. selectionApp is the ID of the selection Analytics Application from which the request is made. bindSelectionState is the selection state in the selection Analytics Application at the time the request is submitted (you can limit the fields to those used by the link's bindings to reduce payload size).

type RequestPostPayloadV2 = {
    actualRowEst?: number;
    bindSelectionState: odagLinks.SelectionStateV2;
    clientContextHandle?: string;
    selectionApp: odagLinks.AppIdV2;
    selectionState?: odagLinks.SelectionStateV2;
    sheetname?: string;
}
Index
actualRowEst? bindSelectionState clientContextHandle? selectionApp selectionState? sheetname?
actualRowEst?: number

The current row estimate value calculated by the link's rowEstExpr property in the context of the selection Analytics Application.

bindSelectionState: odagLinks.SelectionStateV2

A collection of FieldSelectionStateV2 objects.

clientContextHandle?: string

An opaque handle to a client-side object that contains the reference to the link being used.

selectionApp: odagLinks.AppIdV2

The system-assigned ID for an Analytics Application.

selectionState?: odagLinks.SelectionStateV2

A collection of FieldSelectionStateV2 objects.

sheetname?: string

The name of the sheet from which the request is being made.

Settings
Member Visibility

On This Page
Properties