ExecuteWorkflowRequest Class

Artikkel
11/28/2016

Applies To: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online

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) .

Namespace: Microsoft.Crm.Sdk.Messages
Assembly: Microsoft.Crm.Sdk.Proxy (in Microsoft.Crm.Sdk.Proxy.dll)

Inheritance Hierarchy

System.Object
Microsoft.Xrm.Sdk.OrganizationRequest
Microsoft.Crm.Sdk.Messages.ExecuteWorkflowRequest

Syntax

[DataContractAttribute(Namespace = "https://schemas.microsoft.com/crm/2011/Contracts")]
public sealed class ExecuteWorkflowRequest : OrganizationRequest

<DataContractAttribute(Namespace := "https://schemas.microsoft.com/crm/2011/Contracts")>
Public NotInheritable Class ExecuteWorkflowRequest
    Inherits OrganizationRequest

Constructors

	Name	Description
	ExecuteWorkflowRequest()	Initializes a new instance of the ExecuteWorkflowRequest class.

Properties

	Name	Description
	EntityId	Gets or sets the ID of the record on which the workflow executes. Required.
	ExtensionData	Gets or sets the structure that contains extra data. Optional.(Inherited from OrganizationRequest.)
	InputArguments	For internal use only.
	Item[String]	Gets or sets the indexer for the Parameters collection.(Inherited from OrganizationRequest.)
	Parameters	Gets or sets the collection of parameters for the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.)
	RequestId	Gets or sets the ID of an asynchronous operation (system job). Optional. (Inherited from OrganizationRequest.)
	RequestName	Gets or sets the name of the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.)
	WorkflowId	Gets or sets the ID of the workflow to execute. Required.

Methods

	Name	Description
	Equals(Object)	(Inherited from Object.)
	GetHashCode()	(Inherited from Object.)
	GetType()	(Inherited from Object.)
	ToString()	(Inherited from Object.)

Remarks

Message Availability

For this message to work, the caller must be connected to the server.

Usage

Pass an instance of this class to the Execute method, which returns an instance of ExecuteWorkflowResponse.

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.

Examples

The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get anIOrganizationService interface. For the complete sample, see the link later in this topic.


// Create an ExecuteWorkflow request.
ExecuteWorkflowRequest request = new ExecuteWorkflowRequest()
{
    WorkflowId = _workflowId,
    EntityId = _leadId
};
Console.Write("Created ExecuteWorkflow request, ");

// Execute the workflow.
ExecuteWorkflowResponse response =
    (ExecuteWorkflowResponse)_serviceProxy.Execute(request);
Console.WriteLine("and sent request to service.");


' Create an ExecuteWorkflow request.
Dim request As New ExecuteWorkflowRequest() With
    {
        .WorkflowId = _workflowId,
        .EntityId = _leadId
    }
Console.Write("Created ExecuteWorkflow request, ")

' Execute the workflow.
Dim response As ExecuteWorkflowResponse =
    CType(_serviceProxy.Execute(request), ExecuteWorkflowResponse)
Console.WriteLine("and sent request to service.")

Thread Safety

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Del via