ProcessDefinition

Represents the definition of a single approval process.

Supported Calls

describeSObjects(), query(), retrieve(), search()

Portal and Communities users can’t access this object.

Field	Details
Description	Type string Properties Filter, Nillable, Sort Description A description of this process, with a maximum of 3,000 characters.
DeveloperName	Type string Properties Filter, Group, Sort Description The external name of the process; the name seen by users.
LockType	Type picklist Properties Filter, Group, Restricted picklist, Sort Description The type of lock applied to the record being approved. When a record is in the approval process, it’s always locked, and only an administrator can edit it. However, the currently assigned approver can also be allowed to edit the record. Total Admin Owner Workitem Node none
Name	Type string Properties Filter, Group, Sort Description The unique process name, used internally.
State	Type picklist Properties Filter, Group, Sort Description The current state of this process. Active Inactive Obsolete
TableEnumOrId	Type picklist Properties Filter, Group, Sort Description Reserved for future use.
Type	Type picklist Properties Filter, Group, Sort Description The type of this process. Approval Process—Used to control the action taken for a record. State-based Process—Used internally to track various control processes, such as for developing Salesforce Knowledge articles.

Use this object to read the description of an approval process. The definition is read-only.