GeneralExtensions.ExecuteWorkflowOnEntity Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Executes a named workflow on an object.
public static Guid ExecuteWorkflowOnEntity (this Microsoft.PowerPlatform.Dataverse.Client.ServiceClient serviceClient, string workflowName, Guid id, Guid batchId = default, bool bypassPluginExecution = false);
static member ExecuteWorkflowOnEntity : Microsoft.PowerPlatform.Dataverse.Client.ServiceClient * string * Guid * Guid * bool -> Guid
<Extension()>
Public Function ExecuteWorkflowOnEntity (serviceClient As ServiceClient, workflowName As String, id As Guid, Optional batchId As Guid = Nothing, Optional bypassPluginExecution As Boolean = false) As Guid
Parameters
- serviceClient
- ServiceClient
ServiceClient
- workflowName
- String
name of the workflow to run
- id
- Guid
ID to exec against
- batchId
- Guid
Optional: if set to a valid GUID, generated by the Create Batch Request Method, will assigned the request to the batch for later execution, on fail, runs the request immediately
- bypassPluginExecution
- Boolean
Adds the bypass plugin behavior to this request. Note: this will only apply if the caller has the prvBypassPlugins permission to bypass plugins. If its attempted without the permission the request will fault.
Returns
Async Op ID of the WF or Guid.Empty