Page History
...
-OrderId <String>
Optionally specifies the unique identifier of an order to limit results to that order.
This parameter requires use of the -Workflow parameter. that should be returned.
Required? | false |
Position? | 1 |
Default value | |
Accept pipeline input? | true (ByPropertyName) |
Accept wildcard characters? | false |
...
WorkflowPath
-WorkflowPath <String>
Optionally specifies the path and name of a workflow for which history information is returned.
If the name of a workflow is specified then the -Folder parameter is used to determine the folder.
Otherwise the -WorkflowPath parameter is assumed to include the full path and name of the workflow.
One of the parameters -OrderId -Folder or -WorkflowPath has to be specified.
Required? | false |
Position? | 3 |
Default value | |
Accept pipeline input? | true (ByPropertyName) |
Accept wildcard characters? | false |
Folder
-Folder <String>
Optionally specifies the folder for which jobs should be returned. The folder is determined
from the root folder.
Required? | false |
Position? | 4 |
Default value | / |
Accept pipeline input? | true (ByPropertyName) |
Accept wildcard characters? | false |
...
-Recursive <SwitchParameter>
Specifies that any sub-folders should be looked up when used with the -Directory Folder parameter.
By default no sub-folders will be looked up for jobs.
...
-RegularExpression <String>
Specifies a regular expression that filters the orders to be returned.
The regular expression is applied to the path and order ID of orders.
Required? | false |
Position? | 6 |
Default value | |
Accept pipeline input? | true (ByPropertyName) |
Accept wildcard characters? | false |
...
-Timezone <TimeZoneInfo>
Specifies the timezone to which dates should be converted in 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 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.
...
PS > $items = Get-JS7OrderHistory -RegEx RegularExpression '^/sos'
Returns today's order execution history for any orders from the /sos folder.
...
PS > $items = Get-JS7OrderHistory -RegEx RegularExpression 'report'
Returns today's order execution history for orders that contain the string 'report' in the order's path.
...
PS > $items = Get-JS7OrderHistory -Workflow WorkflowPath /sos/dailyplan/CreateDailyPlan
...