Workflow entity reference
Note
Effective Nov 2020, Common Data Service has been renamed to Microsoft Dataverse.
Set of logical rules that define the steps necessary to automate a specific business process, task, or set of actions to be performed.
Messages
| Message | Web API Operation | SDK Assembly |
|---|---|---|
| Assign | PATCH [org URI]/api/data/v9.0/workflows(workflowid) Update ownerid property. |
AssignRequest |
| Create | POST [org URI]/api/data/v9.0/workflows See Create |
CreateRequest or Create |
| CreateWorkflowFromTemplate | CreateWorkflowFromTemplate Action | CreateWorkflowFromTemplateRequest |
| Delete | DELETE [org URI]/api/data/v9.0/workflows(workflowid) See Delete |
DeleteRequest or Delete |
| ExecuteWorkflow | ExecuteWorkflow Action | ExecuteWorkflowRequest |
| GrantAccess | GrantAccess Action | GrantAccessRequest |
| InitializeModernFlowFromAsyncWorkflow | InitializeModernFlowFromAsyncWorkflow Action | InitializeModernFlowFromAsyncWorkflowRequest |
| ModifyAccess | ModifyAccess Action | ModifyAccessRequest |
| Retrieve | GET [org URI]/api/data/v9.0/workflows(workflowid) See Retrieve |
RetrieveRequest or Retrieve |
| RetrieveMultiple | GET [org URI]/api/data/v9.0/workflows See Query Data |
RetrieveMultipleRequest or RetrieveMultiple |
| RetrievePrincipalAccess | RetrievePrincipalAccess Function | RetrievePrincipalAccessRequest |
| RetrieveSharedPrincipalsAndAccess | RetrieveSharedPrincipalsAndAccess Function | RetrieveSharedPrincipalsAndAccessRequest |
| RevokeAccess | RevokeAccess Action | RevokeAccessRequest |
| SetState | PATCH [org URI]/api/data/v9.0/workflows(workflowid) Update statecode and statuscode properties. |
SetStateRequest |
| Update | PATCH [org URI]/api/data/v9.0/workflows(workflowid) See Update |
UpdateRequest or Update |
Entity properties
| Property | Value |
|---|---|
| CollectionSchemaName | Workflows |
| DisplayCollectionName | Processes |
| DisplayName | Process |
| EntitySetName | workflows |
| IsBPFEntity | False |
| LogicalCollectionName | workflows |
| LogicalName | workflow |
| OwnershipType | UserOwned |
| PrimaryIdAttribute | workflowid |
| PrimaryNameAttribute | name |
| SchemaName | Workflow |
Writable attributes
These attributes return true for either IsValidForCreate or IsValidForUpdate (usually both). Listed by SchemaName.
- AsyncAutoDelete
- BusinessProcessType
- Category
- ClientData
- CreateStage
- DeleteStage
- Description
- EntityImage
- FormId
- InputParameters
- IntroducedVersion
- IsCustomizable
- IsCustomProcessingStepAllowedForOtherPublishers
- IsTransacted
- LanguageCode
- Mode
- Name
- OnDemand
- OwnerId
- OwnerIdType
- PrimaryEntity
- ProcessOrder
- ProcessRoleAssignment
- ProcessTriggerFormId
- ProcessTriggerScope
- Rank
- RendererObjectTypeCode
- RunAs
- Scope
- StateCode
- StatusCode
- Subprocess
- SyncWorkflowLogOnFailure
- TriggerOnCreate
- TriggerOnDelete
- TriggerOnUpdateAttributeList
- Type
- UIFlowType
- UniqueName
- UpdateStage
- WorkflowId
- Xaml
AsyncAutoDelete
| Property | Value |
|---|---|
| Description | Indicates whether the asynchronous system job is automatically deleted on completion. |
| DisplayName | Delete Job On Completion |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | asyncautodelete |
| RequiredLevel | SystemRequired |
| Type | Boolean |
AsyncAutoDelete Options
| Value | Label |
|---|---|
| 1 | Yes |
| 0 | No |
DefaultValue: False
BusinessProcessType
| Property | Value |
|---|---|
| Description | Business Process Type. |
| DisplayName | Business Process Type |
| IsValidForForm | True |
| IsValidForRead | True |
| IsValidForUpdate | False |
| LogicalName | businessprocesstype |
| RequiredLevel | None |
| Type | Picklist |
BusinessProcessType Options
| Value | Label |
|---|---|
| 0 | Business Flow |
| 1 | Task Flow |
Category
| Property | Value |
|---|---|
| Description | Category of the process. |
| DisplayName | Category |
| IsValidForForm | True |
| IsValidForRead | True |
| IsValidForUpdate | False |
| LogicalName | category |
| RequiredLevel | SystemRequired |
| Type | Picklist |
Category Options
| Value | Label |
|---|---|
| 0 | Workflow |
| 1 | Dialog |
| 2 | Business Rule |
| 3 | Action |
| 4 | Business Process Flow |
| 5 | Modern Flow |
| 6 | Reserved |
ClientData
| Property | Value |
|---|---|
| Description | Business logic converted into client data |
| DisplayName | Client Data |
| Format | TextArea |
| IsLocalizable | False |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | clientdata |
| MaxLength | 1073741823 |
| RequiredLevel | None |
| Type | Memo |
CreateStage
| Property | Value |
|---|---|
| Description | Stage of the process when triggered on Create. |
| DisplayName | Create Stage |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | createstage |
| RequiredLevel | None |
| Type | Picklist |
CreateStage Options
| Value | Label |
|---|---|
| 20 | Pre-operation |
| 40 | Post-operation |
DeleteStage
| Property | Value |
|---|---|
| Description | Stage of the process when triggered on Delete. |
| DisplayName | Delete stage |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | deletestage |
| RequiredLevel | None |
| Type | Picklist |
DeleteStage Options
| Value | Label |
|---|---|
| 20 | Pre-operation |
| 40 | Post-operation |
Description
| Property | Value |
|---|---|
| Description | Description of the process. |
| DisplayName | Description |
| Format | TextArea |
| IsLocalizable | True |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | description |
| MaxLength | 100000 |
| RequiredLevel | None |
| Type | Memo |
EntityImage
| Property | Value |
|---|---|
| Description | Shows the default image for the record. |
| DisplayName | Default Image |
| IsPrimaryImage | True |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | entityimage |
| MaxHeight | 144 |
| MaxWidth | 144 |
| RequiredLevel | None |
| Type | Image |
FormId
| Property | Value |
|---|---|
| Description | Unique identifier of the associated form. |
| DisplayName | Form ID |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | formid |
| RequiredLevel | None |
| Type | Uniqueidentifier |
InputParameters
| Property | Value |
|---|---|
| Description | Input parameters to the process. |
| DisplayName | Input Parameters |
| Format | TextArea |
| IsLocalizable | False |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | inputparameters |
| MaxLength | 1073741823 |
| RequiredLevel | None |
| Type | Memo |
IntroducedVersion
| Property | Value |
|---|---|
| Description | Version in which the form is introduced. |
| DisplayName | Introduced Version |
| FormatName | VersionNumber |
| IsLocalizable | False |
| IsValidForForm | False |
| IsValidForRead | True |
| IsValidForUpdate | False |
| LogicalName | introducedversion |
| MaxLength | 48 |
| RequiredLevel | None |
| Type | String |
IsCustomizable
| Property | Value |
|---|---|
| Description | Information that specifies whether this component can be customized. |
| DisplayName | Customizable |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | iscustomizable |
| RequiredLevel | SystemRequired |
| Type | ManagedProperty |
IsCustomProcessingStepAllowedForOtherPublishers
Added by: MessageProcessorExtension Solution
| Property | Value |
|---|---|
| Description | Defines whether other publishers can attach custom processing steps to this action |
| DisplayName | Allow custom processing step for other publishers |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | iscustomprocessingstepallowedforotherpublishers |
| RequiredLevel | SystemRequired |
| Type | ManagedProperty |
IsTransacted
| Property | Value |
|---|---|
| Description | Whether or not the steps in the process are executed in a single transaction. |
| DisplayName | Is Transacted |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | istransacted |
| RequiredLevel | None |
| Type | Boolean |
IsTransacted Options
| Value | Label |
|---|---|
| 1 | Yes |
| 0 | No |
DefaultValue: True
LanguageCode
| Property | Value |
|---|---|
| Description | Language of the process. |
| DisplayName | Language |
| Format | Language |
| IsValidForForm | True |
| IsValidForRead | True |
| IsValidForUpdate | False |
| LogicalName | languagecode |
| MaxValue | 2147483647 |
| MinValue | 0 |
| RequiredLevel | None |
| Type | Integer |
Mode
| Property | Value |
|---|---|
| Description | Shows the mode of the process. |
| DisplayName | Mode |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | mode |
| RequiredLevel | SystemRequired |
| Type | Picklist |
Mode Options
| Value | Label |
|---|---|
| 0 | Background |
| 1 | Real-time |
Name
| Property | Value |
|---|---|
| Description | Name of the process. |
| DisplayName | Process Name |
| FormatName | Text |
| IsLocalizable | True |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | name |
| MaxLength | 100 |
| RequiredLevel | SystemRequired |
| Type | String |
OnDemand
| Property | Value |
|---|---|
| Description | Indicates whether the process is able to run as an on-demand process. |
| DisplayName | Run as On Demand |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | ondemand |
| RequiredLevel | None |
| Type | Boolean |
OnDemand Options
| Value | Label |
|---|---|
| 1 | Yes |
| 0 | No |
DefaultValue: False
OwnerId
| Property | Value |
|---|---|
| Description | Unique identifier of the user or team who owns the process. |
| DisplayName | Owner |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | ownerid |
| RequiredLevel | SystemRequired |
| Targets | systemuser |
| Type | Owner |
OwnerIdType
| Property | Value |
|---|---|
| Description | |
| DisplayName | |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | owneridtype |
| RequiredLevel | SystemRequired |
| Type | EntityName |
PrimaryEntity
| Property | Value |
|---|---|
| Description | Primary entity for the process. The process can be associated for one or more SDK operations defined on the primary entity. |
| DisplayName | Primary Entity |
| IsValidForForm | False |
| IsValidForRead | True |
| IsValidForUpdate | False |
| LogicalName | primaryentity |
| RequiredLevel | SystemRequired |
| Type | EntityName |
ProcessOrder
| Property | Value |
|---|---|
| Description | Type the business process flow order. |
| DisplayName | Process Order |
| Format | None |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | processorder |
| MaxValue | 2147483647 |
| MinValue | 0 |
| RequiredLevel | None |
| Type | Integer |
ProcessRoleAssignment
| Property | Value |
|---|---|
| Description | Contains the role assignment for the process. |
| DisplayName | Role assignment for Process |
| Format | Text |
| IsLocalizable | False |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | processroleassignment |
| MaxLength | 1048576 |
| RequiredLevel | None |
| Type | Memo |
ProcessTriggerFormId
| Property | Value |
|---|---|
| Description | Unique identifier of the associated form for process trigger. |
| DisplayName | ProcessTriggerFormId |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | processtriggerformid |
| RequiredLevel | None |
| Type | Uniqueidentifier |
ProcessTriggerScope
| Property | Value |
|---|---|
| Description | Scope of the process trigger. |
| DisplayName | ProcessTriggerScope |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | processtriggerscope |
| RequiredLevel | None |
| Type | Picklist |
ProcessTriggerScope Options
| Value | Label |
|---|---|
| 1 | Form |
| 2 | Entity |
Rank
| Property | Value |
|---|---|
| Description | Indicates the rank for order of execution for the synchronous workflow. |
| DisplayName | Rank |
| Format | None |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | rank |
| MaxValue | 2147483647 |
| MinValue | -2147483648 |
| RequiredLevel | None |
| Type | Integer |
RendererObjectTypeCode
| Property | Value |
|---|---|
| Description | The renderer type of Workflow |
| DisplayName | Renderer Type |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | rendererobjecttypecode |
| RequiredLevel | None |
| Type | EntityName |
RunAs
| Property | Value |
|---|---|
| Description | Specifies the system user account under which a workflow executes. |
| DisplayName | Run As User |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | runas |
| RequiredLevel | None |
| Type | Picklist |
RunAs Options
| Value | Label |
|---|---|
| 0 | Owner |
| 1 | Calling User |
Scope
| Property | Value |
|---|---|
| Description | Scope of the process. |
| DisplayName | Scope |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | scope |
| RequiredLevel | SystemRequired |
| Type | Picklist |
Scope Options
| Value | Label |
|---|---|
| 1 | User |
| 2 | Business Unit |
| 3 | Parent: Child Business Units |
| 4 | Organization |
StateCode
| Property | Value |
|---|---|
| Description | Status of the process. |
| DisplayName | Status |
| IsValidForCreate | False |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | statecode |
| RequiredLevel | SystemRequired |
| Type | State |
StateCode Options
| Value | Label | DefaultStatus | InvariantName |
|---|---|---|---|
| 0 | Draft | 1 | Draft |
| 1 | Activated | 2 | Activated |
StatusCode
| Property | Value |
|---|---|
| Description | Additional information about status of the process. |
| DisplayName | Status Reason |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | statuscode |
| RequiredLevel | None |
| Type | Status |
StatusCode Options
| Value | Label | State |
|---|---|---|
| 1 | Draft | 0 |
| 2 | Activated | 1 |
Subprocess
| Property | Value |
|---|---|
| Description | Indicates whether the process can be included in other processes as a child process. |
| DisplayName | Is Child Process |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | subprocess |
| RequiredLevel | None |
| Type | Boolean |
Subprocess Options
| Value | Label |
|---|---|
| 1 | Yes |
| 0 | No |
DefaultValue: False
SyncWorkflowLogOnFailure
| Property | Value |
|---|---|
| Description | Select whether synchronous workflow failures will be saved to log files. |
| DisplayName | Log upon Failure |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | syncworkflowlogonfailure |
| RequiredLevel | SystemRequired |
| Type | Boolean |
SyncWorkflowLogOnFailure Options
| Value | Label |
|---|---|
| 1 | Yes |
| 0 | No |
DefaultValue: False
TriggerOnCreate
| Property | Value |
|---|---|
| Description | Indicates whether the process will be triggered when the primary entity is created. |
| DisplayName | Trigger On Create |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | triggeroncreate |
| RequiredLevel | None |
| Type | Boolean |
TriggerOnCreate Options
| Value | Label |
|---|---|
| 1 | Yes |
| 0 | No |
DefaultValue: False
TriggerOnDelete
| Property | Value |
|---|---|
| Description | Indicates whether the process will be triggered on deletion of the primary entity. |
| DisplayName | Trigger On Delete |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | triggerondelete |
| RequiredLevel | None |
| Type | Boolean |
TriggerOnDelete Options
| Value | Label |
|---|---|
| 1 | Yes |
| 0 | No |
DefaultValue: False
TriggerOnUpdateAttributeList
| Property | Value |
|---|---|
| Description | Attributes that trigger the process when updated. |
| DisplayName | Trigger On Update Attribute List |
| Format | TextArea |
| IsLocalizable | False |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | triggeronupdateattributelist |
| MaxLength | 1073741823 |
| RequiredLevel | None |
| Type | Memo |
Type
| Property | Value |
|---|---|
| Description | Type of the process. |
| DisplayName | Type |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | type |
| RequiredLevel | SystemRequired |
| Type | Picklist |
Type Options
| Value | Label |
|---|---|
| 1 | Definition |
| 2 | Activation |
| 3 | Template |
UIFlowType
| Property | Value |
|---|---|
| Description | Type of the UI Flow process. |
| DisplayName | UI Flow Type |
| IsValidForForm | True |
| IsValidForRead | True |
| IsValidForUpdate | False |
| LogicalName | uiflowtype |
| RequiredLevel | None |
| Type | Picklist |
UIFlowType Options
| Value | Label |
|---|---|
| 0 | Desktop |
| 1 | Selenium IDE |
| 2 | PowerShell |
UniqueName
| Property | Value |
|---|---|
| Description | Unique name of the process |
| DisplayName | Unique Name |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | uniquename |
| MaxLength | 256 |
| RequiredLevel | None |
| Type | String |
UpdateStage
| Property | Value |
|---|---|
| Description | Select the stage a process will be triggered on update. |
| DisplayName | Update Stage |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | updatestage |
| RequiredLevel | None |
| Type | Picklist |
UpdateStage Options
| Value | Label |
|---|---|
| 20 | Pre-operation |
| 40 | Post-operation |
WorkflowId
| Property | Value |
|---|---|
| Description | Unique identifier of the process. |
| DisplayName | Process |
| IsValidForForm | False |
| IsValidForRead | True |
| IsValidForUpdate | False |
| LogicalName | workflowid |
| RequiredLevel | SystemRequired |
| Type | Uniqueidentifier |
Xaml
| Property | Value |
|---|---|
| Description | XAML that defines the process. |
| DisplayName | |
| Format | TextArea |
| IsLocalizable | False |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | xaml |
| MaxLength | 1073741823 |
| RequiredLevel | ApplicationRequired |
| Type | Memo |
Read-only attributes
These attributes return false for both IsValidForCreate or IsValidForUpdate. Listed by SchemaName.
- ActiveWorkflowId
- ActiveWorkflowIdName
- ComponentState
- CreatedBy
- CreatedByName
- CreatedByYomiName
- CreatedOn
- CreatedOnBehalfBy
- CreatedOnBehalfByName
- CreatedOnBehalfByYomiName
- EntityImage_Timestamp
- EntityImage_URL
- EntityImageId
- IsCrmUIWorkflow
- IsManaged
- ModifiedBy
- ModifiedByName
- ModifiedByYomiName
- ModifiedOn
- ModifiedOnBehalfBy
- ModifiedOnBehalfByName
- ModifiedOnBehalfByYomiName
- OverwriteTime
- OwnerIdName
- OwnerIdYomiName
- OwningBusinessUnit
- OwningBusinessUnitName
- OwningTeam
- OwningUser
- ParentWorkflowId
- ParentWorkflowIdName
- PluginTypeId
- SdkMessageId
- SolutionId
- SupportingSolutionId
- UIData
- VersionNumber
- WorkflowIdUnique
ActiveWorkflowId
| Property | Value |
|---|---|
| Description | Unique identifier of the latest activation record for the process. |
| DisplayName | Active Process ID |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | activeworkflowid |
| RequiredLevel | None |
| Targets | workflow |
| Type | Lookup |
ActiveWorkflowIdName
| Property | Value |
|---|---|
| Description | |
| DisplayName | |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | activeworkflowidname |
| MaxLength | 100 |
| RequiredLevel | None |
| Type | String |
ComponentState
| Property | Value |
|---|---|
| Description | For internal use only. |
| DisplayName | Component State |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | componentstate |
| RequiredLevel | SystemRequired |
| Type | Picklist |
ComponentState Options
| Value | Label |
|---|---|
| 0 | Published |
| 1 | Unpublished |
| 2 | Deleted |
| 3 | Deleted Unpublished |
CreatedBy
| Property | Value |
|---|---|
| Description | Unique identifier of the user who created the process. |
| DisplayName | Created By |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | createdby |
| RequiredLevel | None |
| Targets | systemuser |
| Type | Lookup |
CreatedByName
| Property | Value |
|---|---|
| Description | |
| DisplayName | |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | createdbyname |
| MaxLength | 100 |
| RequiredLevel | None |
| Type | String |
CreatedByYomiName
| Property | Value |
|---|---|
| Description | |
| DisplayName | |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | createdbyyominame |
| MaxLength | 100 |
| RequiredLevel | None |
| Type | String |
CreatedOn
| Property | Value |
|---|---|
| DateTimeBehavior | UserLocal |
| Description | Date and time when the process was created. |
| DisplayName | Created On |
| Format | DateAndTime |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | createdon |
| RequiredLevel | None |
| Type | DateTime |
CreatedOnBehalfBy
| Property | Value |
|---|---|
| Description | Unique identifier of the delegate user who created the process. |
| DisplayName | Created By (Delegate) |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | createdonbehalfby |
| RequiredLevel | None |
| Targets | systemuser |
| Type | Lookup |
CreatedOnBehalfByName
| Property | Value |
|---|---|
| Description | |
| DisplayName | |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | createdonbehalfbyname |
| MaxLength | 100 |
| RequiredLevel | None |
| Type | String |
CreatedOnBehalfByYomiName
| Property | Value |
|---|---|
| Description | |
| DisplayName | |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | createdonbehalfbyyominame |
| MaxLength | 100 |
| RequiredLevel | None |
| Type | String |
EntityImage_Timestamp
| Property | Value |
|---|---|
| Description | |
| DisplayName | |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | entityimage_timestamp |
| MaxValue | 9223372036854775807 |
| MinValue | -9223372036854775808 |
| RequiredLevel | None |
| Type | BigInt |
EntityImage_URL
| Property | Value |
|---|---|
| Description | |
| DisplayName | |
| FormatName | Url |
| IsLocalizable | False |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | entityimage_url |
| MaxLength | 200 |
| RequiredLevel | None |
| Type | String |
EntityImageId
| Property | Value |
|---|---|
| Description | For internal use only. |
| DisplayName | Entity Image Id |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | entityimageid |
| RequiredLevel | None |
| Type | Uniqueidentifier |
IsCrmUIWorkflow
| Property | Value |
|---|---|
| Description | Indicates whether the process was created using the Microsoft Dynamics 365 Web application. |
| DisplayName | Is CRM Process |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | iscrmuiworkflow |
| RequiredLevel | None |
| Type | Boolean |
IsCrmUIWorkflow Options
| Value | Label |
|---|---|
| 1 | Yes |
| 0 | No |
DefaultValue: False
IsManaged
| Property | Value |
|---|---|
| Description | Indicates whether the solution component is part of a managed solution. |
| DisplayName | Is Managed |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | ismanaged |
| RequiredLevel | SystemRequired |
| Type | Boolean |
IsManaged Options
| Value | Label |
|---|---|
| 1 | Managed |
| 0 | Unmanaged |
DefaultValue: False
ModifiedBy
| Property | Value |
|---|---|
| Description | Unique identifier of the user who last modified the process. |
| DisplayName | Modified By |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | modifiedby |
| RequiredLevel | None |
| Targets | systemuser |
| Type | Lookup |
ModifiedByName
| Property | Value |
|---|---|
| Description | |
| DisplayName | |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | modifiedbyname |
| MaxLength | 100 |
| RequiredLevel | None |
| Type | String |
ModifiedByYomiName
| Property | Value |
|---|---|
| Description | |
| DisplayName | |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | modifiedbyyominame |
| MaxLength | 100 |
| RequiredLevel | None |
| Type | String |
ModifiedOn
| Property | Value |
|---|---|
| DateTimeBehavior | UserLocal |
| Description | Date and time when the process was last modified. |
| DisplayName | Modified On |
| Format | DateAndTime |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | modifiedon |
| RequiredLevel | None |
| Type | DateTime |
ModifiedOnBehalfBy
| Property | Value |
|---|---|
| Description | Unique identifier of the delegate user who last modified the process. |
| DisplayName | Modified By (Delegate) |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | modifiedonbehalfby |
| RequiredLevel | None |
| Targets | systemuser |
| Type | Lookup |
ModifiedOnBehalfByName
| Property | Value |
|---|---|
| Description | |
| DisplayName | |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | modifiedonbehalfbyname |
| MaxLength | 100 |
| RequiredLevel | None |
| Type | String |
ModifiedOnBehalfByYomiName
| Property | Value |
|---|---|
| Description | |
| DisplayName | |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | modifiedonbehalfbyyominame |
| MaxLength | 100 |
| RequiredLevel | None |
| Type | String |
OverwriteTime
| Property | Value |
|---|---|
| DateTimeBehavior | UserLocal |
| Description | For internal use only. |
| DisplayName | Record Overwrite Time |
| Format | DateOnly |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | overwritetime |
| RequiredLevel | SystemRequired |
| Type | DateTime |
OwnerIdName
| Property | Value |
|---|---|
| Description | |
| DisplayName | |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | owneridname |
| MaxLength | 100 |
| RequiredLevel | SystemRequired |
| Type | String |
OwnerIdYomiName
| Property | Value |
|---|---|
| Description | |
| DisplayName | |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | owneridyominame |
| MaxLength | 100 |
| RequiredLevel | SystemRequired |
| Type | String |
OwningBusinessUnit
| Property | Value |
|---|---|
| Description | Unique identifier of the business unit that owns the process. |
| DisplayName | Owning Business Unit |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | owningbusinessunit |
| RequiredLevel | None |
| Targets | businessunit |
| Type | Lookup |
OwningBusinessUnitName
| Property | Value |
|---|---|
| Description | |
| DisplayName | |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | owningbusinessunitname |
| MaxLength | 100 |
| RequiredLevel | None |
| Type | String |
OwningTeam
| Property | Value |
|---|---|
| Description | Unique identifier of the team who owns the process. |
| DisplayName | Owning Team |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | owningteam |
| RequiredLevel | None |
| Targets | team |
| Type | Lookup |
OwningUser
| Property | Value |
|---|---|
| Description | Unique identifier of the user who owns the process. |
| DisplayName | Owning User |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | owninguser |
| RequiredLevel | None |
| Targets | systemuser |
| Type | Lookup |
ParentWorkflowId
| Property | Value |
|---|---|
| Description | Unique identifier of the definition for process activation. |
| DisplayName | Parent Process ID |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | parentworkflowid |
| RequiredLevel | None |
| Targets | workflow |
| Type | Lookup |
ParentWorkflowIdName
| Property | Value |
|---|---|
| Description | |
| DisplayName | |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | parentworkflowidname |
| MaxLength | 100 |
| RequiredLevel | None |
| Type | String |
PluginTypeId
| Property | Value |
|---|---|
| Description | Unique identifier of the plug-in type. |
| DisplayName | |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | plugintypeid |
| RequiredLevel | None |
| Targets | sdkmessagefilter |
| Type | Lookup |
SdkMessageId
| Property | Value |
|---|---|
| Description | Unique identifier of the SDK Message associated with this workflow. |
| DisplayName | SDK Message |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | sdkmessageid |
| RequiredLevel | None |
| Targets | sdkmessage |
| Type | Lookup |
SolutionId
| Property | Value |
|---|---|
| Description | Unique identifier of the associated solution. |
| DisplayName | Solution |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | solutionid |
| RequiredLevel | SystemRequired |
| Type | Uniqueidentifier |
SupportingSolutionId
| Property | Value |
|---|---|
| Description | For internal use only. |
| DisplayName | Solution |
| IsValidForForm | False |
| IsValidForRead | False |
| LogicalName | supportingsolutionid |
| RequiredLevel | None |
| Type | Uniqueidentifier |
UIData
| Property | Value |
|---|---|
| Description | For internal use only. |
| DisplayName | UI Data |
| Format | TextArea |
| IsLocalizable | False |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | uidata |
| MaxLength | 1073741823 |
| RequiredLevel | None |
| Type | Memo |
VersionNumber
| Property | Value |
|---|---|
| Description | |
| DisplayName | |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | versionnumber |
| MaxValue | 9223372036854775807 |
| MinValue | -9223372036854775808 |
| RequiredLevel | None |
| Type | BigInt |
WorkflowIdUnique
| Property | Value |
|---|---|
| Description | For internal use only. |
| DisplayName | |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | workflowidunique |
| RequiredLevel | SystemRequired |
| Type | Uniqueidentifier |
One-To-Many Relationships
Listed by SchemaName.
- Workflow_Annotation
- process_processstage
- lk_asyncoperation_workflowactivationid
- process_processtrigger
- lk_expiredprocess_processid
- workflow_parent_workflow
- slaitembase_workflowid
- slabase_workflowid
- lk_processsession_processid
- lk_translationprocess_processid
- lk_newprocess_processid
- Workflow_SyncErrors
- workflow_active_workflow
- regardingobjectid_process
- workflow_workflowbinary_Process
- catalogassignment_workflow
- msdyn_retrainworkflow_msdyn_toaimodel
- msdyn_scheduleinferenceworkflow_msdyn_toaimodel
- msdyn_workflow_msdyn_solutionhealthrule_Workflow
- msdyn_workflow_msdyn_solutionhealthrule_resolutionaction
Workflow_Annotation
Same as annotation entity Workflow_Annotation Many-To-One relationship.
| Property | Value |
|---|---|
| ReferencingEntity | annotation |
| ReferencingAttribute | objectid |
| IsHierarchical | False |
| IsCustomizable | True |
| ReferencedEntityNavigationPropertyName | Workflow_Annotation |
| AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
| CascadeConfiguration | Assign: Cascade Delete: Cascade Merge: NoCascade Reparent: Cascade Share: Cascade Unshare: Cascade |
process_processstage
Same as processstage entity process_processstage Many-To-One relationship.
| Property | Value |
|---|---|
| ReferencingEntity | processstage |
| ReferencingAttribute | processid |
| IsHierarchical | False |
| IsCustomizable | False |
| ReferencedEntityNavigationPropertyName | process_processstage |
| AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
| CascadeConfiguration | Assign: Cascade Delete: Cascade Merge: NoCascade Reparent: NoCascade Share: Cascade Unshare: Cascade |
lk_asyncoperation_workflowactivationid
Same as asyncoperation entity lk_asyncoperation_workflowactivationid Many-To-One relationship.
| Property | Value |
|---|---|
| ReferencingEntity | asyncoperation |
| ReferencingAttribute | workflowactivationid |
| IsHierarchical | False |
| IsCustomizable | False |
| ReferencedEntityNavigationPropertyName | lk_asyncoperation_workflowactivationid |
| AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
| CascadeConfiguration | Assign: NoCascade Delete: RemoveLink Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
process_processtrigger
Same as processtrigger entity process_processtrigger Many-To-One relationship.
| Property | Value |
|---|---|
| ReferencingEntity | processtrigger |
| ReferencingAttribute | processid |
| IsHierarchical | False |
| IsCustomizable | False |
| ReferencedEntityNavigationPropertyName | process_processtrigger |
| AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
| CascadeConfiguration | Assign: NoCascade Delete: Cascade Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
lk_expiredprocess_processid
Same as expiredprocess entity lk_expiredprocess_processid Many-To-One relationship.
| Property | Value |
|---|---|
| ReferencingEntity | expiredprocess |
| ReferencingAttribute | processid |
| IsHierarchical | False |
| IsCustomizable | True |
| ReferencedEntityNavigationPropertyName | workflow_expiredprocess |
| AssociatedMenuConfiguration | Behavior: UseCollectionName Group: Details Label: Order: |
| CascadeConfiguration | Assign: NoCascade Delete: NoCascade Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
workflow_parent_workflow
Same as workflow entity workflow_parent_workflow Many-To-One relationship.
| Property | Value |
|---|---|
| ReferencingEntity | workflow |
| ReferencingAttribute | parentworkflowid |
| IsHierarchical | False |
| IsCustomizable | False |
| ReferencedEntityNavigationPropertyName | workflow_parent_workflow |
| AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
| CascadeConfiguration | Assign: NoCascade Delete: NoCascade Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
slaitembase_workflowid
Same as slaitem entity slaitembase_workflowid Many-To-One relationship.
| Property | Value |
|---|---|
| ReferencingEntity | slaitem |
| ReferencingAttribute | workflowid |
| IsHierarchical | False |
| IsCustomizable | True |
| ReferencedEntityNavigationPropertyName | slaitembase_workflowid |
| AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
| CascadeConfiguration | Assign: NoCascade Delete: NoCascade Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
slabase_workflowid
Same as sla entity slabase_workflowid Many-To-One relationship.
| Property | Value |
|---|---|
| ReferencingEntity | sla |
| ReferencingAttribute | workflowid |
| IsHierarchical | False |
| IsCustomizable | True |
| ReferencedEntityNavigationPropertyName | slabase_workflowid |
| AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
| CascadeConfiguration | Assign: NoCascade Delete: NoCascade Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
lk_processsession_processid
Same as processsession entity lk_processsession_processid Many-To-One relationship.
| Property | Value |
|---|---|
| ReferencingEntity | processsession |
| ReferencingAttribute | processid |
| IsHierarchical | False |
| IsCustomizable | False |
| ReferencedEntityNavigationPropertyName | lk_processsession_processid |
| AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
| CascadeConfiguration | Assign: NoCascade Delete: Cascade Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
lk_translationprocess_processid
Same as translationprocess entity lk_translationprocess_processid Many-To-One relationship.
| Property | Value |
|---|---|
| ReferencingEntity | translationprocess |
| ReferencingAttribute | processid |
| IsHierarchical | False |
| IsCustomizable | True |
| ReferencedEntityNavigationPropertyName | workflow_translationprocess |
| AssociatedMenuConfiguration | Behavior: UseCollectionName Group: Details Label: Order: |
| CascadeConfiguration | Assign: NoCascade Delete: NoCascade Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
lk_newprocess_processid
Same as newprocess entity lk_newprocess_processid Many-To-One relationship.
| Property | Value |
|---|---|
| ReferencingEntity | newprocess |
| ReferencingAttribute | processid |
| IsHierarchical | False |
| IsCustomizable | True |
| ReferencedEntityNavigationPropertyName | workflow_newprocess |
| AssociatedMenuConfiguration | Behavior: UseCollectionName Group: Details Label: Order: |
| CascadeConfiguration | Assign: NoCascade Delete: NoCascade Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
Workflow_SyncErrors
Same as syncerror entity Workflow_SyncErrors Many-To-One relationship.
| Property | Value |
|---|---|
| ReferencingEntity | syncerror |
| ReferencingAttribute | regardingobjectid |
| IsHierarchical | False |
| IsCustomizable | True |
| ReferencedEntityNavigationPropertyName | Workflow_SyncErrors |
| AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
| CascadeConfiguration | Assign: Cascade Delete: Cascade Merge: Cascade Reparent: Cascade Share: Cascade Unshare: Cascade |
workflow_active_workflow
Same as workflow entity workflow_active_workflow Many-To-One relationship.
| Property | Value |
|---|---|
| ReferencingEntity | workflow |
| ReferencingAttribute | activeworkflowid |
| IsHierarchical | False |
| IsCustomizable | False |
| ReferencedEntityNavigationPropertyName | workflow_active_workflow |
| AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
| CascadeConfiguration | Assign: NoCascade Delete: Restrict Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
regardingobjectid_process
Added by: Microsoft Flow Extensions core package Solution
Same as flowsession entity regardingobjectid_process Many-To-One relationship.
| Property | Value |
|---|---|
| ReferencingEntity | flowsession |
| ReferencingAttribute | regardingobjectid |
| IsHierarchical | False |
| IsCustomizable | False |
| ReferencedEntityNavigationPropertyName | regardingobjectid_process |
| AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
| CascadeConfiguration | Assign: NoCascade Delete: Cascade Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
workflow_workflowbinary_Process
Added by: Microsoft Flow Extensions core package Solution
Same as workflowbinary entity workflow_workflowbinary_Process Many-To-One relationship.
| Property | Value |
|---|---|
| ReferencingEntity | workflowbinary |
| ReferencingAttribute | process |
| IsHierarchical | False |
| IsCustomizable | False |
| ReferencedEntityNavigationPropertyName | workflow_workflowbinary_Process |
| AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
| CascadeConfiguration | Assign: NoCascade Delete: Cascade Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
catalogassignment_workflow
Added by: CatalogFramework Solution
Same as catalogassignment entity catalogassignment_workflow Many-To-One relationship.
| Property | Value |
|---|---|
| ReferencingEntity | catalogassignment |
| ReferencingAttribute | object |
| IsHierarchical | False |
| IsCustomizable | False |
| ReferencedEntityNavigationPropertyName | CatalogAssignments |
| AssociatedMenuConfiguration | Behavior: UseCollectionName Group: Details Label: Order: 10000 |
| CascadeConfiguration | Assign: NoCascade Delete: RemoveLink Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
msdyn_retrainworkflow_msdyn_toaimodel
Added by: AISolution Solution
Same as msdyn_aimodel entity msdyn_retrainworkflow_msdyn_toaimodel Many-To-One relationship.
| Property | Value |
|---|---|
| ReferencingEntity | msdyn_aimodel |
| ReferencingAttribute | msdyn_retrainworkflowid |
| IsHierarchical | False |
| IsCustomizable | False |
| ReferencedEntityNavigationPropertyName | msdyn_retrainworkflow_msdyn_toaimodel |
| AssociatedMenuConfiguration | Behavior: UseCollectionName Group: Details Label: Order: 10000 |
| CascadeConfiguration | Assign: NoCascade Delete: RemoveLink Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
msdyn_scheduleinferenceworkflow_msdyn_toaimodel
Added by: AISolution Solution
Same as msdyn_aimodel entity msdyn_scheduleinferenceworkflow_msdyn_toaimodel Many-To-One relationship.
| Property | Value |
|---|---|
| ReferencingEntity | msdyn_aimodel |
| ReferencingAttribute | msdyn_scheduleinferenceworkflowid |
| IsHierarchical | False |
| IsCustomizable | False |
| ReferencedEntityNavigationPropertyName | msdyn_scheduleinferenceworkflow_msdyn_toaimodel |
| AssociatedMenuConfiguration | Behavior: UseCollectionName Group: Details Label: Order: 10000 |
| CascadeConfiguration | Assign: NoCascade Delete: RemoveLink Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
msdyn_workflow_msdyn_solutionhealthrule_Workflow
Added by: Power Apps Checker Solution
Same as msdyn_solutionhealthrule entity msdyn_workflow_msdyn_solutionhealthrule_Workflow Many-To-One relationship.
| Property | Value |
|---|---|
| ReferencingEntity | msdyn_solutionhealthrule |
| ReferencingAttribute | msdyn_workflow |
| IsHierarchical | False |
| IsCustomizable | False |
| ReferencedEntityNavigationPropertyName | msdyn_workflow_msdyn_solutionhealthrule_Workflow |
| AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: 10000 |
| CascadeConfiguration | Assign: NoCascade Delete: RemoveLink Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
msdyn_workflow_msdyn_solutionhealthrule_resolutionaction
Added by: Power Apps Checker Solution
Same as msdyn_solutionhealthrule entity msdyn_workflow_msdyn_solutionhealthrule_resolutionaction Many-To-One relationship.
| Property | Value |
|---|---|
| ReferencingEntity | msdyn_solutionhealthrule |
| ReferencingAttribute | msdyn_resolutionaction |
| IsHierarchical | False |
| IsCustomizable | False |
| ReferencedEntityNavigationPropertyName | msdyn_workflow_msdyn_solutionhealthrule_resolutionaction |
| AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: 10000 |
| CascadeConfiguration | Assign: NoCascade Delete: RemoveLink 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.
- workflow_active_workflow
- workflow_modifiedby
- workflow_createdonbehalfby
- business_unit_workflow
- system_user_workflow
- team_workflow
- workflow_createdby
- workflow_parent_workflow
- workflow_modifiedonbehalfby
workflow_active_workflow
See workflow Entity workflow_active_workflow One-To-Many relationship.
workflow_modifiedby
See systemuser Entity workflow_modifiedby One-To-Many relationship.
workflow_createdonbehalfby
See systemuser Entity workflow_createdonbehalfby One-To-Many relationship.
business_unit_workflow
See businessunit Entity business_unit_workflow One-To-Many relationship.
system_user_workflow
See systemuser Entity system_user_workflow One-To-Many relationship.
team_workflow
See team Entity team_workflow One-To-Many relationship.
workflow_createdby
See systemuser Entity workflow_createdby One-To-Many relationship.
workflow_parent_workflow
See workflow Entity workflow_parent_workflow One-To-Many relationship.
workflow_modifiedonbehalfby
See systemuser Entity workflow_modifiedonbehalfby One-To-Many relationship.
Many-To-Many Relationships
Relationship details provided where the Workflow entity is the first entity in the relationship. Listed by SchemaName.
botcomponent_workflow
See botcomponent Entity botcomponent_workflow Many-To-Many Relationship.
See also
About entity reference
Web API reference
workflow EntityType
Note
Can you tell us about your documentation language preferences? Take a short survey.
The survey will take about seven minutes. No personal data is collected (privacy statement).