workflow EntityType

  • Reference
Namespace:
Microsoft.Dynamics.CRM

Set of logical rules that define the steps necessary to automate a specific business process, task, or set of actions to be performed.

Entity Set Path
[organization URI]/api/data/v9.0/workflows
Base Type
crmbaseentity
Display Name
Process
Primary Key
workflowid
Primary Key Attribute
name
Operations Supported
POST GET PATCH DELETE

Properties

Properties represent fields of data stored in the entity.Some properties are read-only.

Name Type Details
asyncautodelete Edm.Boolean

Indicates whether the asynchronous system job is automatically deleted on completion.

Display Name: Delete Job On Completion

Default Options
Value Label
1 Yes
0 No
businessprocesstype Edm.Int32

Business Process Type.

Display Name: Business Process Type

Default Options
Value Label
0 Business Flow
1 Task Flow
category Edm.Int32

Category of the process.

Display Name: Category

Default Options
Value Label
0 Workflow
1 Dialog
2 Business Rule
3 Action
4 Business Process Flow
5 Modern Flow
6 Desktop Flow
clientdata Edm.String

Business logic converted into client data

Display Name: Client Data
componentstate Edm.Int32

For internal use only.

Display Name: Component State

Read Only
Default Options
Value Label
0 Published
1 Unpublished
2 Deleted
3 Deleted Unpublished
createdon Edm.DateTimeOffset

Date and time when the process was created.

Display Name: Created On

Read Only
createstage Edm.Int32

Stage of the process when triggered on Create.

Display Name: Create Stage

Default Options
Value Label
20 Pre-operation
40 Post-operation
deletestage Edm.Int32

Stage of the process when triggered on Delete.

Display Name: Delete stage

Default Options
Value Label
20 Pre-operation
40 Post-operation
description Edm.String

Description of the process.

Display Name: Description
entityimage Edm.Binary

Shows the default image for the record.

Display Name: Default Image
entityimage_timestamp Edm.Int64
Read Only
entityimage_url Edm.String
Read Only
entityimageid Edm.Guid

For internal use only.

Display Name: Entity Image Id

Read Only
formid Edm.Guid

Unique identifier of the associated form.

Display Name: Form ID
inputparameters Edm.String

Input parameters to the process.

Display Name: Input Parameters
introducedversion Edm.String

Version in which the form is introduced.

Display Name: Introduced Version
iscrmuiworkflow Edm.Boolean

Indicates whether the process was created using the Microsoft Dynamics 365 Web application.

Display Name: Is CRM Process

Read Only
Default Options
Value Label
1 Yes
0 No
iscustomizable BooleanManagedProperty

Information that specifies whether this component can be customized.

Display Name: Customizable
iscustomprocessingstepallowedforotherpublishers BooleanManagedProperty

Defines whether other publishers can attach custom processing steps to this action

Display Name: Allow custom processing step for other publishers
ismanaged Edm.Boolean

Indicates whether the solution component is part of a managed solution.

Display Name: Is Managed

Read Only
Default Options
Value Label
1 Managed
0 Unmanaged
istransacted Edm.Boolean

Whether or not the steps in the process are executed in a single transaction.

Display Name: Is Transacted

Default Options
Value Label
1 Yes
0 No
languagecode Edm.Int32

Language of the process.

Display Name: Language
mode Edm.Int32

Shows the mode of the process.

Display Name: Mode

Default Options
Value Label
0 Background
1 Real-time
modifiedon Edm.DateTimeOffset

Date and time when the process was last modified.

Display Name: Modified On

Read Only
name Edm.String

Name of the process.

Display Name: Process Name
ondemand Edm.Boolean

Indicates whether the process is able to run as an on-demand process.

Display Name: Run as On Demand

Default Options
Value Label
1 Yes
0 No
overwritetime Edm.DateTimeOffset

For internal use only.

Display Name: Record Overwrite Time

Read Only
primaryentity Edm.String

Primary entity for the process. The process can be associated for one or more SDK operations defined on the primary entity.

Display Name: Primary Entity
processorder Edm.Int32

Type the business process flow order.

Display Name: Process Order
processroleassignment Edm.String

Contains the role assignment for the process.

Display Name: Role assignment for Process
processtriggerformid Edm.Guid

Unique identifier of the associated form for process trigger.

Display Name: ProcessTriggerFormId
processtriggerscope Edm.Int32

Scope of the process trigger.

Display Name: ProcessTriggerScope

Default Options
Value Label
1 Form
2 Entity
rank Edm.Int32

Indicates the rank for order of execution for the synchronous workflow.

Display Name: Rank
rendererobjecttypecode Edm.String

The renderer type of Workflow

Display Name: Renderer Type
runas Edm.Int32

Specifies the system user account under which a workflow executes.

Display Name: Run As User

Default Options
Value Label
0 Owner
1 Calling User
scope Edm.Int32

Scope of the process.

Display Name: Scope

Default Options
Value Label
1 User
2 Business Unit
3 Parent: Child Business Units
4 Organization
solutionid Edm.Guid

Unique identifier of the associated solution.

Display Name: Solution

Read Only
statecode Edm.Int32

Status of the workflow

Display Name: Status

Default Options
Value Label
0 Draft
1 Activated
2 Suspended
statuscode Edm.Int32

Reason for the status of the workflow

Display Name: Status Reason

Default Options
Value Label
1 Draft
2 Activated
3 CompanyDLPViolation
subprocess Edm.Boolean

Indicates whether the process can be included in other processes as a child process.

Display Name: Is Child Process

Default Options
Value Label
1 Yes
0 No
syncworkflowlogonfailure Edm.Boolean

