ProcessStage Entity Reference

Stage associated with a process.

Messages

Message Web API Operation SDK Assembly
Retrieve GET [org URI]/api/data/v9.0/processstages(processstageid)
See Retrieve
RetrieveRequest or
Retrieve
RetrieveActivePath RetrieveActivePath Function RetrieveActivePathRequest
RetrieveMultiple GET [org URI]/api/data/v9.0/processstages
See Query Data
RetrieveMultipleRequest or
RetrieveMultiple

Entity Properties

Property Value
CollectionSchemaName ProcessStages
DisplayCollectionName Process Stages
DisplayName Process Stage
EntitySetName processstages
IsBPFEntity False
LogicalCollectionName processstages
LogicalName processstage
OwnershipType None
PrimaryIdAttribute processstageid
PrimaryNameAttribute stagename
SchemaName ProcessStage

Writable attributes

These attributes return true for either IsValidForCreate or IsValidForUpdate (usually both). Listed by SchemaName.

PrimaryEntityTypeCode

Property Value
Description Primary entity associated with the stage.
DisplayName Primary Entity
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName primaryentitytypecode
RequiredLevel SystemRequired
Type EntityName

ProcessId

Property Value
Description Shows the ID of the process.
DisplayName Process
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName processid
RequiredLevel SystemRequired
Targets workflow
Type Lookup

ProcessStageId

Property Value
Description Shows the ID of the process stage record.
DisplayName Process Stage
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName processstageid
RequiredLevel SystemRequired
Type Uniqueidentifier

StageCategory

Property Value
Description Select the category of the sales process.
DisplayName Stage Category
IsValidForForm True
IsValidForRead True
LogicalName stagecategory
RequiredLevel None
Type Picklist

StageCategory Options

Value Label
0 Qualify
1 Develop
2 Propose
3 Close
4 Identify
5 Research
6 Resolve
7 Approval

StageName

Property Value
Description Type a name for the process stage.
DisplayName Process Stage Name
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName stagename
MaxLength 100
RequiredLevel SystemRequired
Type String

Read-only attributes

These attributes return false for both IsValidForCreate or IsValidForUpdate. Listed by SchemaName.

ClientData

Property Value
Description Step metadata for process stage
DisplayName Client Data
Format TextArea
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName clientdata
MaxLength 1073741823
RequiredLevel None
Type Memo

OwnerId

Property Value
Description Enter the user or team who is assigned to manage the record. This field is updated every time the record is assigned to a different user.
DisplayName Owner
IsValidForForm False
IsValidForRead True
LogicalName ownerid
RequiredLevel ApplicationRequired
Targets systemuser,team
Type Owner

OwnerIdType

Property Value
Description
DisplayName
IsValidForForm False
IsValidForRead True
LogicalName owneridtype
RequiredLevel SystemRequired
Type EntityName

OwningBusinessUnit

Property Value
Description Select the business unit that owns the record.
DisplayName Owning Business Unit
IsValidForForm False
IsValidForRead True
LogicalName owningbusinessunit
RequiredLevel ApplicationRequired
Type Uniqueidentifier

ProcessIdName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName processidname
MaxLength 100
RequiredLevel None
Type String

VersionNumber

Property Value
Description Version number of the process stage.
DisplayName Version Number
IsValidForForm False
IsValidForRead True
LogicalName versionnumber
MaxValue 9223372036854775807
MinValue -9223372036854775808
RequiredLevel None
Type BigInt

One-To-Many Relationships

Listed by SchemaName.

processstage_knowledgearticle

Same as knowledgearticle entity processstage_knowledgearticle Many-To-One relationship.

Property Value
ReferencingEntity knowledgearticle
ReferencingAttribute stageid
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName processstage_knowledgearticle
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

processstage_contact

Same as contact entity processstage_contact Many-To-One relationship.

Property Value
ReferencingEntity contact
ReferencingAttribute stageid
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName processstage_contact
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

processstage_teams

Same as team entity processstage_teams Many-To-One relationship.

Property Value
ReferencingEntity team
ReferencingAttribute stageid
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName processstage_teams
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

ProcessStage_SyncErrors

Same as syncerror entity ProcessStage_SyncErrors Many-To-One relationship.

Property Value
ReferencingEntity syncerror
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName ProcessStage_SyncErrors
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: Cascade
Delete: Cascade
Merge: Cascade
Reparent: Cascade
Share: Cascade
Unshare: Cascade

processstage_recurringappointmentmasters

Same as recurringappointmentmaster entity processstage_recurringappointmentmasters Many-To-One relationship.

Property Value
ReferencingEntity recurringappointmentmaster
ReferencingAttribute stageid
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName processstage_recurringappointmentmasters
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

processstage_letters

Same as letter entity processstage_letters Many-To-One relationship.

Property Value
ReferencingEntity letter
ReferencingAttribute stageid
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName processstage_letters
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

processstage_faxes

Same as fax entity processstage_faxes Many-To-One relationship.

Property Value
ReferencingEntity fax
ReferencingAttribute stageid
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName processstage_faxes
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

processstage_tasks

Same as task entity processstage_tasks Many-To-One relationship.

Property Value
ReferencingEntity task
ReferencingAttribute stageid
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName processstage_tasks
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

processstage_account

Same as account entity processstage_account Many-To-One relationship.

Property Value
ReferencingEntity account
ReferencingAttribute stageid
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName processstage_account
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

lk_translationprocess_activestageid

Same as translationprocess entity lk_translationprocess_activestageid Many-To-One relationship.

Property Value
ReferencingEntity translationprocess
ReferencingAttribute activestageid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName processstage_translationprocess
AssociatedMenuConfiguration Behavior: UseCollectionName
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

processstage_systemusers

Same as systemuser entity processstage_systemusers Many-To-One relationship.

Property Value
ReferencingEntity systemuser
ReferencingAttribute stageid
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName processstage_systemusers
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

lk_newprocess_activestageid

Same as newprocess entity lk_newprocess_activestageid Many-To-One relationship.

Property Value
ReferencingEntity newprocess
ReferencingAttribute activestageid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName processstage_newprocess
AssociatedMenuConfiguration Behavior: UseCollectionName
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

processstage_emails

Same as email entity processstage_emails Many-To-One relationship.

Property Value
ReferencingEntity email
ReferencingAttribute stageid
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName processstage_emails
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

processstage_appointments

Same as appointment entity processstage_appointments Many-To-One relationship.

Property Value
ReferencingEntity appointment
ReferencingAttribute stageid
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName processstage_appointments
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

processstage_phonecalls

Same as phonecall entity processstage_phonecalls Many-To-One relationship.

Property Value
ReferencingEntity phonecall
ReferencingAttribute stageid
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName processstage_phonecalls
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

lk_expiredprocess_activestageid

Same as expiredprocess entity lk_expiredprocess_activestageid Many-To-One relationship.

Property Value
ReferencingEntity expiredprocess
ReferencingAttribute activestageid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName processstage_expiredprocess
AssociatedMenuConfiguration Behavior: UseCollectionName
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

Many-To-One Relationships

Each Many-To-One relationship is defined by a corresponding One-To-Many relationship with the related entity. Listed by SchemaName.

process_processstage

See workflow Entity process_processstage One-To-Many relationship.

See also

About the Entity Reference
Web API Reference
processstage EntityType