``exportFile`` required, object This objects describes the export file with ``filename`` and ``format``.
"exportFile" : {
"filename" : "test_export.zip",
"format" : "ZIP"
}
``filename`` required, string "filename" : "test_export.zip" ``format`` optional, enum The desired ``format`` of the export archive file. Possible values are "ZIP" and "TAR_GZ" "format" : "ZIP" ZIP ``useShortPath`` optional, boolean Determines if the desired objects are exported to the archive with a shortened path, e.g. if set to true the object /a/b/c/myWorkflow will be exported as /c/myWorkflow. false ``startFolder`` optional, string The path given determines the starting point for the relative path. E.g. ``startFolder`` /a/b/c results in objects starting with relative path c/... in the exported archive. Only used in conjunction with ``useShortPath``. /a/b/c ``forSigning`` required oneOf(``forSigning``, ``shallowCopy``), object Object consists of a ``controllerId`` and a ``deployables`` object. "forSigning" : {
"controllerId" : "testsuite",
"deployables" : {
...example see below...
}
} ``controllerId`` required, string ControllerId of the controller the export is meant for. "controllerId" : "testsuite" ``deployables`` required, object Contains a set of deployable draft objects and/or a set of already deployed objects. ``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, enum 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 already deployed configuration objects. ``configuration`` required, object An already deployed configuration specified by its ``path``, ``objectType`` and ``commitId`` OR a folder specified by ``path`` and ``objectType`` only. If already 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`` optional, string The ``commitId`` of the deployment of the already 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 see above. "recursive" : true false ``shallowCopy`` required oneOf(``forSigning``, ``shallowCopy``), object Object of ``deployables`` and ``releasables`` objects. "shallowCopy" : {
"deployables" : {
...example see below...
}, {
"releasables" : {
...example see below...
}
} ``deployables`` required, object Contains a set of deployable draft objects and/or a set of already deployed objects. ``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, enum 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 already deployed configuration objects. ``configuration`` required, object An already deployed configuration specified by its ``path``, ``objectType`` and ``commitId`` OR a folder specified by ``path`` and ``objectType`` only. If already 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`` optional, string The ``commitId`` of the deployment of the already 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 see above. "recursive" : true false ``withoutInvalid`` optional, boolean Decides if invalid draft objects are excluded from export. "withoutInvalid" : true false ``releasables`` required, object Contains a set of releasable draft objects and/or a set of already released objects. ``draftConfigurations`` required anyOf(``draftConfigurations``, ``releasedConfigurations``), array An array of draft configuration of releasable objects. ``configuration`` required, object A draft configuration 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" : "/mySchedules/newSchedules/mySchedule",
"objectType" : "SCHEDULE"
}
``path`` required, string "path" : "/mySchedules/newSchedules/mySchedule" ``objectType`` required, enum Subset of releasable objects from the enum ConfigurationType. Subset consist of SCHEDULE, "JOBTEMPLATE", "INCLUDESCRIPT", WORKINGDAYSCALENDAR, NONWORKINGDAYSCALENDAR and FOLDER. "objectType" : "SCHEDULE" ``recursive`` optional, boolean see above. "recursive" : true false ``releasedConfigurations`` required anyOf(``draftConfigurations``, ``releasedConfigurations``), array An array of configuration of already released objects. ``configuration`` required, object An already released configuration specified by its ``path`` and ``objectType``. If already released configurations are specified by a folder, all released items from the folder will be processed.
"configuration" : {
"path" : "/myCalendars/newCalendars/myCalendar",
"objectType" : "WORKINGDAYSCALENDAR"
}
``path`` required, string "path" : "/myCalendars/newCalendars/myCalendar" ``objectType`` required, enum see above. "objectType" : "WORKINGDAYSCALENDAR" ``recursive`` optional, boolean see above. "recursive" : true false ``withoutInvalid`` optional, boolean Decides if invalid draft objects are excluded from export. "withoutInvalid" : true false ``auditLog`` optional, object ``comment`` optional, string for auditLog ``timeSpent`` optional, string for auditLog ``ticketLink`` optional, string for auditLog