Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Returns orders from the JS7 Controller.

SYNTAX

Get-JS7Order [[-OrderId] <String>] [[-WorkflowPath] <String>] [[-WorkflowVersionId] <String>] [[-Folder] <String>] [-Recursive] [[-RegularExpression] <String>] [-Compact] [-Pending] [-Running] [-Suspended] [-Waiting] [-Failed] [-Blocked] [-IgnoreFailed] [<CommonParameters>]

DESCRIPTION

...

-OrderId <String>
Optionally specifies the unique identifier of an order that should be returned.

Required?false
Position?1
Default value
Accept pipeline input?true (ByValue, ByPropertyName)
Accept wildcard characters?false

...

-WorkflowPath <String>
Optionally specifies the path and name of a workflow for which orders should be returned.
If the name of a workflow is specified then the -Folder parameter is used to determine the folder.
Otherwise the -WorkflowPath parameter is assumed to include the full path and name of the workflow.

One of the parameters -Folder, -WorkflowPath or -OrderId has to be specified if no pipelined order objects are provided.

...

-Blocked <SwitchParameter>
Specifies that orders should be returned that are blocked by a resource, e.g. if a job's task limit
is exceeded and the order has to wait for the next available task.

Required?false
Position?named
Default valueFalse
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

IgnoreFailed

-IgnoreFailed <SwitchParameter>
Specifies that errors relating to orders not being found are ignored.
An empty response will be returned.

Required?false
Position?named
Default valueFalse
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

...

Returns all orders that are configured for workflows with the folder "/some_path" inclluding including any sub-folders.

-------------------------- EXAMPLE 3 --------------------------

...

Returns the order with the respective identifier.

-------------------------- EXAMPLE 5 --------------------------

...

Returns any orders that have been suspended, e.g. after job failures, or that are set back waiting to retry execution of a job after failure.