Page History

...

Returns the daily plan orders for workflows scheduled for a number of JS7 ControllerControllers

SYNTAX

Get-JS7DailyPlanOrder [[-OrderId] <String>] [[-WorkflowPath] <String>] [[-WorkflowFolder] <String>] [[-SchedulePath] <String>] [[-ScheduleFolder] <String>] [-Recursive] [[-ControllerId] <String>] [[-Tag] <String[]>] [[-DateFrom] <DateTime>] [[-DateTo] <DateTime>] [[-RelativeDateFrom] <String>] [[-RelativeDateTo] <String>] [[-Timezone] <TimeZoneInfo>] [-Late] [-Planned] [-Submitted] [-Finished] [<CommonParameters>]

...

The daily plan orders for workflows of a number of JS7 Controllers are returned.

The following REST Web Service API resources are used:

* /daily_plan/orders

...

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

...

-SchedulePath <String>
Optionally specifies the path and/or name of a schedule for which daily plan orders should be returned.

...

ControllerId

-ControllerId <String>
Limits results to orders assigned the specified Controller.

Tag

-Tag <String[]>
Filters orders by a list of tags.

If more than one tag is specified then they are separated by comma.

DateFrom

-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: Begin Beginning of the current day as a UTC date

...

-DateTo <DateTime>
Optionally specifies the date until which daily plan orders should be returned.
Consider that a UTC date has to be provided.

Default: End of the current day as a UTC date

...

-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 midnight UTC is assumed.

This parameter takes precedence over the -DateFrom parameter.

...

-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 midnight UTC is assumed.

This parameter takes precedence over the -DateTo parameter.

...

-Timezone <TimeZoneInfo>
Specifies the timezone to which dates should be converted in the daily plan information.
A timezone can e.g. be specified like this:

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

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

Get-JSDailyPlanOrder -Timezone (Get-Timezone)

Default: Dates are returned in UTC.

...

-Planned <SwitchParameter>
Specifies that daily plan orders are returned that did have not yet startbeen submitted.

...

-Submitted <SwitchParameter>
Specifies that daily plan orders are returned that are submitted to a Controller for scheduled execution.

...

-Finished <SwitchParameter>
Specifies that daily plan orders are returned that did complete.

...

PS > $orders = Get-JS7DailyPlanOrder -Failed Submitted -Late

Returns today's daily plan orders that failed or have been submitted but are late, i.e. that did not start at the expected point in time.

...

Returns the daily plan orders for the given indicated workflow.