processstage EntityType
Stage associated with a process.
- Entity set path:
- [organization URI]/api/data/v9.2/processstages
- Base type:
- crmbaseentity
- Display name:
- Process Stage
- Primary key:
- processstageid
- Primary name column:
- stagename
- Operations supported:
- POST GET DELETE
Properties
Properties represent fields of data stored in the entity. Some properties are read-only.
| Name | Type | Details | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| clientdata | Edm.String |
Step metadata for process stage Display name: Client Data Read only
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| connector | Edm.String |
The connector associated with the stage. Display name: Connector |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| istrigger | Edm.Boolean |
Whether the stage is a trigger Display name: Is Trigger
Default options
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| operationid | Edm.String |
The operation id of the stage Display name: Operation Id |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| operationkind | Edm.Int32 |
The operation kind Display name: Operation Kind
Default options
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| operationtype | Edm.Int32 |
The type of the operation Display name: Operation Type
Default options
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| owningbusinessunit | Edm.Guid |
Select the business unit that owns the record. Display name: Owning Business Unit Read only
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| parametername | Edm.String |
The parameter name. Display name: Name |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| parametervalue | Edm.String |
The parameter value. Display name: Value |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| primaryentitytypecode | Edm.String |
Primary entity associated with the stage. Display name: Primary Entity |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| processstageid | Edm.Guid |
Shows the ID of the process stage record. Display name: Process Stage |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| stagecategory | Edm.Int32 |
Select the category of the sales process. Display name: Stage Category
Default options
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| stagename | Edm.String |
Type a name for the process stage. Display name: Process Stage Name |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| versionnumber | Edm.Int64 |
Version number of the process stage. Display name: Version Number Read only
|
Lookup properties
Lookup properties are read-only, computed properties which contain entity primary key Edm.Guid data for one or more corresponding single-valued navigation properties. More information: Lookup properties and Lookup property data.
| Name | Single-valued navigation property | Description |
|---|---|---|
| _parentprocessstageid_value | ParentProcessStageId |
The parent stage for the parameter. |
| _processid_value | processid |
Shows the ID of the process. |
Single-valued navigation properties
Single-valued navigation properties represent lookup fields where a single entity can be referenced. Each single-valued navigation property has a corresponding partner collection-valued navigation property on the related entity.
| Name | Type | Partner |
|---|---|---|
| ParentProcessStageId | processstage | processstage_parentprocessstage |
| processid | workflow | process_processstage |
Collection-valued navigation properties
Collection-valued navigation properties represent collections of entities which may represent either a one-to-many (1:N) or many-to-many (N:N) relationship between the entities.
| Name | Type | Partner |
|---|---|---|
| processstage_account | account | stageid_processstage |
| processstage_adx_portalcomment | adx_portalcomment | stageid_adx_portalcomment |
| processstage_appointments | appointment | stageid_processstage |
| processstage_contact | contact | stageid_processstage |
| processstage_emails | stageid_processstage | |
| processstage_expiredprocess | expiredprocess | activestageid |
| processstage_faxes | fax | stageid_processstage |
| processstage_knowledgearticle | knowledgearticle | stageid_processstage |
| processstage_letters | letter | stageid_processstage |
| processstage_newprocess | newprocess | activestageid |
| processstage_parentprocessstage | processstage | ParentProcessStageId |
| processstage_phonecalls | phonecall | stageid_processstage |
| processstage_processstageparameter | processstageparameter | ProcessStageId |
| processstage_recurringappointmentmasters | recurringappointmentmaster | stageid_processstage |
| ProcessStage_SyncErrors | syncerror | regardingobjectid_processstage_syncerror |
| processstage_systemusers | systemuser | stageid_processstage |
| processstage_tasks | task | stageid_processstage |
| processstage_teams | team | stageid_processstage |
| processstage_translationprocess | translationprocess | activestageid |
Operations
The following operations can be used with the processstage entity type.
| Name | Binding |
|---|---|
| RetrieveActivePath | Not Bound |