Newer Version Available

This content describes an older version of this product. View Latest

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.

Supported SOAP Calls

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

Supported REST HTTP Methods

Query, DELETE, GET, PATCH, POST

Fields

Field Name Details
FullName
Type
string
Properties
Create, Group, Nillable
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
ManageableState enumerated list
Properties
Create, Filter, Update
Description
Indicates the manageable state of the specified component that is contained in a package:
  • beta
  • deleted
  • deprecated
  • installed
  • released
  • unmanaged
Metadata
Type
mns:WorkflowRule
Properties
Create, Nillable, Update
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
string
Properties
Filter, Group, Sort
Description
The enum name or ID of entity this rule is associated with.
NamespacePrefix
Type
string
Properties
Filter, Group, idLookup, Sort
Description
The namespace of the package containing the workflow rule object.
TableEnumOrId
Type
picklist
Properties
Filter, Group, Restricted picklist, Sort
Description
The enum (for example, Account) or ID of the object for this workflow rule.