PowerShell CLI 2.0 - Cmdlets - Get-JS7Order

Name

Get-JS7Order

SYNOPSIS

Returns orders from the JS7 Controller

SYNTAX

Get-JS7Order [[-OrderId] <String>] [[-WorkflowPath] <String>] [[-WorkflowVersionId] <String>] [[-Folder] <String>] [-Recursive] [[-DateTo] <DateTime>] [[-RelativeDateTo] <String>] [[-Timezone] <TimeZoneInfo>] [[-StateDateFrom] <DateTime>] [[-RelativeStateDateFrom] <String>] [[-StateDateTo] <DateTime>] [[-RelativeStateDateTo] <String>] [[-RegularExpression] <String>] [-Compact] [-Pending] [-Scheduled] [-InProgress] [-Running] [-Suspended] [-Completed] [-Prompting] [-Waiting] [-Failed] [-Blocked] [-IgnoreFailed] [<CommonParameters>]

DESCRIPTION

Orders are selected from the JS7 Controller

* by the workflow that is assigned the order,
* by the folder of the worklow including sub-folders,
* by an individual Order ID.

Resulting orders can be forwarded to other cmdlets for pipelined bulk operations.

The following REST Web Service API resources are used:

* /order
* /orders

PARAMETERS

OrderId

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

WorkflowPath

-WorkflowPath <String>
Optionally specifies the path and name of a workflow for which orders should be returned.

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

WorkflowVersionId

-WorkflowVersionId <String>
Deployed workflows are assigned a version identifier. The argument allows to select the
workflow that is available with the specified version.

Folder

-Folder <String>
Optionally specifies the folder with workflows for which orders should be returned.

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

Recursive

-Recursive <SwitchParameter>
Specifies that all sub-folders should be looked up if the -Folder parameter is used.
By default no sub-folders will be searched for orders.

DateTo

-DateTo <DateTime>
Specifies the date and time until which orders should be returned.
Dates can be specified from any time zone, for example:

* 2025-02-25: begin of day for the indicated date
* 2025-02-25 17:18:19: specified time for the indicated date
* 2025-02-25 23:01:02+01:00: specified time and timezone for the indicated date
* (Get-Date).AddDays(1): current time one day ahead

Default should no Order ID be provided: End of current day in the given timezone

Only one of the -DateTo and -RelativeDateTo arguments can be used.

RelativeDateTo

-RelativeDateTo <String>
Specifies a relative date until which orders should be returned, e.g.

* 1s, 2s: one second later, two seconds later
* 1m, 2m: one minute later, two minutes later
* 1h, 2h: one hour later, two hours later
* 1d, 2d: one day later, two days later
* 1w, 2w: one week later, two weeks later
* 1M, 2M: one month later, two months later
* 1y, 2y: one year later, two years later

Optionally a time offset can be specified, e.g. 1d+02:00, as otherwise midnight UTC is assumed.
Alternatively a timezone offset can be added, e.g. by using 1d+TZ, that is calculated by the cmdlet
for the timezone that is specified with the -Timezone argument.

Only one of the -DateTo and -RelativeDateTo arguments can be used.

Timezone

-Timezone <TimeZoneInfo>
Specifies the timezone to which a relative date indicated with the -RelativeDateTo argument should be converted.
A timezone can e.g. be specified like this:

* Relative date specified for the UTC timezone (default)
** Get-JS7Order -RelativeDateTo +1d+TZ
* Relative date specified for the current timezone
** Get-JS7Order -RelativeDateTo +1d+TZ -Timezone (Get-Timezone)
* Relative date specified for a different timezone
** Get-JS7Order -RelativeDateTo +1h+TZ -Timezone (Get-Timezone -Id 'IST')

Default: Relative dates are converted to UTC.

StateDateFrom

-StateDateFrom <DateTime>
Optionally iimits results to orders that changed to the current status after the indicated date.

For specification of dates see -DateTo argument.

RelativeStateDateFrom

-RelativeStateDateFrom <String>
Optionally iimits results to orders that changed to the current status after the indicated relative date.

For specification of relative dates see -RelativeDateTo argument.

StateDateTo

-StateDateTo <DateTime>
Optionally iimits results to orders that changed to the current status before the indicated date.

For specification of dates see -DateTo argument.

RelativeStateDateTo

-RelativeStateDateTo <String>
Optionally iimits results to orders that changed to the current status before the indicated relative date.

For specification of relative dates see -RelativeDateTo argument.

RegularExpression

-RegularExpression <String>
Specifies that a regular expession is applied to Order IDs to filter results.
The Order ID includes the Order Name attribute that is specified when adding the order like this for an Order Name "myIdentifier":

"#2020-11-19#P0000000498-myIdentifier"

A regular expression 'Identifier$' matches the above Order ID.

Compact

-Compact <SwitchParameter>
Specifies that fewer attributes of orders are returned.

Pending

-Pending <SwitchParameter>
Specifies that orders in a pending state should be returned. Such orders are not
assigned a start time.

Scheduled

-Scheduled <SwitchParameter>
Specifies that orders in a scheduled state should be returned. Such orders are scheduled
for a later start time.

InProgress

-InProgress <SwitchParameter>
Specifies that orders in progress should be returned, i.e. orders that started but that
are currently not executing jobs.

Running

-Running <SwitchParameter>
Specifies that orders in a running state should be returned, i.e. orders for which a job is
currently being executed in a workflow.

Suspended

-Suspended <SwitchParameter>
Specifies that orders in suspended state should be returned. An order can be suspended
e.g. when being affected by the Suspend-JS7Order cmdlet or by the respective manual operation from the GUI.

Completed

-Completed <SwitchParameter>

Prompting

-Prompting <SwitchParameter>
Specifies that orders in a prompting state should be returned. Such orders are put on hold by a
prompt instruction in a workflow and require confirmation before proceeding with execution of the workflow.
For details see the Confirm-JS7Order cmdlet.

Waiting

-Waiting <SwitchParameter>
Specifies that orders in a setback state should be returned. Such orders make use of an interval
specified by a retry operation in the workflow for which they are repeated in case that a job fails.

Failed

-Failed <SwitchParameter>
Specifies that orders in a failed state should be returned. Orders are considered to have failed
if a job in the workflow fails.

Blocked

-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.

IgnoreFailed

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

RELATED LINKS

about_JS7

EXAMPLES

-------------------------- EXAMPLE 1 --------------------------

PS > $orders = Get-JS7Order

Returns all orders available with a JS7 Controller.

-------------------------- EXAMPLE 2 --------------------------

PS > $orders = Get-JS7Order -Folder /some_path -Recursive

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

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

PS > $orders = Get-JS7Order -WorkflowPath /test/globals/workflow1

Returns the orders for workflow "workflow1" from the folder "/test/globals".

-------------------------- EXAMPLE 4 --------------------------

PS > $orders = Get-JS7Order -OrderId "#2020-11-19#P0000000498-orderSampleWorfklow2a"

Returns the order with the respective identifier.

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

PS > $orders = Get-JS7Order -RegularExpression 'sos$'

Returns orders with an Order ID that ends with the string "sos".

-------------------------- EXAMPLE 6 --------------------------

PS > $orders = Get-JS7Order -Suspended -Waiting

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