RetrieveActivePath Function
Retrieves a collection of stages currently in the active path for a business process flow instance.
Parameters
Parameters allow for data to be passed to the function.
| Name | Type | Nullable | Unicode | Description |
|---|---|---|---|---|
|
ProcessInstanceId
|
Edm.Guid | False | True | ID of the business process flow instance record to retrieve a collection of stages currently in the active path. |
Return type
| Type | Nullable | Description |
|---|---|---|
| Collection(processstage) | False | The RetrieveActivePath function returns the following value. |
Entities
Use the RetrieveActivePath function with these entity types:
| Name | Display name | Description |
|---|---|---|
| processstage | Process Stage | Stage associated with a process. |