/orders/history
POST
Order history from reporting
Parameters in the POST body schema
Name | Type | Description | Example | Default |
---|---|---|---|---|
jobschedulerId |
optional, string | JobScheduler Master ID | scheduler | |
orders |
optional, array | Filtered response by a collection of orders specified by its job chain path and an optional order id. If "orderId" is undefined then all orders of the specified job chain are included in the response. If "orderId" is specified then parameters such as folders , types , excludeOrders and regex are ignored. |
[{
"jobChain":"/sos/reporting/Inventory",
"orderId":"Inventory"
}] |
|
excludeOrders |
optional, array | Response contains all orders except the orders which are specified in this collection. An order is specified by its job chain path and an optional order id. If "orderId" is undefined then all orders of the specified job chain are excluded in the response. This parameter will be ignored if orders parameter is set. |
[{
"jobChain":"/sos/reporting/Inventory",
"orderId":"Inventory"
}] |
|
dateFrom |
optional, string | The value has multiple formats
|
1d | |
dateTo |
optional, string | The value has multiple formats like the dateFrom parameter
|
0 | |
timeZone |
optional, string |
|
Berlin/Europe | |
regex |
optional, string | Regular expression to filter the collection | .* | |
folders |
optional, array | collection of folder objects | [{
"folder": "/sos",
"recursive": true
}] |
|
limit |
optional, integer | Restricts the number of responsed records, -1=unlimited | 5000 | 10000 |
historyStates |
optional, array contains SUCCESS, FAILED and/or INCOMPLETE |
Only records with these states are responsed | ["SUCCESS"] | |
historyIds |
optional; array[integer] | The history ids of orders If "historyIds" is specified then all other optional parameters except jobschedulerId are ignored. |
[4711] |
Request