Name
Get-JS7OrderAddPosition
SYNOPSIS
Returns workflow positions that can be used when adding an order to a workflow
SYNTAX
Get-JS7OrderAddPosition [-WorkflowPath] <String> [[-WorkflowVersionId] <String>] [[-ControllerId] <String>] [<CommonParameters>]
DESCRIPTION
When adding an order to a workflow then a number of positions in the workflow can be used
as the starting position or as end positions. The cmdlet returns allowed positions for a given workflow.
The following REST Web Service API resources are used:
* /orders/add/positions
PARAMETERS
WorkflowPath
-WorkflowPath <String>
Optionally specifies the path and name of a workflow for which positions will be returned.
Required? | true |
Position? | 1 |
Default value | |
Accept pipeline input? | true (ByPropertyName) |
Accept wildcard characters? | false |
WorkflowVersionId
-WorkflowVersionId <String>
Deployed workflows are assigned a version identifier. This parameter allows selection of
workflows that are assigned the specified version.
Required? | false |
Position? | 2 |
Default value | |
Accept pipeline input? | true (ByPropertyName) |
Accept wildcard characters? | false |
ControllerId
-ControllerId <String>
Optionally specifies the identification of the Controller from which workflow positions will be returned.
Required? | false |
Position? | 3 |
Default value | |
Accept pipeline input? | true (ByPropertyName) |
Accept wildcard characters? | false |
RELATED LINKS
EXAMPLES
-------------------------- EXAMPLE 1 --------------------------
PS > $positions = Get-JS7OrderAddPosition -WorkflowPath /ProductDemo/ParallelExecution/pdwFork
Returns the available positions of the given workflow that can be used as the start position and as end positions when adding orders.