Page History

...

SYNTAX

Get-JS7OrderHistory [[-ControllerId] <String>] [[-OrderId] <String>] [[-WorkflowPath] <String>] [[-WorkflowName] <String>] [[-Folder] <String>] [-Recursive] [[-ExcludeOrder] <Hashtable>ExcludeWorkflow] <String[]>] [[-RegularExpression] <String>] [[-DateFrom] <DateTime>] [[-DateTo] <DateTime>] [[-RelativeDateFrom] <String>] [[-RelativeDateTo] <String>] [[-Timezone] <TimeZoneInfo>] [[-Limit] <Int32>] [-Successful] [-Failed] [-InProgress] [[-WorkflowId] <PSObject>] [<CommonParameters>]

...

History information is returned for orders from a JS7 Controller.
Order executions can be selected by workflow, order Order ID, folder, history status etc.

The history information returned includes start time, end time, return code etc.

The following REST Web Service API resources are used:

* /orders/history

PARAMETERS

ControllerId

-ControllerId <String>

OrderId

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

...

-WorkflowPath <String>
Optionally specifies the path and name of a workflow for which order history information is returned.

WorkflowName

-WorkflowName <String>

...

-Folder <String>
Optionally specifies the folder that includes workflows for which the order history should be returned.

...

...

ExcludeWorkflow

-ExcludeOrder <Hashtable>ExcludeWorkflow <String[]>
This parameter accepts a hashmap list of order IDs and optionally workflow paths that are excluded from the results.
If a workflow path is specified then all orders of the given workflow are excluded. Get-JSOrderHistory -folder /some_folder -ExcludeOrder @{ 'workflowPath'='/some_folder/some_sub_folder/some_workflow' }

...

-RegularExpression <String>
Specifies that a regular expression that filters orders to be returned.
The regular expression is applied to the order 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.

...

-DateFrom <DateTime>
Specifies the date starting from which history items should be returned.
Consider that a UTC date has to be provided.

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

...

-DateTo <DateTime>
Specifies the date until which history items should be returned.
Consider that a UTC date has to be provided.

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

...

-RelativeDateFrom <String>
Specifies a relative date starting from which history items should be returned, e.g.

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

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 . This is calculated by the cmdlet
for the timezone that is specified with the -Timezone parameter.

This parameter takes precedence over the -DateFrom parameter.

...

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

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

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 . This is calculated by the cmdlet
for the timezone that is specified with the -Timezone parameter.

This parameter takes precedence over the -DateFrom parameter.

...

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

Get-JS7OrderHistory -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-JS7OrderHistory -Timezone (Get-Timezone)

Default: Dates are returned in UTC.

...

-Limit <Int32>
Specifies the max. number of history items for order executions to be returned.
The default value is 10000, for an unlimited number of items the value -1 can be specified.

...

-WorkflowId <PSObject>
This is an implicit parameter used when pipelining order objects to this cmdlet as e.g. with

Get-JS7Order -Folder /some_path | Get-JS7OrderHistory

...

PS > $items = Get-JS7OrderHistory -RegularExpression "'sos$'

Returns today's order execution history for any orders with an order Order ID that ends with the string "sos".

...

PS > $items = Get-JS7OrderHistory -ExcludeOrder @{ 'workflowPath'='/some_path/some_workflow'; 'orderId'='2020-11-23#P0000000547-orderSampleWorkflow1a' }ExcludeWorkflow workflow1,workflow2

Returns today's order execution history for any orders excluding orders from the specified workflow paths and order IDsworkflows.

-------------------------- EXAMPLE 7 --------------------------

...