SetProcessRequest SetProcessRequest SetProcessRequest SetProcessRequest Class

Definition

Contains the data that is needed to set another business process flow instance as the active process instance for the target entity. If there isn't any active business process flow instance for the target entity record and the specified business process flow definition, a new business process flow instance will be created and set as the active instance.

For the Web API use the SetProcess Action.

public ref class SetProcessRequest sealed : Microsoft::Xrm::Sdk::OrganizationRequest
[System.Runtime.Serialization.DataContract(Namespace="http://schemas.microsoft.com/crm/2011/Contracts")]
public sealed class SetProcessRequest : Microsoft.Xrm.Sdk.OrganizationRequest
type SetProcessRequest = class
    inherit OrganizationRequest
Public NotInheritable Class SetProcessRequest
Inherits OrganizationRequest
Inheritance
SetProcessRequestSetProcessRequestSetProcessRequestSetProcessRequest
Attributes

Remarks

An active business process flow instance is the one that is visible on the UI for the entity record.

Constructors

SetProcessRequest() SetProcessRequest() SetProcessRequest() SetProcessRequest()

Initializes a new instance of the SetProcessRequest class.

Properties

ExtensionData ExtensionData ExtensionData ExtensionData

Gets or sets the structure that contains extra data. Optional.

(Inherited from OrganizationRequest)
Item[String] Item[String] Item[String] Item[String]

Gets or sets the indexer for the Parameters collection.

(Inherited from OrganizationRequest)
NewProcess NewProcess NewProcess NewProcess

Gets or sets the business process flow definition to be set to the target entity.

NewProcessInstance NewProcessInstance NewProcessInstance NewProcessInstance

Gets or sets the business process flow instance to be set as the active business process flow instance for the target entity. Optional.

Parameters Parameters Parameters Parameters

Gets or sets the collection of parameters for the request. Required, but is supplied by derived classes.

(Inherited from OrganizationRequest)
RequestId RequestId RequestId RequestId

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

(Inherited from OrganizationRequest)
RequestName RequestName RequestName RequestName

Gets or sets the name of the request. Required, but is supplied by derived classes.

(Inherited from OrganizationRequest)
Target Target Target Target

Gets or sets the target entity.

Applies to