RetrieveActivePath Function

Applies To: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online

Retrieves a collection of stages currently in the active path for a business process flow instance.

This Web API function corresponds to the organization service RetrieveActivePathRequest.

RetrieveActivePath function is not bound to any entity types.

Parameters

Parameters allow for data to be passed to the function.

Name	Type	Nullable	Unicode	Description
ProcessInstanceId	Edm.Guid	false		ID of the business process flow instance record to retrieve a collection of stages currently in the active path.

The RetrieveActivePath function returns the following value.

Type	Nullable	Description
Collection(processstage EntityType)	false	Contains the response from the RetrieveActivePath Function.