Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

RetrieveProcessInstancesRequest Class

Definition

Namespace:
Microsoft.Crm.Sdk.Messages
Assembly:
Microsoft.Crm.Sdk.Proxy.dll
Package:
Microsoft.PowerPlatform.Dataverse.Client v1.2.10

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 retrieve all the process instances for an entity record across all business process definitions. 

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

Remarks

For the Web API use the RetrieveProcessInstances function.

Constructors

Name Description
RetrieveProcessInstancesRequest()

Properties

Name Description
EntityId

Gets or sets the Id of the entity record for which you want to retrieve all the business process flow instances across all business process flow definitions.
EntityLogicalName

Gets or sets the logical name of the entity for which you want to retrieve all the business process flow instances across all business process flow definitions.
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)
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)

Applies to