RetrieveProcessInstancesRequest RetrieveProcessInstancesRequest RetrieveProcessInstancesRequest RetrieveProcessInstancesRequest Class

Definition

Contains the data that is needed to retrieve all the process instances for an entity record across all business process definitions.

For the Web API use the RetrieveProcessInstances Function.

Web API support for this message was added with December 2016 update for Microsoft Dynamics 365 (online) and December 2016 Service Pack for Microsoft Dynamics 365 (on-premises) .

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
type RetrieveProcessInstancesRequest = class
    inherit OrganizationRequest
Public NotInheritable Class RetrieveProcessInstancesRequest
Inherits OrganizationRequest
Inheritance
RetrieveProcessInstancesRequestRetrieveProcessInstancesRequestRetrieveProcessInstancesRequestRetrieveProcessInstancesRequest
Attributes

Constructors

RetrieveProcessInstancesRequest() RetrieveProcessInstancesRequest() RetrieveProcessInstancesRequest() RetrieveProcessInstancesRequest()

Properties

EntityId EntityId EntityId 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 EntityLogicalName EntityLogicalName 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 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)
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)

Applies to