``controllerId`` optional, string ControllerId of the controller the configurations are deployed to. Required if a specific version of a configuration has to be stored in the local repository. "controllerId" : "testsuite" ``rollout`` required anyOf(``rollout``, ``local``), object Filter collection of configuration objects to add or update, specified by their paths and object types. "rollout" : {
"draftConfigurations" : [{
...example see below...
],
"deployConfigurations" : [{
...example see below...
]
"releasedConfigurations" : [{
...example see below...
]
} ``draftConfigurations`` required anyOf(``draftConfigurations``, ``deployConfigurations``, ``releasedConfigurations``), array An array of draft configuration of deployable or releaseable 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``, ``releasedConfigurations``), 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 ``releasedConfigurations`` required anyOf(``draftConfigurations``, ``deployConfigurations``, ``releasedConfigurations``), array An array of released configuration objects. ``configuration`` required, object A released configuration specified by its ``path`` and ``objectType``. If released configurations are specified by a folder, all released items from the folder will be processed.
"configuration" : {
"path" : "/mySchedules/ifElseWorkflows/schedule_if_else_1",
"objectType" : "SCHEDULE"
}
``path`` required, string ``objectType`` required, enum see above. ``recursive`` optional, boolean Decides if a given folder should be processed recursively. "recursive" : true false ``local`` required anyOf(``rollout``, ``local``), 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. "local" : {
"draftConfigurations" : [{
...example see below...
],
"deployConfigurations" : [{
...example see below...
]
"releasedConfigurations" : [{
...example see below...
]
} ``draftConfigurations`` required anyOf(``draftConfigurations``, ``deployConfigurations``, ``releasedConfigurations``), array An array of draft configuration of deployable or releaseable 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 Configuration objects from the enum ConfigurationType. "objectType" : "WORKFLOW" ``recursive`` optional, boolean Decides if a given folder should be processed recursively. "recursive" : true false ``deployConfigurations`` required anyOf(``draftConfigurations``, ``deployConfigurations``, ``releasedConfigurations``), array An array of deployed configuration objects. ``configuration`` required, object A 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 ``releasedConfigurations`` required anyOf(``draftConfigurations``, ``deployConfigurations``, ``releasedConfigurations``), array An array of released configuration objects. ``configuration`` required, object A released configuration specified by its ``path`` and ``objectType``. If released configurations are specified by a folder, all released items from the folder will be processed.
"configuration" : {
"path" : "/mySchedules/ifElseWorkflows/schedule_if_else_1",
"objectType" : "SCHEDULE"
}
``path`` required, string ``objectType`` required, enum see above. ``recursive`` optional, boolean Decides if a given folder should be processed recursively. "recursive" : true false