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
bindings? dynamicView? includeScript? name ownerId? properties? rowEstExpr? selectionApp statusSetting? templateApp?
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

When true, the ODAG link is treated as a dynamic view. Analytics Application retention time is overridden to 24 hours and the maximum number of generated Analytics Applications is set to 1.

includeScript?: boolean

Set to true to include the generated Analytics Application load script in the generated Analytics Application. The default value is false.

name: LinkNameV2

The name of a link.

ownerId?: odagLinks.UserIdV2

The system-assigned ID for a user

properties?: LinkPropertiesV2

The complete set of possible properties for a link and their associated user context/value pairings.

rowEstExpr?: LinkRowEstExprV2

The measure expression to be evaluated in the context of the selection Analytics Application for the link that estimates the number of records that will be qualified by the primary load query of the template Analytics Application. This expression must be valid in the context of the selection Analytics Application fields and update whenever the selection state of the selection Analytics Application changes.

selectionApp: odagLinks.AppIdV2

The system-assigned ID for an Analytics Application.

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

The system-assigned ID for an Analytics Application.

Settings
Member Visibility

On This Page
Properties