ExecuteWorkflowRequest Class

 

Applies To: Dynamics CRM 2015

Contains the data that’s needed to execute a workflow.

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 = "http://schemas.microsoft.com/crm/2011/Contracts")]
public sealed class ExecuteWorkflowRequest : OrganizationRequest
[DataContractAttribute(Namespace = "http://schemas.microsoft.com/crm/2011/Contracts")]
public ref class ExecuteWorkflowRequest sealed : OrganizationRequest
[<Sealed>]
[<DataContractAttribute(Namespace = "http://schemas.microsoft.com/crm/2011/Contracts")>]
type ExecuteWorkflowRequest = 
    class
        inherit OrganizationRequest
    end
<DataContractAttribute(Namespace := "http://schemas.microsoft.com/crm/2011/Contracts")>
Public NotInheritable Class ExecuteWorkflowRequest
    Inherits OrganizationRequest

Constructors

Name Description
System_CAPS_pubmethod ExecuteWorkflowRequest()

Initializes a new instance of the ExecuteWorkflowRequest class.

Properties

Name Description
System_CAPS_pubproperty EntityId

Gets or sets the ID of the record on which the workflow executes. Required.

System_CAPS_pubproperty ExtensionData

Gets or sets the structure that contains extra data. Optional.(Inherited from OrganizationRequest.)

System_CAPS_pubproperty InputArguments

For internal use only.

System_CAPS_pubproperty Item[String]

Gets or sets the indexer for the Parameters collection.(Inherited from OrganizationRequest.)

System_CAPS_pubproperty Parameters

Gets or sets the collection of parameters for the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.)

System_CAPS_pubproperty RequestId

Gets or sets the ID of an asynchronous operation (system job). Optional. (Inherited from OrganizationRequest.)

System_CAPS_pubproperty RequestName

Gets or sets the name of the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.)

System_CAPS_pubproperty WorkflowId

Gets or sets the ID of the workflow to execute. Required.

Methods

Name Description
System_CAPS_pubmethod Equals(Object)

(Inherited from Object.)

System_CAPS_pubmethod GetHashCode()

(Inherited from Object.)

System_CAPS_pubmethod GetType()

(Inherited from Object.)

System_CAPS_pubmethod 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 an IOrganizationService 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.

See Also

ExecuteWorkflowResponse
Microsoft.Crm.Sdk.Messages Namespace
Workflow categories
Sample: Run a workflow

Return to top

© 2016 Microsoft. All rights reserved. Copyright