``controllerIds`` |
required, array |
Filter collection of JS7 Controllers, specified by their controllerId. |
"controllerIds" : [
"testsuite",
"standalone"
] |
|
``addOrdersDateFrom`` |
optional, string |
Sets the starting date for orders to be added to the daily plan. The API accepts a date in the format YYYY-MM-DD or the string 'now' to indicate to add orders starting from the time of deployment. Previously planned or submitted orders will be canceled. |
"addOrdersDateFrom" : "now" |
|
``store`` |
required anyOf(``store``, ``delete``), object |
Filter collection of deployable objects to add or update, specified by their paths and object types. |
"store" : {
"draftConfigurations" : [{
...example see below...
],
"deployConfigurations" : [{
...example see below...
]
} |
|
``draftConfigurations`` |
required anyOf(``draftConfigurations``, ``deployConfigurations``), array |
An array of draft configuration of deployable objects. |
|
|
``configuration`` |
required, object |
A configuration or a Folder specified by its ``path`` and ``objectType``. If draft configurations are specified by a folder, all draft items from the folder will be processed. |
"configuration" : {
"path" : "/myWorkflows/ifElseWorkflow/workflow_10",
"objectType" : "WORKFLOW"
}
|
|
``path`` |
required, string |
|
"path" : "/myWorkflows/ifElseWorkflow/workflow_10" |
|
``objectType`` |
required, string |
Subset of deployable objects from the enum ConfigurationType. The subset consist of WORKFLOW, NOTICEBOARD, LOCK, FILEORDERSOURCE and FOLDER. |
"objectType" : "WORKFLOW" |
|
``recursive`` |
optional, boolean |
Decides if a given folder should be processed recursively. |
"recursive" : true |
false |
``deployConfigurations`` |
required anyOf(``draftConfigurations``, ``deployConfigurations``), array |
An array of deployed configuration objects. |
|
|
``configuration`` |
required, object |
An deployed configuration specified by its ``path``, ``objectType`` and ``commitId`` OR a folder specified by ``path`` and ``objectType`` only. If deployed configurations are specified by a folder, all latest deployments of the items from the folder will be processed. |
"configuration" : {
"path" : "/myWorkflows/ifElseWorkflow/workflow_12",
"objectType" : "WORKFLOW",
"commitId" : "4273b6c6-c354-4fcd-afdb-2758088abe4a"
}
|
|
``path`` |
required, string |
|
|
|
``objectType`` |
required, enum |
see above. |
|
|
``commitId`` |
required, string |
The ``commitId`` of the deployment of the deployed configuration. If no commitId is set the latest deployment of the configuration will be processed. |
"commitId" : "4273b6c6-c354-4fcd-afdb-2758088abe4a" |
|
``recursive`` |
optional, boolean |
Decides if a given folder should be processed recursively. |
"recursive" : true |
false |
``delete`` |
required anyOf(``store``, ``delete``), object |
Filter collection of deployed objects to delete, specified by their paths and object types. All selected objects will be deleted from all known controllers, not just from the selected ones. |
"delete" : {
"deployConfigurations" : [{
...example see below...
]
} |
|
``deployConfigurations`` |
required, array |
An array of deployed configuration objects. |
|
|
``configuration`` |
required, object |
see above. |
"configuration" : {
"path" : "/myWorkflows/ifElseWorkflow/workflow_12",
"objectType" : "WORKFLOW",
"commitId" : "4273b6c6-c354-4fcd-afdb-2758088abe4a"
}
|
|
``path`` |
required, string |
|
|
|
``objectType`` |
required, enum |
see above. |
|
|
``commitId`` |
required, string |
see above. |
"commitId" : "4273b6c6-c354-4fcd-afdb-2758088abe4a" |
|
``recursive`` |
optional, boolean |
see above. |
"recursive" : true |
false |