/events/custom
POST
Custom events
Parameters in the POST body schema
Name | Type | Description | Example | Default |
---|---|---|---|---|
jobschedulerId |
required, string | JobScheduler Master ID | scheduler | |
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 | |
jobs |
optional, array | Filtered response by a collection of jobs specified by its job path. Other parameters such as folders , excludeJobs and regex are ignored if this parameter is defined. |
[{
"job":"/sos/reporting/Inventory"
}] |
|
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"
}] |
|
eventIds |
optional, array | Filtered response by a collection of events specified by its event id. | [
"myEventId"
] |
|
eventClasses |
optional, array | Filtered response by a collection of events specified by its event class. | [
"myEventClass"
] |
|
exitCodes |
optional, array | Filtered response by a collection of events specified by its exit code. | [
0
] |
|
limit |
optional, integer | Restricts the number of responsed records, -1=unlimited | 5000 | 10000 |
Request