ExecuteWorkflowRequest Class

Reference

Definition

Namespace:: Microsoft.Crm.Sdk.Messages

Assembly:: Microsoft.Crm.Sdk.Proxy.dll

Package:: Microsoft.PowerPlatform.Dataverse.Client v1.1.32

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.

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

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

Inheritance: Object

OrganizationRequest
ExecuteWorkflowRequest

Attributes: DataContractAttribute

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 instance. For the complete sample, see the link later in this topic.

Remarks

For the Web API use the ExecuteWorkflow action.

Usage

Pass an instance of this class to the Execute(OrganizationRequest) 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.

Constructors

ExecuteWorkflowRequest()

Initializes a new instance of the ExecuteWorkflowRequest class.

Properties

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 the request. 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.

Applies to

Share via