/orders/add
POST
Add orders
this resource can be used in the GUI for three functions
- start immediatly
- start at (with
scheduledFor
) - start at parametrised (with
scheduledFor
andarguments
)
Parameters in the POST body schema
Name | Type | Description | Example | Default |
---|---|---|---|---|
controllerId |
required, string | Controller ID | myController | |
orders |
required, array | Specified the orders which should be modified. | [{
"workflowPath":"/myWorkflow",
"orderName":"daily"
"scheduledFor":"now+10"
}] |
|
orderName |
required, string (max. 30 characters) field of each orders item |
orderName is only a part of the orderId in the form "#<date>#T<uniqueId>-<orderName>" |
||
workflowPath |
required, string field of each orders item |
|||
scheduledFor |
optional, string field of each orders item |
A start time in ISO format "yyyy-mm-dd HH:MM[:SS]" or "now" or "now + HH:MM[:SS]" or "now + SECONDS" or "never" is expected | now+10 | now |
timeZone |
optional, string field of each orders item |
|
Europe/Berlin | Etc/UTC |
arguments |
optional, object | Field of each orders itemAn object with key-value pairs. The value can be a string, number or boolean |
"arguments": { "myString": "stringValue", "myNumber": 3.14, "myBoolean": true } |
|
auditLog |
optional, object | Object that contains comment , timeSpent and ticketLink . |
{
"comment":"Operational requirement!",
"timeSpent":2
} |
|
comment |
optional, string | Field in auditLog to comment this action, e.g. the reason. |
||
timeSpent |
optional, integer | Field in auditLog to enter the time spent in minutes. |
5 | |
ticketLink |
optional, string | Field in auditLog to enter a link to a corresponding ticket. |
Request