Get-RayFlowPhase

<< Click to Display Table of Contents >>

RayFlow PowerShell API > 7.3 > Implementation Guide > Cmdlet Reference 

Get-RayFlowPhase

Description

Gets the list of RayFlow phases.

 

Parameters

Name

Type

Mandatory

Description

Project

PsRayFlowProject[]

Yes

The project(s) that will be scanned for available phases.

PhaseId

Guid

No

The unique identifier of the required phase. May not be combined with PhaseName.

PhaseName

String

No

The name of the required phase. May not be combined with PhaseId. Both short name (POA) and long (Package Order Acceptance) can be used for the value.

Recursive

Switch

No

If not set, only root phases will be considered. Provide this switch to also scan for sub-phases.

 

Remarks

If neither PhaseName nor PhaseId is specified, then all phases are returned.

 

Returns

Type

Description

PsRayFlowPhase[]

The phase(s) matching the criteria.