BusinessProcess

Represents a business process.

Version 

Introduced in API version 33.0.

Supported SOAP API Calls 

create(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert()

Supported REST API Methods 

GET, HEAD, PATCH, POST, Query

Special Access Rules 

• Access to this object requires the View Setup and Configuration permission.

Fields 

Description 

• Type: string

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Introduced: API version 33.0

• Description: The business process description, limited to 255 characters.

EntityDefinitionId 

• Type: string
• Required: No
• Properties: Filter, Group, Sort
• Introduced: API version 33.0

FullName 

• Type: string

• Required: No

• Properties: Create, Group, Nillable

• Introduced: API version 37.0

• Description: The internal name of the object. White spaces and special characters are escaped for validity. The name must:

• Contain characters, letters, or the underscore (_) character

• Must start with a letter

• Can’t end with an underscore

• Can’t contain two consecutive underscore characters.

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.

IsActive 

• Type: boolean

• Required: No

• Properties: Defaulted on create, Filter, Group, Sort

• Introduced: API version 33.0

• Description: Indicates whether this business process is active (true) or not (false).

• Default value: false

ManageableState 

• Type: picklist

• Required: No

• Properties: Filter, Group, Nillable, Restricted picklist, 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: complexvalue

• Required: No

• Properties: Create, Nillable, Update

• Introduced: API version 37.0

• Description: Business Process 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, idLookup, Sort

• Description: The process name.

NamespacePrefix 

• Type: string

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Introduced: API version 17.0

• Description: A unique string to distinguish this type from any others.