JOC API

/inventory/export

GET

Provides archive file (zip, tar.gz) to download unsigned JSON files

Request

Name	Description	Example	Type
Query parameters
accessToken	Is required if the header doesn't contain `X-Access-Token`	550e8400-e29b-11d4-a716-446655440000	string?
comment	for auditLog		string?
exportFilter*	URL encoded json string of the export filter. Line breaks and spaces are stripped from the json string. See also POST example.	{"shallowCopy":{"deployables":{"draftConfigurations":[{"configuration":{"path":"/myWorkflows/ifElseWorkflow/workflow_10", "objectType":"WORKFLOW"}}, {"configuration":{"path":"/myWorkflows/ifElseWorkflow/workflow_16", "objectType":"WORKFLOW"}}], "deployConfigurations":[{"configuration":{"path":"/myWorkflows/ifElseWorkflow/workflow_12", "objectType":"WORKFLOW", "commitId":"4273b6c6-c354-4fcd-afdb-2758088abe4a"}}]}, "releasables":{"draftConfigurations":[{"configuration":{"path":"mySchedules/newSchedules/mySchedule", "objectType":"SCHEDULE"}}], "releasedConfigurations":[{"configuration":{"path":"/myCalendars/newCalendars/myCalendar", "objectType":"WORKINGDAYSCALENDAR"}}]}}, "exportFile":{"filename":"test_export.zip", "format":"ZIP"}}	string
ticketLink	for auditLog		string?
timeSpent	for auditLog		string?
Headers
X-Access-Token*	Request requires authentication!	550e8400-e29b-11d4-a716-446655440000	string

Responses

