ExecuteWorkflowRequest Class
TOC
Collapse the table of content
Expand the table of content

ExecuteWorkflowRequest Class

 

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)

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

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

NameDescription
System_CAPS_pubmethodExecuteWorkflowRequest()

Initializes a new instance of the ExecuteWorkflowRequest class.

NameDescription
System_CAPS_pubpropertyEntityId

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

System_CAPS_pubpropertyExtensionData

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

System_CAPS_pubpropertyInputArguments

For internal use only.

System_CAPS_pubpropertyItem[String]

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

System_CAPS_pubpropertyParameters

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

System_CAPS_pubpropertyRequestId

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

System_CAPS_pubpropertyRequestName

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

System_CAPS_pubpropertyWorkflowId

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

NameDescription
System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodToString()

(Inherited from Object.)

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.

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

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

Return to top

Microsoft Dynamics CRM 2016 and CRM Online

© 2016 Microsoft. All rights reserved. Copyright

Community Additions

ADD
Show:
© 2016 Microsoft