Interface LinkAddPayload

A JSON payload containing the content for a new ODAG link.

Hierarchy

  • LinkAddPayload

Properties

bindings?: string[]

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

The odag link is treated as a dynamic view, app retention time is overridden to 24 hours and number of generated apps to 1

includeCharts?: boolean

Determines if master charts of template app are included or not in the response

modelGroups?: string[]

The system-assigned ID for a model group.

name: string

The name of a link.

properties?: LinkProperties

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

rowEstExpr?: string

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

selectionApp: string

The system-assigned ID for an app.

statusSettings?: string

The valid set of status change types for a LinkCreate or LinkUpdate request. On a LinkCreate operation, the default value for this setting is 'activate'. On a LinkUpdate operation, the default behavior is to make no status changes unless the result of the update renders a Link to be completed and then the default status is set to active. In either the LinkCreate or LinkUpdate case, if the state of the Link following the changes is still missing properties required for it to support ODAG, the status will automatically be set to 'incomplete' regardless of the status value specified. It is the caller's responsibility to read the actual status value returned in the object. It is not possible to activate or disable a Link that is incomplete unless the changes supplied in the LinkUpdate call provide values for all required properties.

templateApp?: string

The system-assigned ID for an app.