/daily_plan/orders/modify
POST
Modifies Orders for the daily plan
Parameters in the POST body schema
Name | Type | Description | Example | Default |
---|---|---|---|---|
controllerId |
required, string | Controller ID | myController | |
orderIds |
required; array[string] | Orders that are to be processed | ["#2020-09-15#P0000000046-myOrderName"] | |
scheduledFor |
optional, string | A start time in ISO format "yyyy-mm-dd[ HH:MM[:SS]]" or "now" or "now + HH:MM[:SS]" or "now + SECONDS" or "cur ± HH:MM[:SS]" or "cur ± SECONDS" is expected | now+10 | |
timeZone |
optional, string |
|
Europe/Berlin | Etc/UTC |
cycle |
optional, string | For cyclic orders the cycle will be defined with begin, end and repeat attribute. The values have to have the format hh:mm:ss |
{ "begin": "00:00:00", "end": "20:00:00", "repeat": "00:10:00" } |
|
forceJobAdmission |
optional, boolean | If true then any admission times at a Job instruction will be ignored | false | |
stickDailyPlanDate |
optional, boolean | If true then the orders stick to their original Daily Plan date | false | |
The fields variables , removeVariables , startPosition and endPositions can only be considered if all Orders that are to be modified belong to the same Workflow |
||||
variables |
optional, object | An object with key-value pairs for the order. The value can be a string, number or boolean. The variables that already exist will be updated with the new values. The variables that do not exist will be added. To remove variables use the removeVariables array. |
"variables":{ "myString": "stringValue", "myNumber": 3.14, "myBoolean": true } |
|
removeVariables |
optional, array[string] | Variables specified by their keys will be removed. | "removeVariables":{ "myString", "myNumber", "myBoolean" } |
|
startPosition |
optional, array or string | The order starts with the first instruction per default. The position can also be specified by the label of the instruction. | [0] | |
endPositions |
optional, array[array or string] | The order ends on one of these positions. The position can also be specified by the label of the instruction. | [[1]] | |
blockPosition |
optional, array or string | The order runs only inside the specified block instruction. The position can also be specified by the label of the instruction. | [1, "lock"] | |
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. |
||
ticketLink |
optional, string | Field in auditLog to enter a link to a corresponding ticket. |
Request