SetProcessRequest Class

Reference

Definition

Namespace:: Microsoft.Crm.Sdk.Messages

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

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

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 is needed to set another business process flow instance as the active process instance for the target entity.

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

[<System.Runtime.Serialization.DataContract(Namespace="http://schemas.microsoft.com/crm/2011/Contracts")>]
type SetProcessRequest = class
    inherit OrganizationRequest

Public NotInheritable Class SetProcessRequest
Inherits OrganizationRequest

Inheritance: Object

OrganizationRequest
SetProcessRequest

Attributes: DataContractAttribute

Remarks

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.

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

Constructors

SetProcessRequest()

Initializes a new instance of the SetProcessRequest class.

Properties

ExtensionData	Gets or sets the structure that contains extra data. Optional. (Inherited from OrganizationRequest)
Item[String]	Gets or sets the indexer for the `Parameters` collection. (Inherited from OrganizationRequest)
NewProcess	Gets or sets the business process flow definition to be set to the target entity.
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	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)
Target	Gets or sets the target entity.

Applies to