JOC API

/inventory/export/folder

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_folder.zip", "format" : "ZIP" }
`filename`	required, string		"filename" : "test_export_folder.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
`forSigning`	required oneOf(`forSigning`, `shallowCopy`), object	Object consists of a `controllerId`, an array of `objectTypes`, an array of `folders` and additional booleans for information on how to filter.	"forSigning" : { "controllerId" : "testsuite", "objectTypes" : [ "WORKFLOW", "FILEORDERSOURCE", "JOBRESOURCE", "LOCK" ], "folders" : [ "/JS7Demo", "/Examples.Unix" ], "recursive" : true, "withoutDrafts" : false, "withoutDeployed" : false } }
`controllerId`	required, string	ControllerId of the controller already deployed configurations have been deployed to.	"controllerId" : "testsuite"
`objectTypes`	required, array	An array defining a subset of Configuration Types the specified folders should bw filtered with. Only deployable Configuration Types are allowed.	"objectTypes" : [ "WORKFLOW", "FILEORDERSOURCE", "JOBRESOURCE", "LOCK" ]
`folders`	required, array	An array of paths of folders containing the configurations to export.	"folders" : [ "/JS7Demo", "/Examples.Unix" ]
`recursive`	optional, boolean	A switch to determine if the specified folders should be read recursively.	"recursive" : true	false
`withoutDrafts`	optional, boolean	Determines if draft configurations are excluded from export.	"withoutDrafts" : false	false
`withoutDeployed`	optional, boolean	Determines if already deployed configurations are excluded from export.	"withoutDeployed" : false	false
`shallowCopy`	required oneOf(`forSigning`, `shallowCopy`), object	Object consists of an array of `objectTypes`, an array of `folders` and additional booleans for information on how to filter..	"shallowCopy" : { "objectTypes" : [ "WORKFLOW", "FILEORDERSOURCE", "JOBRESOURCE", "LOCK", "WORKINGDAYSCALENDAR", "SCHEDULE", "JOBTEMPLATE", "INCLUDESCRIPT" ], "folders" : [ "/JS7Demo", "/Examples.Unix" ], "recursive" : true, "onlyValidObjects" : false, "withoutDrafts" : false, "withoutDeployed" : false, "withoutReleased" : false }
`objectTypes`	required, array	An array defining a subset of Configuration Types the specified folders should bw filtered with. Releaseable and deployable Configuration Types are allowed.	"objectTypes" : [ "WORKFLOW", "FILEORDERSOURCE", "JOBRESOURCE", "LOCK", "WORKINGDAYSCALENDAR", "SCHEDULE", "JOBTEMPLATE", "INCLUDESCRIPT" ]
`folders`	required, array	An array of paths of folders containing the configurations to export.	"folders" : [ "/JS7Demo", "/Examples.Unix" ]
`recursive`	optional, boolean	A switch to determine if the specified folders should be read recursively.	"recursive" : true	false
`onlyValidObjects`	optional, boolean	Determines if invalid draft configurations are excluded from export.	"onlyValidObjects" : false	false
`withoutDrafts`	optional, boolean	Determines if draft configurations are excluded from export.	"withoutDrafts" : false	false
`withoutDeployed`	optional, boolean	Determines if already deployed configurations are excluded from export.	"withoutDeployed" : false	false
`withoutReleased`	optional, boolean	Determines if already released configurations are excluded from export.	"withoutReleased" : false	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": "ExportFolderFilter",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "javaType": "com.sos.joc.model.publish.folder.ExportFolderFilter",
    "type": "object",
    "oneOf": [{
        "required": [
            "forSigning",
            "exportFile"
        ]
    }, {
        "required": [
            "shallowCopy",
            "exportFile"
        ]
    }],
    "properties": {
        "useShortPath": {
            "type": "boolean",
            "default": false
        },
        "forSigning": {
            "javaType": "com.sos.joc.model.publish.folder.ExportFolderForSigning",
            "type": "object",
            "required": [
                "controllerId",
                "objectTypes",
                "folders"
            ],
            "properties": {
                "controllerId": {
                    "type": "string",
                    "pattern": "^[^<>]*$",
                    "maxLength": 255
                },
                "objectTypes": {
                    "type": "array",
                    "items": {
                        "javaType": "com.sos.joc.model.inventory.common.ConfigurationType",
                        "type": "string",
                        "enum": [
                            "FOLDER",
                            "WORKFLOW",
                            "JOBCLASS",
                            "JOBRESOURCE",
                            "LOCK",
                            "NOTICEBOARD",
                            "FILEORDERSOURCE",
                            "WORKINGDAYSCALENDAR",
                            "NONWORKINGDAYSCALENDAR",
                            "SCHEDULE",
                            "INCLUDESCRIPT",
                            "JOB"
                        ]
                    }
                },
                "folders": {
                    "type": "array",
                    "items": {
                        "description": "absolute path of an object.",
                        "type": "string",
                        "pattern": "^(/|(/[^/\\\\<>?:\"|*]+)+)$",
                        "maxLength": 255,
                        "minLength": 1
                    }
                },
                "recursive": {
                    "type": "boolean",
                    "default": false
                },
                "withoutDrafts": {
                    "type": "boolean",
                    "default": false
                },
                "withoutDeployed": {
                    "type": "boolean",
                    "default": false
                }
            }
        },
        "shallowCopy": {
            "javaType": "com.sos.joc.model.publish.folder.ExportFolderShallowCopy",
            "type": "object",
            "required": [
                "objectTypes",
                "folders"
            ],
            "properties": {
                "objectTypes": {
                    "type": "array",
                    "items": {
                        "javaType": "com.sos.joc.model.inventory.common.ConfigurationType",
                        "type": "string",
                        "enum": [
                            "FOLDER",
                            "WORKFLOW",
                            "JOBCLASS",
                            "JOBRESOURCE",
                            "LOCK",
                            "NOTICEBOARD",
                            "FILEORDERSOURCE",
                            "WORKINGDAYSCALENDAR",
                            "NONWORKINGDAYSCALENDAR",
                            "SCHEDULE",
                            "INCLUDESCRIPT",
                            "JOB"
                        ]
                    }
                },
                "folders": {
                    "type": "array",
                    "items": {
                        "description": "absolute path of an object.",
                        "type": "string",
                        "pattern": "^(/|(/[^/\\\\<>?:\"|*]+)+)$",
                        "maxLength": 255,
                        "minLength": 1
                    }
                },
                "recursive": {
                    "type": "boolean",
                    "default": false
                },
                "onlyValidObjects": {
                    "type": "boolean",
                    "default": false
                },
                "withoutDrafts": {
                    "type": "boolean",
                    "default": false
                },
                "withoutDeployed": {
                    "type": "boolean",
                    "default": false
                },
                "withoutReleased": {
                    "type": "boolean",
                    "default": false
                }
            }
        },
        "exportFile": {
            "javaType": "com.sos.joc.model.publish.ExportFile",
            "type": "object",
            "required": [
                "filename"
            ],
            "properties": {
                "filename": {
                    "type": "string",
                    "pattern": "^[^/\\<>?:\"|*]*$",
                    "maxLength": 255,
                    "minLength": 1
                },
                "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
                }
            }
        }
    }
}

{ "forSigning": { "controllerId": "testsuite", "objectTypes": ["WORKFLOW", "FILEORDERSOURCE", "JOBRESOURCE", "LOCK"], "folders": ["/JS7Demo", "/Examples.Unix"], "recursive": true, "withoutDrafts": false, "withoutDeployed": false }, "exportFile": { "filename": "test_export_folder.zip", "format": "ZIP" } }

{
    "forSigning": {
        "controllerId": "testsuite",
        "objectTypes": ["WORKFLOW", "FILEORDERSOURCE", "JOBRESOURCE", "LOCK"],
        "folders": ["/JS7Demo", "/Examples.Unix"],
        "recursive": true,
        "withoutDrafts": false,
        "withoutDeployed": false
    },
    "exportFile": {
        "filename": "test_export_folder.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 'folder'		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	'folder' 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": "folder failed!" } } { "deliveryDate": "2016-05-05T21:13:35Z", "surveyDate": "2016-05-05T21:13:33Z", "error": { "code": "JOC-420", "message": "folder 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 }