Skip to main content Skip to complementary content

LinkModifyPayload

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

Properties

Name Description Type
modifiedDate

A timestamp indicating when a significant event happend.

Date
name

The name of a link.

Example:

Odag Link name

String
templateApp

The system-assigned ID for an app.

Example:

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

String
dynamicView

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

Boolean
rowEstExpr

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.

String
statusSetting

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.

One of:
  • activate
  • disable
  • decommission
String
bindings

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.

Array of Binding
properties

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

LinkProperties
modelGroups Array of ModelGroupId

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!