RetrieveProcessInstances Function
Applies To: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online
Retrieves all the business process flow instances for an entity record across all business process flow definitions.
This Web API function corresponds to the organization service RetrieveProcessInstancesRequest.
RetrieveProcessInstances function is not bound to any entity types.
Parameters
Parameters allow for data to be passed to the function.
Name |
Type |
Nullable |
Unicode |
Description |
|---|---|---|---|---|
EntityId |
Edm.Guid |
false |
Id of the entity record for which you want to retrieve all the business process flow instances across all business process flow definitions. |
|
EntityLogicalName |
Edm.String |
false |
false |
Logical name of the entity for which you want to retrieve all the business process flow instances across all business process flow definitions. |
Return Type
The RetrieveProcessInstances function returns the following value.
Type |
Nullable |
Description |
|---|---|---|
Collection(crmbaseentity EntityType) |
false |
Contains the response from the RetrieveProcessInstances Function. |
See Also
Use Web API functions
Web API EntityType Reference
Web API Action Reference
Web API Query Function Reference
Web API EnumType Reference
Web API ComplexType Reference
Web API Metadata EntityType Reference
Microsoft Dynamics 365
© 2016 Microsoft. All rights reserved. Copyright