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 Key Attribute
- 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_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 |