WorkflowRule

Represents a workflow rule that is used to fire off a specific workflow action when the specified criteria is met. Includes access to the associated WorkflowRule object in Salesforce Metadata API.

Available from API version 30.0 or later.

Version 

Introduced in API version 30.0.

Supported SOAP API Calls 

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

Supported REST API Methods 

Query, DELETE, GET, PATCH, POST

Fields 

FullName 

• Type: text

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Introduced: API version 30.0

• 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.

ManageableState 

• Type: staticenum

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Introduced: API version 9.0

• 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: complexvaluetype

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Introduced: API version 30.0

• Description: Workflow rule 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: name

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Description: The enum name or ID of entity this rule is associated with.

NamespacePrefix 

• Type: simple_namespace

• Required: No

• Properties: Filter, Group, Nillable, Sort

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

TableEnumOrId 

• Type: enumorid

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Description: The enum (for example, Account) or ID of the object for this workflow rule.