Page History

...

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

...

Orders are selected from the JS7 Controller

* by the folder of the order location including sub-folders,
* by the workflow that is assigned to an order,
* by an individual order 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.

...

-WorkflowVersionId <String>
Deployed workflows can be assigned a version identifier. This parameters parameter allows to select selection of
workflows that are assigned the specified version.

...

-Recursive <SwitchParameter>
Specifies that any 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 until which orders should be returned.
Consider that a UTC date has to be provided.

Default should no Order ID be provided: End of the current day as a UTC date

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

Timezone

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

Get-JS7Order -Timezone (Get-Timezone -Id 'GMT Standard Time')

All dates in JS7 are UTC and can be converted e.g. to the local time zone like this:

Get-JS7Order -Timezone (Get-Timezone)

Default: Dates are converted to UTC.

...

-RegularExpression <String>
Specifies that a regular expession is applied to the order 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.

...

-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 <SwitchParameter>
Specifies that orders in a running state should be returned, i.e. orders for which a job hasis
been currently being executed in a workflow.

...

-Suspended <SwitchParameter>
Specifies that orders in suspended state should be returned. An order can be suspended
e.g. when being affected by the Suspend-JobSchedulerOrder 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.

...

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

...

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

...