type: error
post:
  description: |
    <h2>Add orders</h2>
    <p>this resource can be used in the GUI for three functions</p>
    <ul>
    <li><i>start immediatly</i></li>
    <li><i>start at</i> (with ``scheduledFor``)</li>
    <li><i>start at parametrised</i> (with ``scheduledFor`` and ``arguments``)</li>
    </ul>
    ___
    <h4>Parameters in the POST body schema</h4>
    <table class="params" style="table-layout:auto;">
    <colgroup>
      <col width="10%"/>
      <col width="16%"/>
      <col width="*"/>
      <col width="20%"/>
      <col width="10%"/>
    </colgroup>
    <thead>
    <tr><th>Name</th><th>Type</th><th>Description</th><th>Example</th><th>Default</th>
    </thead><tbody>
    <tr><td>``controllerId``</td><td>required, string</td><td>Controller ID</td><td>myController</td><td></td></tr>
    <tr><td>``orders``</td><td>required, array</td>
    <td>Specified the orders which should be modified.</td>
    <td> [{
      <div style="padding-left:10px;">"workflowPath":"/myWorkflow",</div>
      <div style="padding-left:10px;">"orderName":"daily"</div>
      <div style="padding-left:10px;">"scheduledFor":"now+10"</div>
      }]</td>
    <td></td></tr>
    <tr><td style="padding-left:20px;">``orderName``</td><td>required, string (max. 30 characters)<br/>field of each ``orders`` item</td><td>``orderName`` is only a part of the orderId in the form &quot;#&lt;date&gt;#T&lt;uniqueId&gt;-&lt;orderName&gt;&quot;</td><td></td></tr>
    <tr><td style="padding-left:20px;">``workflowPath``</td><td>required, string<br/>field of each ``orders`` item</td><td></td><td></td></tr>
    <tr><td style="padding-left:20px;">``scheduledFor``</td><td>optional, string<br/>field of each ``orders`` item</td>
    <td>A start time in ISO format &quot;yyyy-mm-dd HH:MM[:SS]&quot; or &quot;now&quot; or &quot;now + HH:MM[:SS]&quot; or &quot;now + SECONDS&quot; or &quot;never&quot; is expected</td>
    <td>now+10</td><td>now</td></tr>
    <tr><td style="padding-left:20px;">``timeZone``</td><td>optional, string<br/>field of each ``orders`` item</td><td><ul>
       <li>This parameter set the time zone for the time stamp in the ``scheduledFor`` parameter.</li>
       <li>See here the list for <a href="https://en.wikipedia.org/wiki/List_of_tz_database_time_zones" target="wiki">available time zones</a>.</li>
    </ul></td><td>Europe/Berlin</td><td>Etc/UTC</td></tr>
    <tr><td style="padding-left:20px;">``arguments``</td><td>optional, object<br/>field of each ``orders`` item</td><td>An object with key-value pairs. The value can be a string, number or boolean<td><pre>"arguments": {
      "myString": "stringValue",
      "myNumber": 3.14,
      "myBoolean": true
    }</pre></td><td></td></tr>
    <tr><td style="padding-left:20px;">``startPosition``</td><td>optional, array or string<br/>field of each ``orders`` item</td><td>The order starts with the first instruction per default.<br/>
    	The position can also be specified by the label of the instruction.<td>[0] or "job1"</td><td></td></tr>
    <tr><td style="padding-left:20px;">``endPositions``</td><td>optional, array[array or string]<br/>field of each ``orders`` item</td><td>The order ends on one of these positions<br/>
        The position can also be specified by the label of the instruction.<td>[[1]] or ["lastJob"]</td><td></td></tr>
    <tr><td style="padding-left:20px;">``blockPosition``</td><td>optional, array or string</td><td>The order runs only inside the specified block instruction. The position can also be specified by the label of the block instruction.<td>[1, "lock"]</td><td></td></tr>
    <tr><td style="padding-left:20px;">``forceJobAdmission``</td><td>optional, boolean<br/>field of each ``orders`` item</td><td>If true then any admission times at a Job instruction will be ignored</td><td></td><td>false</td></tr>
    <tr><td style="padding-left:20px;">``priority``</td><td>optional, integer<br/>field of each ``orders`` item</td><td>Priority of the order</td><td></td><td>0</td></tr>
    <tr><td style="padding-left:20px;">``planId``</td><td>optional, object<br/>field of each ``orders`` item</td><td></td><td rowspan="3"><pre>{
      "planSchemaId": "DailyPlan",
      "noticeSpaceKey": "2025-03-20"   
    }</pre></td><td></td></tr>
    <tr><td style="padding-left:40px;">``planSchemaId``</td><td>required, string</td><td>Schema ID of a plan, e.g. 'DailyPlan'</td><td>DailyPlan</td></tr>
    <tr><td style="padding-left:40px;">``noticeSpaceKey``</td><td>required, string</td><td>Plan key of the plan</td><td>current DailyPlan date</td></tr>
    <tr><td style="padding-left:20px;">``openClosePlan``</td><td>optional, boolean<br/>field of each ``orders`` item</td><td>If true then a closed plan will be reopen automatically</td><td></td><td>false</td></tr>
    <<audit>>
    </tbody></table>

  body:
    application/json:
      schema: addOrders
      example: |
        {
          "controllerId": "myController",
          "orders": [{
            "orderId": "order1",
            "workflowPath": "/test/testWorkflow",
            "scheduledFor": "now + 60"
          }, {
            "orderId": "order2",
            "workflowPath": "/test/testWorkflow"
          }, {
            "orderId": "order3",
            "workflowPath": "/test/testWorkflow"
          }, {
            "orderId": "order4",
            "workflowPath": "/test/testWorkflow"
          }, {
            "orderId": "order5",
            "workflowPath": "/test/testWorkflow"
          }]
        }
  responses:
    200:
      description: Returns the orderIds that are tried to add.
      body:
        application/json:
          schema: orderIds
          example: |
            {
              "deliveryDate":"2020-11-20T21:13:35Z",
              "orderIds": [
                "#2020-11-20#T835857946-Test0000000055"
              ]
            }
    419: