workflow EntityType
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.2/workflows
- Base type:
- crmbaseentity
- Table type:
- Standard
- Display name:
- Process
- Primary key:
- workflowid
- Primary name column:
- 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
|
||||||||||||||||||
| billingcontext | Edm.String |
Billing context this flow is in. Display name: BillingContext |
||||||||||||||||||
| businessprocesstype | Edm.Int32 |
Business Process Type. Display name: Business Process Type
Default options
|
||||||||||||||||||
| category | Edm.Int32 |
Category of the process. Display name: Category
Default options
|
||||||||||||||||||
| clientdata | Edm.String |
Business logic converted into client data Display name: Client Data |
||||||||||||||||||
| clientdataiscompressed | Edm.Boolean |
For Internal Use Only. Display name: Client Data Is Compressed Read only
Default options
|
||||||||||||||||||
| componentstate | Edm.Int32 |
For internal use only. Display name: Component State Read only
Default options
|
||||||||||||||||||
| connectionreferences | Edm.String |
Connection References related to this workflow. Display name: Connection references |
||||||||||||||||||
| createdon | Edm.DateTimeOffset |
Date and time when the process was created. Display name: Created On Read only
|
||||||||||||||||||
| createmetadata | Edm.String |
Create metadata for this workflow. Display name: Create metadata |
||||||||||||||||||
| createstage | Edm.Int32 |
Stage of the process when triggered on Create. Display name: Create Stage
Default options
|
||||||||||||||||||
| definition | Edm.String |
Definition of the business logic of this workflow instance. Display name: Definition |
||||||||||||||||||
| deletestage | Edm.Int32 |
Stage of the process when triggered on Delete. Display name: Delete stage
Default options
|
||||||||||||||||||
| dependencies | Edm.String |
Soft dependencies of this workflow instance. Display name: Dependencies |
||||||||||||||||||
| description | Edm.String |
Description of the process. Display name: Description |
||||||||||||||||||
| desktopflowmodules | Edm.String |
Desktop flow modules related to this workflow. Display name: Desktop flow modules |
||||||||||||||||||
| dynamicssolutioncontext | Edm.String |
comma separated list of one or more Dynamics First Party Solution Unique names that this workflow is in context of. Display name: DynamicsSolutionContext |
||||||||||||||||||
| 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 |
||||||||||||||||||
| inputs | Edm.String |
Inputs definition for this workflow. Display name: Inputs |
||||||||||||||||||
| 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
|
||||||||||||||||||
| 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
|
||||||||||||||||||
| istransacted | Edm.Boolean |
Whether or not the steps in the process are executed in a single transaction. Display name: Is Transacted
Default options
|
||||||||||||||||||
| languagecode | Edm.Int32 |
Language of the process. Display name: Language |
||||||||||||||||||
| metadata | Edm.String |
Additional metadata for this workflow. Display name: Metadata |
||||||||||||||||||
| mode | Edm.Int32 |
Shows the mode of the process. Display name: Mode
Default options
|
||||||||||||||||||
| modifiedon | Edm.DateTimeOffset |
Date and time when the process was last modified. Display name: Modified On Read only
|
||||||||||||||||||
| modifymetadata | Edm.String |
Flow modify metadata used for telemetry, etc. Display name: ModifyMetadata |
||||||||||||||||||
| 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
|
||||||||||||||||||
| outputs | Edm.String |
Outputs definition for this workflow. Display name: Outputs |
||||||||||||||||||
| overwritetime | Edm.DateTimeOffset |
For internal use only. Display name: Record Overwrite Time Read only
|
||||||||||||||||||
| planverified | Edm.Boolean |
For Internal Use Only. Display name: Plan Verified
Default options
|
||||||||||||||||||
| 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
|
||||||||||||||||||
| 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 |
||||||||||||||||||
| resourcecontainer | Edm.String |
For internal use only. Display name: ResourceContainer |
||||||||||||||||||
| resourceid | Edm.Guid |
For internal use only. Display name: ResourceId |
||||||||||||||||||
| runas | Edm.Int32 |
Specifies the system user account under which a workflow executes. Display name: Run As User
Default options
|
||||||||||||||||||
| schemaversion | Edm.String |
Schema version for this workflow. Display name: Schema Version |
||||||||||||||||||
| scope | Edm.Int32 |
Scope of the process. Display name: Scope
Default options
|
||||||||||||||||||
| 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
|
||||||||||||||||||
| statuscode | Edm.Int32 |
Reason for the status of the workflow Display name: Status Reason
Default options
|
||||||||||||||||||
| subprocess | Edm.Boolean |
Indicates whether the process can be included in other processes as a child process. Display name: Is Child Process
Default options
|
||||||||||||||||||
| suspensionreasondetails | Edm.String | |||||||||||||||||||
| syncworkflowlogonfailure | Edm.Boolean |
Select whether synchronous workflow failures will be saved to log files. Display name: Log upon Failure
Default options
|
||||||||||||||||||
| throttlingbehavior | Edm.Int32 |
The throttling behavior type. Display name: Throttling behavior type
Default options
|
||||||||||||||||||
| triggeroncreate | Edm.Boolean |
Indicates whether the process will be triggered when the primary entity is created. Display name: Trigger On Create
Default options
|
||||||||||||||||||
| triggerondelete | Edm.Boolean |
Indicates whether the process will be triggered on deletion of the primary entity. Display name: Trigger On Delete
Default options
|
||||||||||||||||||
| 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
|
||||||||||||||||||
| type | Edm.Int32 |
Type of the process. Display name: Type
Default options
|
||||||||||||||||||
| uidata | Edm.String |
For internal use only. Display name: UI Data Read only
|
||||||||||||||||||
| uiflowtype | Edm.Int32 |
Type of the UI Flow process. Display name: UI Flow Type
Default options
|
||||||||||||||||||
| 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
|
||||||||||||||||||
| 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 Lookup property data.
| 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. |
| _licenseentitledby_value | licenseentitledby_workflowid |
The source of the license entitlements. |
| _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. |
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 |
| licenseentitledby_workflowid | workflow | Workflow_licenseentitledby |
| 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 |
|---|---|---|
| adx_invitation_redemptionworkflow | adx_invitation | adx_redemptionWorkflow |
| AIPluginOperation_Workflow_Workflow | aipluginoperation | Workflow |
| botcomponent_workflow | botcomponent | botcomponent_workflow |
| CatalogAssignments | catalogassignment | WorkflowId |
| componentversionnrddatasourceset | componentversionnrddatasource | component_workflow |
| componentversions | componentversion | component_workflow |
| flowcapacityassignment_workflow | flowcapacityassignment | regarding_workflow |
| flowevent_workflow | flowevent | parentobjectid_workflow |
| 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_card_connections | card | workflow_card_connections |
| workflow_desktopflowbinary_Process | desktopflowbinary | Process |
| workflow_expiredprocess | expiredprocess | processid |
| workflow_flowlog_cloudflowid | flowlog | cloudflowid |
| workflow_flowlog_desktopflowid | flowlog | desktopflowid |
| workflow_flowrun_Workflow | flowrun | Workflow |
| Workflow_licenseentitledby | workflow | licenseentitledby_workflowid |
| 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 |
|---|---|
| AddRequiredDesktopFlowComponentsToSolutions | Bound to Entity |
| CancelAllCloudFlowRuns | Bound to Entity |
| CreateWorkflowFromTemplate | Bound to Entity |
| ExecuteWorkflow | Bound to Entity |
| GrantAccess | Not Bound |
| InitializeModernFlowFromAsyncWorkflow | Bound to Entity |
| install | Bound to Entity |
| ListConnectionReferences | Bound to Entity |
| ModifyAccess | Not Bound |
| RetrievePrincipalAccess | Not Bound |
| RetrieveSharedPrincipalsAndAccess | Not Bound |
| RetrieveUnpublished | Bound to Entity |
| RetrieveUnpublishedMultiple | Bound to Collection |
| RevokeAccess | Not Bound |
| RunDesktopFlow | Bound to Entity |
| SaveAsDesktopFlow | Bound to Entity |