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
Values Label
1 Yes
0 No
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
Values Label
473330000 Http
473330001 PowerApp
473330002 PowerAppV2
473330003 Button
473330004 ApiConnection
473330005 Alert
473330006 EventGrid
473330007 CurrentTime
473330008 ConvertTimeZone
473330009 GetFutureTime
473330010 GetPastTime
473330011 AddToTime
473330012 SubtractFromTime
473330013 AzureMonitorAlert
473330014 SecurityCenterAlert
473330015 JsonToJson
473330016 JsonToText
473330017 XmlToJson
473330018 XmlToText
473330019 Geofence
473330020 ODataOpenApiConnection
473330021 IndexOf
473330022 Substring
473330023 VirtualAgent
473330024 FormatNumber
473330025 Skills
operationtype Edm.Int32

The type of the operation

Display Name: Operation Type

Default Options
Values Label
473330000 Http
473330001 ApiApp
473330002 Recurrence
473330003 Workflow
473330004 Flow
473330005 Wait
473330006 ApiConnection
473330007 OpenApiConnection
473330008 Manual
473330009 ApiConnectionWebhook
473330010 OpenApiConnectionWebhook
473330011 Response
473330012 HttpWebhook
473330013 Compose
473330014 Query
473330015 Function
473330016 ApiManagement
473330017 XmlValidation
473330018 FlatFileEncoding
473330019 Scope
473330020 Request
473330021 If
473330022 Foreach
473330023 Until
473330024 Xslt
473330025 FlatFileDecoding
473330026 Terminate
473330027 IntegrationAccountArtifactLookup
473330028 Switch
473330029 ParseJson
473330030 Table
473330031 Join
473330032 Select
473330033 InitializeVariable
473330034 IncrementVariable
473330035 DecrementVariable
473330036 SetVariable
473330037 AppendToArrayVariable
473330038 AppendToStringVariable
473330039 Batch
473330040 SendToBatch
473330041 SlidingWindow
473330042 Expression
473330043 Liquid
473330044 JavascriptCode
473330045 As2Decode
473330046 As2Encode
473330047 RosettaNetEncode
473330048 RosettaNetDecode
473330049 RosettaNetWaitForResponse
473330050 ApiConnectionNotification
473330051 Changeset
473330052 SwiftEncode
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
Values Label
0 Qualify
1 Develop
2 Propose
3 Close
4 Identify
5 Research
6 Resolve
7 Approval
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 email 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

See also