Type Alias LinkPutPayloadV2

An object that defines the properties of a Link to be modified.

type LinkPutPayloadV2 = {
    bindings?: BindingArrayV2;
    dynamicView?: boolean;
    includeScript?: boolean;
    name: LinkNameV2;
    ownerId?: odagLinks.UserIdV2;
    properties?: LinkPropertiesV2;
    rowEstExpr?: LinkRowEstExprV2;
    selectionApp: odagLinks.AppIdV2;
    statusSetting?: LinkStatusSettingV2;
    templateApp?: odagLinks.AppIdV2;
}
Index

Properties

bindings?: BindingArrayV2

A collection of Bindings. Note that there can be multiple bindings having the same templateAppFieldName in a binding collection to denote different usages of the field's selection state in the context of the data prep logic but they all must have the same value for their range property.

dynamicView?: boolean
includeScript?: boolean
properties?: LinkPropertiesV2
rowEstExpr?: LinkRowEstExprV2
selectionApp: odagLinks.AppIdV2
statusSetting?: LinkStatusSettingV2

The requested status transition to apply to a Link. New links are always created with status active; statusSetting is ignored. When updating a Link, if statusSetting is provided, the request updates the Link's status only (other fields in the payload are not applied). If omitted, the Link's status is not changed. statusSetting is an action, and it maps to the resulting status: - activate sets status to active. - disable sets status to disabled. - decommission sets status to decommissioned. If statusSetting has an unsupported value, the request returns an error and the Link is not updated. Links with status decommissioned cannot change status.

templateApp?: odagLinks.AppIdV2