JOC API

Version 1.12.9

http(s)://test.sos-berlin.com:3001/joc/api

Download RAML
JOC API
/yade/orders
POST

Returns a collection of orders (volatile part) filtered by a period, job chains or order state


Parameters in the POST body schema

Name Type Description Example Default
jobschedulerId required, string JobScheduler Master ID scheduler
compact optional, boolean Response has a compact version if this parameter is true false
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"
}]
processingStates optional, array Filtered all orders with states such as
  • SUSPENDED
  • RUNNING
  • SETBACK
  • WAITINGFORRESOURCE
["SUSPENDED"]