WorkflowFieldUpdate

Represents a workflow field update.

Version 

Introduced in API version 32.0.

Supported SOAP API Calls 

create(), delete(), query(), retrieve(), search(), update(), upsert()

Supported REST API Methods 

DELETE, GET, PATCH, POST

Fields 

EntityDefinitionId 

• Type: string

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Description: The ID of the entity containing the workflow field update.

FieldDefinitionId 

• Type: string

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Description: The ID of the field for the workflow field update.

FullName 

• Type: string

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Description: The full name of the associated metadata object in Metadata API.

Query this field only if the query result contains no more than one record. Otherwise, an error is returned. If more than one record exists, use multiple queries to retrieve the records. This limit protects performance.

LiteralValue 

• Type: string

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Description: If the update uses a literal value, this is that value.

LookupValueId 

• Type: ID

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Description: If the update looks up a value, this lookup value is referenced.

ManageableState 

• Type: string

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Description: Indicates the manageable state of the specified component that is contained in a package:

• beta

• deleted

• deprecated

• deprecatedEditable

• installed

• installedEditable

• released

• unmanaged

• Possible values:

  • beta — beta

  • deleted — deleted

  • deprecated — deprecated

  • deprecatedEditable — deprecatedEditable

  • installed — installed

  • installedEditable — installedEditable

  • released — released

  • unmanaged — unmanaged

Metadata 

• Type: WorkflowFieldUpdate

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Description: The workflow field update metadata.

Query this field only if the query result contains no more than one record. Otherwise, an error is returned. If more than one record exists, use multiple queries to retrieve the records. This limit protects performance.

Name 

• Type: string

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Description: The name of the workflow field update.

NamespacePrefix 

• Type: string

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Description: The namespace of the package containing the workflow field update object.

SourceTableEnumOrId 

• Type: string

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Description: The enum (for example, Account) or ID of the object this workflow field update is on.