type: error post: description: |
Name | Type | Description | Example | Default |
---|---|---|---|---|
``controllerId`` | required, string | Controller ID | myController | |
``orderIds`` | optional, array | Specified the order ids which should be modified. If this parameter is specified then the parameters ``workflowIds``, ``folders`` and ``states`` where applicable are ignored. |
[
"daily"
] |
|
``workflowIds`` | optional, array[object] | Filtered response by a collection of workflows specified by its path and optional version If this parameter is specified the parameter ``folders`` where applicable are ignored. |
[{
"path": "/path/to/workflow",
"versionId": "c79caab4-4e72-4818-bae7-902f1037d8b6"
}] |
|
``path`` | required, string | Field for each item in ``workflowIds`` to specify the path of a workflow | ||
``version`` | optional, string | Field for each in ``workflowIds`` to specify the version of a workflow | ||
``folders`` | optional, array[object] | Limits the result to a collection of folders | [{
"folder": "/sos",
"recursive": true
}] |
|
``states`` | optional, array | Filtered all orders with states such as
| ["SUSPENDED"] |