Workflow Request Class
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.
Contains the data that’s needed to execute a workflow.
For the Web API use the ExecuteWorkflow Action .
Web API support for this message was added with December 2016 update for Microsoft Dynamics 365 (online) and December 2016 Service Pack for Microsoft Dynamics 365 (on-premises) .
public ref class ExecuteWorkflowRequest sealed : Microsoft::Xrm::Sdk::OrganizationRequest
[System.Runtime.Serialization.DataContract(Namespace="http://schemas.microsoft.com/crm/2011/Contracts")] public sealed class ExecuteWorkflowRequest : Microsoft.Xrm.Sdk.OrganizationRequest
[<System.Runtime.Serialization.DataContract(Namespace="http://schemas.microsoft.com/crm/2011/Contracts")>] type ExecuteWorkflowRequest = class inherit OrganizationRequest
Public NotInheritable Class ExecuteWorkflowRequest Inherits OrganizationRequest
The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an IOrganizationService interface. For the complete sample, see the link later in this topic.
For this message to work, the caller must be connected to the server.
Privileges and Access Rights
To perform this action, the caller must have privileges on the
Workflow entity and access rights on the record specified in the EntityId and WorkflowId properties. For a complete list of the privileges required, see ExecuteWorkflow message privileges.
Initializes a new instance of the ExecuteWorkflowRequest class.
Gets or sets the ID of the record on which the workflow executes. Required.
Gets or sets the structure that contains extra data. Optional.(Inherited from OrganizationRequest)
For internal use only.
Gets or sets the indexer for the
Gets or sets the collection of parameters for the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest)
Gets or sets the ID of an asynchronous operation (system job). Optional.(Inherited from OrganizationRequest)
Gets or sets the name of the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest)
Gets or sets the ID of the workflow to execute. Required.