Code	Description	Headers	Body
200	Content for download	Content-Disposition Content-Type	application/octet-stream
401	Unauthorized!		application/json model \| example { "title": "authentication", "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "required": [ "isAuthenticated" ], "properties": { "user": { "type": "string" }, "accessToken": { "type": "string" }, "message": { "type": "string" }, "role": { "type": "string" }, "isAuthenticated": { "type": "boolean" }, "isPermitted": { "type": "boolean", "default": false }, "sessionTimeout": { "type": "integer", "default": 1800 }, "enableTouch": { "type": "boolean", "default": true } } } { "user": "root", "message": "Oops!", "isAuthenticated": false, "isPermitted": false } { "user": "root", "message": "Oops!", "isAuthenticated": false, "isPermitted": false }
403	Forbidden! The user doesn't have sufficient permissions for 'export'		application/json model \| example { "title": "authentication", "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "required": [ "isAuthenticated" ], "properties": { "user": { "type": "string" }, "accessToken": { "type": "string" }, "message": { "type": "string" }, "role": { "type": "string" }, "isAuthenticated": { "type": "boolean" }, "isPermitted": { "type": "boolean", "default": false }, "sessionTimeout": { "type": "integer", "default": 1800 }, "enableTouch": { "type": "boolean", "default": true } } } { "user": "root", "message": "You don't have sufficient permissions for ...", "role": "all", "isAuthenticated": true, "isPermitted": false } { "user": "root", "message": "You don't have sufficient permissions for ...", "role": "all", "isAuthenticated": true, "isPermitted": false }
420	export failed!		application/json model \| example { "title": "error object with delivery date", "$schema": "http://json-schema.org/draft-04/schema#", "javaType": "com.sos.joc.model.common.Err420", "type": "object", "required": [ "deliveryDate", "error" ], "properties": { "deliveryDate": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" }, "surveyDate": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" }, "error": { "javaType": "com.sos.joc.model.common.Err", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } { "deliveryDate": "2016-05-05T21:13:35Z", "surveyDate": "2016-05-05T21:13:33Z", "error": { "code": "JOC-420", "message": "export failed!" } } { "deliveryDate": "2016-05-05T21:13:35Z", "surveyDate": "2016-05-05T21:13:33Z", "error": { "code": "JOC-420", "message": "export failed!" } }
440	Login Timeout! The client's session has expired and must log in again.		application/json model \| example { "title": "error object with delivery date", "$schema": "http://json-schema.org/draft-04/schema#", "javaType": "com.sos.joc.model.common.Err420", "type": "object", "required": [ "deliveryDate", "error" ], "properties": { "deliveryDate": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" }, "surveyDate": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" }, "error": { "javaType": "com.sos.joc.model.common.Err", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } { "deliveryDate": "2016-05-05T21:13:35Z", "error": { "code": "AUTH-440", "message": "Session has expired! Please log in again." } } { "deliveryDate": "2016-05-05T21:13:35Z", "error": { "code": "AUTH-440", "message": "Session has expired! Please log in again." } }

POST

Provides archive file (zip, tar.gz) to download unsigned JSON files

Parameters in the POST body schema

Name	Type	Description	Example	Default
`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
`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

Request

Name

Description

Example

Type

Constraints

Default

Headers

X-Access-Token*

Request requires authentication!

550e8400-e29b-11d4-a716-446655440000

string

Body

application/json

model | example

{
    "title": "ExportFilter",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "javaType": "com.sos.joc.model.publish.ExportFilter",
    "type": "object",
    "oneOf": [{
        "required": [
            "forSigning",
            "exportFile"
        ]
    }, {
        "required": [
            "shallowCopy",
            "exportFile"
        ]
    }],
    "properties": {
        "forSigning": {
            "javaType": "com.sos.joc.model.publish.ExportForSigning",
            "type": "object",
            "required": [
                "controllerId",
                "deployables"
            ],
            "properties": {
                "controllerId": {
                    "type": "string",
                    "pattern": "^[^<>]*$",
                    "maxLength": 255
                },
                "deployables": {
                    "javaType": "com.sos.joc.model.publish.DeployablesValidFilter",
                    "type": "object",
                    "anyOf": [{
                        "required": [
                            "draftConfigurations"
                        ]
                    }, {
                        "required": [
                            "deployConfigurations"
                        ]
                    }],
                    "properties": {
                        "draftConfigurations": {
                            "type": "array",
                            "items": {
                                "javaType": "com.sos.joc.model.publish.Config",
                                "type": "object",
                                "required": [
                                    "configuration"
                                ],
                                "properties": {
                                    "configuration": {
                                        "javaType": "com.sos.joc.model.publish.Configuration",
                                        "type": "object",
                                        "required": [
                                            "path",
                                            "objectType"
                                        ],
                                        "properties": {
                                            "path": {
                                                "description": "absolute path of an object.",
                                                "type": "string",
                                                "pattern": "^(/|(/[^/\\\\<>?:\"|*]+)+)$",
                                                "maxLength": 255,
                                                "minLength": 1
                                            },
                                            "objectType": {
                                                "javaType": "com.sos.joc.model.inventory.common.ConfigurationType",
                                                "type": "string",
                                                "enum": [
                                                    "FOLDER",
                                                    "WORKFLOW",
                                                    "JOBCLASS",
                                                    "JOBRESOURCE",
                                                    "LOCK",
                                                    "NOTICEBOARD",
                                                    "FILEORDERSOURCE",
                                                    "WORKINGDAYSCALENDAR",
                                                    "NONWORKINGDAYSCALENDAR",
                                                    "SCHEDULE",
                                                    "JOB"
                                                ]
                                            },
                                            "commitId": {
                                                "type": "string",
                                                "pattern": "^[^<>]*$",
                                                "maxLength": 255
                                            },
                                            "recursive": {
                                                "type": "boolean",
                                                "default": false
                                            }
                                        }
                                    }
                                }
                            }
                        },
                        "deployConfigurations": {
                            "type": "array",
                            "items": {
                                "javaType": "com.sos.joc.model.publish.Config",
                                "type": "object",
                                "required": [
                                    "configuration"
                                ],
                                "properties": {
                                    "configuration": {
                                        "javaType": "com.sos.joc.model.publish.Configuration",
                                        "type": "object",
                                        "required": [
                                            "path",
                                            "objectType"
                                        ],
                                        "properties": {
                                            "path": {
                                                "description": "absolute path of an object.",
                                                "type": "string",
                                                "pattern": "^(/|(/[^/\\\\<>?:\"|*]+)+)$",
                                                "maxLength": 255,
                                                "minLength": 1
                                            },
                                            "objectType": {
                                                "javaType": "com.sos.joc.model.inventory.common.ConfigurationType",
                                                "type": "string",
                                                "enum": [
                                                    "FOLDER",
                                                    "WORKFLOW",
                                                    "JOBCLASS",
                                                    "JOBRESOURCE",
                                                    "LOCK",
                                                    "NOTICEBOARD",
                                                    "FILEORDERSOURCE",
                                                    "WORKINGDAYSCALENDAR",
                                                    "NONWORKINGDAYSCALENDAR",
                                                    "SCHEDULE",
                                                    "JOB"
                                                ]
                                            },
                                            "commitId": {
                                                "type": "string",
                                                "pattern": "^[^<>]*$",
                                                "maxLength": 255
                                            },
                                            "recursive": {
                                                "type": "boolean",
                                                "default": false
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        },
        "shallowCopy": {
            "javaType": "com.sos.joc.model.publish.ExportShallowCopy",
            "type": "object",
            "anyOf": [{
                "required": [
                    "deployables"
                ]
            }, {
                "required": [
                    "releasables"
                ]
            }],
            "properties": {
                "deployables": {
                    "javaType": "com.sos.joc.model.publish.DeployablesFilter",
                    "type": "object",
                    "anyOf": [{
                        "required": [
                            "draftConfigurations"
                        ]
                    }, {
                        "required": [
                            "deployConfigurations"
                        ]
                    }],
                    "properties": {
                        "draftConfigurations": {
                            "type": "array",
                            "items": {
                                "javaType": "com.sos.joc.model.publish.Config",
                                "type": "object",
                                "required": [
                                    "configuration"
                                ],
                                "properties": {
                                    "configuration": {
                                        "javaType": "com.sos.joc.model.publish.Configuration",
                                        "type": "object",
                                        "required": [
                                            "path",
                                            "objectType"
                                        ],
                                        "properties": {
                                            "path": {
                                                "description": "absolute path of an object.",
                                                "type": "string",
                                                "pattern": "^(/|(/[^/\\\\<>?:\"|*]+)+)$",
                                                "maxLength": 255,
                                                "minLength": 1
                                            },
                                            "objectType": {
                                                "javaType": "com.sos.joc.model.inventory.common.ConfigurationType",
                                                "type": "string",
                                                "enum": [
                                                    "FOLDER",
                                                    "WORKFLOW",
                                                    "JOBCLASS",
                                                    "JOBRESOURCE",
                                                    "LOCK",
                                                    "NOTICEBOARD",
                                                    "FILEORDERSOURCE",
                                                    "WORKINGDAYSCALENDAR",
                                                    "NONWORKINGDAYSCALENDAR",
                                                    "SCHEDULE",
                                                    "JOB"
                                                ]
                                            },
                                            "commitId": {
                                                "type": "string",
                                                "pattern": "^[^<>]*$",
                                                "maxLength": 255
                                            },
                                            "recursive": {
                                                "type": "boolean",
                                                "default": false
                                            }
                                        }
                                    }
                                }
                            }
                        },
                        "deployConfigurations": {
                            "type": "array",
                            "items": {
                                "javaType": "com.sos.joc.model.publish.Config",
                                "type": "object",
                                "required": [
                                    "configuration"
                                ],
                                "properties": {
                                    "configuration": {
                                        "javaType": "com.sos.joc.model.publish.Configuration",
                                        "type": "object",
                                        "required": [
                                            "path",
                                            "objectType"
                                        ],
                                        "properties": {
                                            "path": {
                                                "description": "absolute path of an object.",
                                                "type": "string",
                                                "pattern": "^(/|(/[^/\\\\<>?:\"|*]+)+)$",
                                                "maxLength": 255,
                                                "minLength": 1
                                            },
                                            "objectType": {
                                                "javaType": "com.sos.joc.model.inventory.common.ConfigurationType",
                                                "type": "string",
                                                "enum": [
                                                    "FOLDER",
                                                    "WORKFLOW",
                                                    "JOBCLASS",
                                                    "JOBRESOURCE",
                                                    "LOCK",
                                                    "NOTICEBOARD",
                                                    "FILEORDERSOURCE",
                                                    "WORKINGDAYSCALENDAR",
                                                    "NONWORKINGDAYSCALENDAR",
                                                    "SCHEDULE",
                                                    "JOB"
                                                ]
                                            },
                                            "commitId": {
                                                "type": "string",
                                                "pattern": "^[^<>]*$",
                                                "maxLength": 255
                                            },
                                            "recursive": {
                                                "type": "boolean",
                                                "default": false
                                            }
                                        }
                                    }
                                }
                            }
                        },
                        "withoutInvalid": {
                            "type": "boolean",
                            "default": false
                        }
                    }
                },
                "releasables": {
                    "javaType": "com.sos.joc.model.publish.ReleasablesFilter",
                    "type": "object",
                    "anyOf": [{
                        "required": [
                            "draftConfigurations"
                        ]
                    }, {
                        "required": [
                            "releasedConfigurations"
                        ]
                    }],
                    "properties": {
                        "draftConfigurations": {
                            "type": "array",
                            "items": {
                                "javaType": "com.sos.joc.model.publish.Config",
                                "type": "object",
                                "required": [
                                    "configuration"
                                ],
                                "properties": {
                                    "configuration": {
                                        "javaType": "com.sos.joc.model.publish.Configuration",
                                        "type": "object",
                                        "required": [
                                            "path",
                                            "objectType"
                                        ],
                                        "properties": {
                                            "path": {
                                                "description": "absolute path of an object.",
                                                "type": "string",
                                                "pattern": "^(/|(/[^/\\\\<>?:\"|*]+)+)$",
                                                "maxLength": 255,
                                                "minLength": 1
                                            },
                                            "objectType": {
                                                "javaType": "com.sos.joc.model.inventory.common.ConfigurationType",
                                                "type": "string",
                                                "enum": [
                                                    "FOLDER",
                                                    "WORKFLOW",
                                                    "JOBCLASS",
                                                    "JOBRESOURCE",
                                                    "LOCK",
                                                    "NOTICEBOARD",
                                                    "FILEORDERSOURCE",
                                                    "WORKINGDAYSCALENDAR",
                                                    "NONWORKINGDAYSCALENDAR",
                                                    "SCHEDULE",
                                                    "JOB"
                                                ]
                                            },
                                            "commitId": {
                                                "type": "string",
                                                "pattern": "^[^<>]*$",
                                                "maxLength": 255
                                            },
                                            "recursive": {
                                                "type": "boolean",
                                                "default": false
                                            }
                                        }
                                    }
                                }
                            }
                        },
                        "releasedConfigurations": {
                            "type": "array",
                            "items": {
                                "javaType": "com.sos.joc.model.publish.Config",
                                "type": "object",
                                "required": [
                                    "configuration"
                                ],
                                "properties": {
                                    "configuration": {
                                        "javaType": "com.sos.joc.model.publish.Configuration",
                                        "type": "object",
                                        "required": [
                                            "path",
                                            "objectType"
                                        ],
                                        "properties": {
                                            "path": {
                                                "description": "absolute path of an object.",
                                                "type": "string",
                                                "pattern": "^(/|(/[^/\\\\<>?:\"|*]+)+)$",
                                                "maxLength": 255,
                                                "minLength": 1
                                            },
                                            "objectType": {
                                                "javaType": "com.sos.joc.model.inventory.common.ConfigurationType",
                                                "type": "string",
                                                "enum": [
                                                    "FOLDER",
                                                    "WORKFLOW",
                                                    "JOBCLASS",
                                                    "JOBRESOURCE",
                                                    "LOCK",
                                                    "NOTICEBOARD",
                                                    "FILEORDERSOURCE",
                                                    "WORKINGDAYSCALENDAR",
                                                    "NONWORKINGDAYSCALENDAR",
                                                    "SCHEDULE",
                                                    "JOB"
                                                ]
                                            },
                                            "commitId": {
                                                "type": "string",
                                                "pattern": "^[^<>]*$",
                                                "maxLength": 255
                                            },
                                            "recursive": {
                                                "type": "boolean",
                                                "default": false
                                            }
                                        }
                                    }
                                }
                            }
                        },
                        "withoutInvalid": {
                            "type": "boolean",
                            "default": false
                        }
                    }
                }
            }
        },
        "exportFile": {
            "javaType": "com.sos.joc.model.publish.ExportFile",
            "type": "object",
            "required": [
                "filename",
                "format"
            ],
            "properties": {
                "filename": {
                    "type": "string",
                    "pattern": "^[^/\\<>?:\"|*]*$",
                    "maxLength": 255
                },
                "format": {
                    "javaType": "com.sos.joc.model.publish.ArchiveFormat",
                    "type": "string",
                    "enum": [
                        "ZIP",
                        "TAR_GZ"
                    ],
                    "default": "ZIP"
                }
            }
        },
        "auditLog": {
            "javaType": "com.sos.joc.model.audit.AuditParams",
            "type": "object",
            "properties": {
                "comment": {
                    "type": "string",
                    "pattern": "^[^<>]*$",
                    "maxLength": 255
                },
                "timeSpent": {
                    "type": "integer",
                    "minimum": 0
                },
                "ticketLink": {
                    "type": "string",
                    "pattern": "^[^<>]*$",
                    "maxLength": 255
                }
            }
        }
    }
}

{ "examples": [{ "example1": { "forSigning": { "controllerId": "testsuite", "deployables": { "draftConfigurations": [{ "configuration": { "path": "/myWorkflows/ifElseWorkflow/workflow_10", "objectType": "WORKFLOW" } }, { "configuration": { "path": "/myWorkflows/ifElseWorkflow/workflow_16", "objectType": "WORKFLOW" } }], "deployConfigurations": [{ "configuration": { "path": "/myWorkflows/ifElseWorkflow/workflow_12", "objectType": "WORKFLOW", "commitId": "4273b6c6-c354-4fcd-afdb-2758088abe4a" } }] } }, "exportFile": { "filename": "test_export.zip", "format": "ZIP" } } }, { "example2": { "shallowCopy": { "deployables": { "draftConfigurations": [{ "configuration": { "path": "/myWorkflows/ifElseWorkflow/workflow_10", "objectType": "WORKFLOW" } }, { "configuration": { "path": "/myWorkflows/ifElseWorkflow/workflow_16", "objectType": "WORKFLOW" } }], "deployConfigurations": [{ "configuration": { "path": "/myWorkflows/ifElseWorkflow/workflow_12", "objectType": "WORKFLOW", "commitId": "4273b6c6-c354-4fcd-afdb-2758088abe4a" } }] }, "releasables": { "draftConfigurations": [{ "configuration": { "path": "mySchedules/newSchedules/mySchedule", "objectType": "SCHEDULE" } }], "releasedConfigurations": [{ "configuration": { "path": "/myCalendars/newCalendars/myCalendar", "objectType": "WORKINGDAYSCALENDAR" } }] } }, "exportFile": { "filename": "test_export.zip", "format": "ZIP" } } }] }

{
    "examples": [{
        "example1": {
            "forSigning": {
                "controllerId": "testsuite",
                "deployables": {
                    "draftConfigurations": [{
                        "configuration": {
                            "path": "/myWorkflows/ifElseWorkflow/workflow_10",
                            "objectType": "WORKFLOW"
                        }
                    }, {
                        "configuration": {
                            "path": "/myWorkflows/ifElseWorkflow/workflow_16",
                            "objectType": "WORKFLOW"
                        }
                    }],
                    "deployConfigurations": [{
                        "configuration": {
                            "path": "/myWorkflows/ifElseWorkflow/workflow_12",
                            "objectType": "WORKFLOW",
                            "commitId": "4273b6c6-c354-4fcd-afdb-2758088abe4a"
                        }
                    }]
                }
            },
            "exportFile": {
                "filename": "test_export.zip",
                "format": "ZIP"
            }
        }
    }, {
        "example2": {
            "shallowCopy": {
                "deployables": {
                    "draftConfigurations": [{
                        "configuration": {
                            "path": "/myWorkflows/ifElseWorkflow/workflow_10",
                            "objectType": "WORKFLOW"
                        }
                    }, {
                        "configuration": {
                            "path": "/myWorkflows/ifElseWorkflow/workflow_16",
                            "objectType": "WORKFLOW"
                        }
                    }],
                    "deployConfigurations": [{
                        "configuration": {
                            "path": "/myWorkflows/ifElseWorkflow/workflow_12",
                            "objectType": "WORKFLOW",
                            "commitId": "4273b6c6-c354-4fcd-afdb-2758088abe4a"
                        }
                    }]
                },
                "releasables": {
                    "draftConfigurations": [{
                        "configuration": {
                            "path": "mySchedules/newSchedules/mySchedule",
                            "objectType": "SCHEDULE"
                        }
                    }],
                    "releasedConfigurations": [{
                        "configuration": {
                            "path": "/myCalendars/newCalendars/myCalendar",
                            "objectType": "WORKINGDAYSCALENDAR"
                        }
                    }]
                }
            },
            "exportFile": {
                "filename": "test_export.zip",
                "format": "ZIP"
            }
        }
    }]
}

Responses

Code	Description	Headers	Body
200	Content for download	Content-Disposition Content-Type	application/octet-stream
401	Unauthorized!		application/json model \| example { "title": "authentication", "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "required": [ "isAuthenticated" ], "properties": { "user": { "type": "string" }, "accessToken": { "type": "string" }, "message": { "type": "string" }, "role": { "type": "string" }, "isAuthenticated": { "type": "boolean" }, "isPermitted": { "type": "boolean", "default": false }, "sessionTimeout": { "type": "integer", "default": 1800 }, "enableTouch": { "type": "boolean", "default": true } } } { "user": "root", "message": "Oops!", "isAuthenticated": false, "isPermitted": false } { "user": "root", "message": "Oops!", "isAuthenticated": false, "isPermitted": false }
403	Forbidden! The user doesn't have sufficient permissions for 'export'		application/json model \| example { "title": "authentication", "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "required": [ "isAuthenticated" ], "properties": { "user": { "type": "string" }, "accessToken": { "type": "string" }, "message": { "type": "string" }, "role": { "type": "string" }, "isAuthenticated": { "type": "boolean" }, "isPermitted": { "type": "boolean", "default": false }, "sessionTimeout": { "type": "integer", "default": 1800 }, "enableTouch": { "type": "boolean", "default": true } } } { "user": "root", "message": "You don't have sufficient permissions for ...", "role": "all", "isAuthenticated": true, "isPermitted": false } { "user": "root", "message": "You don't have sufficient permissions for ...", "role": "all", "isAuthenticated": true, "isPermitted": false }
420	'export' failed!		application/json model \| example { "title": "error object with delivery date", "$schema": "http://json-schema.org/draft-04/schema#", "javaType": "com.sos.joc.model.common.Err420", "type": "object", "required": [ "deliveryDate", "error" ], "properties": { "deliveryDate": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" }, "surveyDate": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" }, "error": { "javaType": "com.sos.joc.model.common.Err", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } { "deliveryDate": "2016-05-05T21:13:35Z", "surveyDate": "2016-05-05T21:13:33Z", "error": { "code": "JOC-420", "message": "export failed!" } } { "deliveryDate": "2016-05-05T21:13:35Z", "surveyDate": "2016-05-05T21:13:33Z", "error": { "code": "JOC-420", "message": "export failed!" } }
440	Login Timeout! The client's session has expired and must log in again.		application/json model \| example { "title": "authentication", "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "required": [ "isAuthenticated" ], "properties": { "user": { "type": "string" }, "accessToken": { "type": "string" }, "message": { "type": "string" }, "role": { "type": "string" }, "isAuthenticated": { "type": "boolean" }, "isPermitted": { "type": "boolean", "default": false }, "sessionTimeout": { "type": "integer", "default": 1800 }, "enableTouch": { "type": "boolean", "default": true } } } { "user": "root", "message": "Session has expired. Please log in again", "role": "all", "isAuthenticated": false, "isPermitted": false } { "user": "root", "message": "Session has expired. Please log in again", "role": "all", "isAuthenticated": false, "isPermitted": false }