Date: Thu, 28 Mar 2024 17:02:31 +0000 (UTC) Message-ID: <705301322.11755.1711645351863@change.sos-berlin.com> Subject: Exported From Confluence MIME-Version: 1.0 Content-Type: multipart/related; boundary="----=_Part_11754_1093361909.1711645351862" ------=_Part_11754_1093361909.1711645351862 Content-Type: text/html; charset=UTF-8 Content-Transfer-Encoding: quoted-printable Content-Location: file:///C:/exported.html
Get-JS7DailyPlanOrder
Returns the daily plan orders scheduled for a number of JS7 Controllers<= /p>
Get-JS7DailyPlanOrder [[-OrderId] <String>] [[-WorkflowPath=
] <String>] [[-WorkflowFolder] <String>] [[-SchedulePath] <S=
tring>] [[-ScheduleFolder] <String>] [-Recursive] [[-ControllerId]=
<String>] [[-DateFrom] <DateTime>] [[-DateTo] <DateTime>=
] [[-RelativeDateFrom] <String>] [[-RelativeDateTo] <String>] [=
[-Timezone] <TimeZoneInfo>] [-Late] [-Planned] [-Submitted] [-Finishe=
d] [<CommonParameters>]
The daily plan orders for workflows of a number of JS7 Controllers are r=
eturned.
The following REST Web Service API resources are used:
* /daily_plan/orders
-OrderId <String>
Required? | false |
Position? | 1 |
Default value | |
Accept pipeline input? | true (ByPropertyName) |
Accept wildcard characters? | false |
-WorkflowPath <String>
Optionally specifies the path and name of a workflow for which daily plan =
orders should be returned.
Required? | false |
Position? | 2 |
Default value | |
Accept pipeline input? | true (ByPropertyName) |
Accept wildcard characters? | false |
-WorkflowFolder <String>
Required? | false |
Position? | 3 |
Default value | |
Accept pipeline input? | true (ByPropertyName) |
Accept wildcard characters? | false |
-SchedulePath <String>
Optionally specifies the path and name of a schedule for which daily plan =
orders should be returned.
Required? | false |
Position? | 4 |
Default value | |
Accept pipeline input? | true (ByPropertyName) |
Accept wildcard characters? | false |
-ScheduleFolder <String>
Required? | false |
Position? | 5 |
Default value | |
Accept pipeline input? | true (ByPropertyName) |
Accept wildcard characters? | false |
-Recursive <SwitchParameter>
When used with the -Folder parameter then any sub-folders of the specified=
folder will be looked up.
Required? | false |
Position? | named |
Default value | False |
Accept pipeline input? | true (ByPropertyName) |
Accept wildcard characters? | false |
-ControllerId <String>
Required? | false |
Position? | 6 |
Default value | |
Accept pipeline input? | true (ByPropertyName) |
Accept wildcard characters? | false |
-DateFrom <DateTime>
Optionally specifies the date starting from which daily plan orders should=
be returned.
Consider that a UTC date has to be provided.
Default: Beginning of the current day as a UTC date
Required? | false |
Position? | 7 |
Default value | (Get-Date (Get-Date).ToUniversalTime() -Format '= yyyy-MM-dd') |
Accept pipeline input? | true (ByPropertyName) |
Accept wildcard characters? | false |
-DateTo <DateTime>
Optionally specifies the date until which daily plan orders should be retu=
rned.
Consider that a UTC date has to be provided.
Default: End of the current day as a UTC date
Required? | false |
Position? | 8 |
Default value | |
Accept pipeline input? | true (ByPropertyName) |
Accept wildcard characters? | false |
-RelativeDateFrom <String>
Specifies a relative date starting from which daily plan orders should be =
returned, e.g.
* -1d, -2d: one day ago, two days ago
* +1d, +2d: one day later, two days later
* -1w, -2w: one week ago, two weeks ago
* +1w, +2w: one week later, two weeks later
* -1M, -2M: one month ago, two months ago
* +1M, +2M: one month later, two months later
* -1y, -2y: one year ago, two years ago
* +1y, +2y: one year later, two years later
Optionally a time offset can be specified, e.g. -1d+02:00, as otherwise mid=
night UTC is assumed.
This parameter takes precedence over the -DateFrom parameter.
Required? | false |
Position? | 9 |
Default value | |
Accept pipeline input? | true (ByPropertyName) |
Accept wildcard characters? | false |
-RelativeDateTo <String>
Specifies a relative date until which daily plan orders should be returned=
, e.g.
* -1d, -2d: one day ago, two days ago
* +1d, +2d: one day later, two days later
* -1w, -2w: one week ago, two weeks ago
* +1w, +2w: one week later, two weeks later
* -1M, -2M: one month ago, two months ago
* +1M, +2M: one month later, two months later
* -1y, -2y: one year ago, two years ago
* +1y, +2y: one year later, two years later
Optionally a time offset can be specified, e.g. -1d+02:00, as otherwise mid=
night UTC is assumed.
This parameter takes precedence over the -DateTo parameter.
Required? | false |
Position? | 10 |
Default value | |
Accept pipeline input? | true (ByPropertyName) |
Accept wildcard characters? | false |
-Timezone <TimeZoneInfo>
Specifies the timezone to which dates should be converted in the daily pla=
n information.
A timezone can e.g. be specified like this:
Get-JSDailyPlanOrder -Timezone (Get-Timezone -Id 'GMT Standard Time')
<=
br>
All dates in JS7 are UTC and can be converted e.g. to the local time zone l=
ike this:
Get-JSDailyPlanOrder -Timezone (Get-Timezone)
Default: Dates are returned in UTC.
Required? | false |
Position? | 11 |
Default value | (Get-Timezone -Id 'UTC') |
Accept pipeline input? | true (ByPropertyName) |
Accept wildcard characters? | false |
-Late <SwitchParameter>
Specifies that daily plan orders are returned that are late or that starte=
d later than expected.
Required? | false |
Position? | named |
Default value | False |
Accept pipeline input? | true (ByPropertyName) |
Accept wildcard characters? | false |
-Planned <SwitchParameter>
Specifies that daily plan orders are returned that have not been submitted=
.
Required? | false |
Position? | named |
Default value | False |
Accept pipeline input? | true (ByPropertyName) |
Accept wildcard characters? | false |
-Submitted <SwitchParameter>
Specifies that daily plan orders are returned that are submitted to a Cont=
roller for scheduled execution.
Required? | false |
Position? | named |
Default value | False |
Accept pipeline input? | true (ByPropertyName) |
Accept wildcard characters? | false |
-Finished <SwitchParameter>
Specifies that daily plan orders are returned that did complete.
Required? | false |
Position? | named |
Default value | False |
Accept pipeline input? | true (ByPropertyName) |
Accept wildcard characters? | false |
-------------------------- EXAMPLE 1 --------------------------
PS > $orders =3D Get-JS7DailyPlanOrder
Returns daily plan orders for the current day.
-------------------------- EXAMPLE 2 --------------------------
PS > $orders =3D Get-JS7DailyPlanOrder -Timezone (Get-Timezone)=
Returns today's daily plan orders for any workflows with dates being con= verted to the local timezone.
-------------------------- EXAMPLE 3 --------------------------
PS > $orders =3D Get-JS7DailyPlanOrder -Timezone (Get-Timezone =
-Id 'GMT Standard Time')
Returns today's daily plan orders for any workflows with dates being con= verted to the GMT timezone.
-------------------------- EXAMPLE 4 --------------------------
PS > $orders =3D Get-JS7DailyPlanOrder -DateTo (Get-Date).AddDa=
ys(3)
Returns the daily plan orders for the next 3 days.
-------------------------- EXAMPLE 5 --------------------------
PS > $orders =3D Get-JS7DailyPlanOrder -RelativeDateFrom -3d
Returns the daily plan orders for the last three days. The daily plan is= reported starting from midnight UTC.
-------------------------- EXAMPLE 6 --------------------------
PS > $orders =3D Get-JS7DailyPlanOrder -Submitted -Late
<=
/p>
Returns today's daily plan orders that have been submitted but are late,= i.e. that did not start at the expected point in time.
-------------------------- EXAMPLE 7 --------------------------
PS > $orders =3D Get-JS7DailyPlanOrder -WorkflowPath /ap/apWork=
flow1b
Returns the daily plan orders for the indicated workflow.