Examples

Construct a an update for setting "Customer.Name" field to "Kruse Smith" 


var update= {
    AttributeAction : 1, //update
    AttributeType : 0,   //field update
    AttributeData : {
        FieldName : "Customer.Name",
        FieldValue : "Kruse Smith"
        }
   }

Properties

NameDescriptionTypeAdditional information
FieldName

Get or set field name. Must be the name of a valid field.

 string

Json null value handling: Ignore
FieldType

Gets or sets field type. Property is ignored for incoming messages

 FieldValueType

Json null value handling: Ignore
FieldValue

Gets or sets field value. Field must have IsUpdate set to true.

 Object

None.
DisplayValue

Sometimes we want to differ between what we show and the actual field value. For example if field represents a user we may want to display the user name while the value is the user identity. Property is ignored for incoming messages.

 string

Json null value handling: Ignore
DisplayOrder

Gets or sets the recommended display order. Primarly used for custom property fields.

 integer

None.
AdditionalValue

Certain fields may contain an additional text value. This feature is typically used for fields that uses a lookup where the user has to explain why a certain lookup value has been chosen.

 string

Json null value handling: Ignore
IsAdditionalValueSupported

Returns true if field supports additional values. If you try to set AdditionalValue on a field that does not support it, you will get an error.

 boolean

None.
FieldLabel

Gets or sets suggested label. Property is ignored for incoming messages

 string

Json null value handling: Ignore
FieldInfo

Get or sets suggested tool tip for field. Property is ignored for incoming messages

 string

Json null value handling: Ignore
FieldLookupProvider

Gets or sets lookup provided for field. Property is ignored for incoming messages.

 FieldLookupProviderModel

Json null value handling: Ignore
IsEnabled

Gets or sets whether this field can be updated. Property is ignored for incoming messages. This property is replaced by IsEnabledExpression and will be removed completely in future versions.

 boolean

None.
IsEnabledExpression

Gets or sets a dynamic expression that tells us when this field is enabled.

 DynamicExpression

Json null value handling: Ignore
IsRequired

Gets or sets whether this field must have a value. Property is ignored for incoming messages. This property is replaced by IsRequiredExpression and will be removed completely in future versions

 boolean

None.
IsRequiredExpression

Gets or sets a dynamic expression that tells us when this field is required. For further information about dynamic expressions DynamicExpression

 DynamicExpression

Json null value handling: Ignore
IsVisible

Gets or sets whether this field is visible. Property is ignored for incoming messages. This property is replaced by IsVisibleExpression and will be removed completely in future versions.

 boolean

None.
IsVisibleExpression

Gets or sets a dynamic expression that tells us when this field is visible. For further information about dynamic expressions DynamicExpression

 DynamicExpression

Json null value handling: Ignore