Versions Compared

Key

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

...

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

...

Required?false
Position?named
Default valueFalse
Accept pipeline input?false
Accept wildcard characters?false

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

Required?false
Position?5
Default value
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

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.

Required?false
Position?6
Default value
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

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.

Required?false
Position?7
Default value(Get-Timezone -Id 'UTC')
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

...

-RegularExpression <String>
Specifies that a regular expession is applied to the order IDs to filter results.

Required?false
Position?58
Default value
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

...