Select whether synchronous workflow failures will be saved to log files.

Display Name: Log upon Failure

Default Options
Value Label
1 Yes
0 No
triggeroncreate Edm.Boolean

Indicates whether the process will be triggered when the primary entity is created.

Display Name: Trigger On Create

Default Options
Value Label
1 Yes
0 No
triggerondelete Edm.Boolean

Indicates whether the process will be triggered on deletion of the primary entity.

Display Name: Trigger On Delete

Default Options
Value Label
1 Yes
0 No
triggeronupdateattributelist Edm.String

Attributes that trigger the process when updated.

Display Name: Trigger On Update Attribute List
trustedaccess Edm.Boolean

For Internal Use Only.

Display Name: Trusted Access

Read Only
Default Options
Value Label
1 Workflow has gone through access check
0 Workflow has not gone through access check
type Edm.Int32

Type of the process.

Display Name: Type

Default Options
Value Label
1 Definition
2 Activation
3 Template
uidata Edm.String

For internal use only.

Display Name: UI Data

Read Only
uiflowtype Edm.Int32

Type of the UI Flow process.

Display Name: Desktop Flow Type

Default Options
Value Label
0 Windows recorder (V1)
1 Selenium IDE
2 Power Automate Desktop
101 Recording
uniquename Edm.String

Unique name of the process

Display Name: Unique Name
updatestage Edm.Int32

Select the stage a process will be triggered on update.

Display Name: Update Stage

Default Options
Value Label
20 Pre-operation
40 Post-operation
versionnumber Edm.Int64
Read Only
workflowid Edm.Guid

Unique identifier of the process.

Display Name: Process
workflowidunique Edm.Guid

For internal use only.

Read Only
xaml Edm.String

XAML that defines the process.

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 Retrieve data about lookup properties.

Name Single-valued navigation property Description
_activeworkflowid_value activeworkflowid

Unique identifier of the latest activation record for the process.
_createdby_value createdby

Unique identifier of the user who created the process.
_createdonbehalfby_value createdonbehalfby

Unique identifier of the delegate user who created the process.
_modifiedby_value modifiedby

Unique identifier of the user who last modified the process.
_modifiedonbehalfby_value modifiedonbehalfby

Unique identifier of the delegate user who last modified the process.
_ownerid_value ownerid

Unique identifier of the user or team who owns the process.
_owningbusinessunit_value owningbusinessunit

Unique identifier of the business unit that owns the process.
_owningteam_value owningteam

Unique identifier of the team who owns the process.
_owninguser_value owninguser

Unique identifier of the user who owns the process.
_parentworkflowid_value parentworkflowid

Unique identifier of the definition for process activation.
_plugintypeid_value activeworkflowid

Unique identifier of the plug-in type.
_sdkmessageid_value activeworkflowid

Unique identifier of the SDK Message associated with this workflow.

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
activeworkflowid workflow workflow_active_workflow
createdby systemuser workflow_createdby
createdonbehalfby systemuser workflow_createdonbehalfby
modifiedby systemuser workflow_modifiedby
modifiedonbehalfby systemuser workflow_modifiedonbehalfby
ownerid principal owner_workflows
owningbusinessunit businessunit business_unit_workflow
owningteam team team_workflow
owninguser systemuser system_user_workflow
parentworkflowid workflow workflow_parent_workflow

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
botcomponent_workflow botcomponent botcomponent_workflow
CatalogAssignments catalogassignment WorkflowId
lk_asyncoperation_workflowactivationid asyncoperation workflowactivationid
lk_processsession_processid processsession processid
msdyn_retrainworkflow_msdyn_toaimodel msdyn_aimodel msdyn_retrainworkflowid
msdyn_scheduleinferenceworkflow_msdyn_toaimodel msdyn_aimodel msdyn_scheduleinferenceworkflowid
msdyn_workflow_msdyn_pmrecording msdyn_pmrecording msdyn_sourceworkflow
msdyn_workflow_msdyn_solutionhealthrule_resolutionaction msdyn_solutionhealthrule msdyn_resolutionaction
msdyn_workflow_msdyn_solutionhealthrule_Workflow msdyn_solutionhealthrule msdyn_Workflow
msdyn_workflow_slaitem_customtimecalculationworkflowid slaitem msdyn_customtimecalculationworkflowid
process_processstage processstage processid
process_processtrigger processtrigger processid
regardingobjectid_process flowsession regardingobjectid_process
slabase_workflowid sla workflowid
slaitembase_workflowid slaitem workflowid
workflow_active_workflow workflow activeworkflowid
Workflow_Annotation annotation objectid_workflow
workflow_expiredprocess expiredprocess processid
workflow_newprocess newprocess processid
workflow_parent_workflow workflow parentworkflowid
Workflow_SyncErrors syncerror regardingobjectid_workflow_syncerror
workflow_translationprocess translationprocess processid
workflow_workflowbinary_Process workflowbinary Process

Operations

The following operations can be used with the workflow entity type.

Name Binding
CreateWorkflowFromTemplate Entity
ExecuteWorkflow Entity
GrantAccess Not Bound
install Entity
ModifyAccess Not Bound
RetrievePrincipalAccess Not Bound
RetrieveSharedPrincipalsAndAccess Not Bound
RevokeAccess Not Bound
RunDesktopFlow Entity

Solutions

The following solutions include the workflow entity type.

Name Description
System Solution Internal CRM System Solution
Second Patch for Application Common For internal use only.
Application Common For internal use only.
Application Common Patch For internal use only.
Power Automate Extensions Workflow Customization package
MessageProcessorExtension MessageProcessorExtension Solution
Process Mining

See also