Versions Compared

Key

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

...

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

...

-ExcludeOrder <Hashtable>
This parameter accepts a hashmap of order 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.

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

...

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".

...