Skip to main content Skip to complementary content

RequestCreatePayload

Payload to send when creating an ODAG Request. selectionApp is the ID of the selection app from which the request is being made. bindSelectionState is the current selection state in the selection app at the time the request is made (this can be limited to the set of fields corresponding to the selectAppParamName properties in the link's bindings to save bandwidth on sending this request.

Properties

Name Description Type
selectionApp

The system-assigned ID for an app.

Example:

b1fcb89a-0f78-45da-9b61-0dbbb6a9d48c

String
sheetname

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

String
clientContextHandle

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

String
actualRowEst

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

Integer
bindSelectionState

A collection of FieldSelectionState objects.

Array of FieldSelectionState
selectionState

A collection of FieldSelectionState objects.

Array of FieldSelectionState

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!