JOC API

/descriptor/trash/restore

POST

Restore a discarded inventory object

Parameters in the POST body schema

Name	Type	Description	Example	Default
`path`	required, string	Path or name of the deployment descriptor
`objectType`	required, string	Object type of the configuration item. Possible value are "DEPLOYMENTDESCRIPTOR" "DESCRIPTORFOLDER"
`newPath`	optional, string	New path (relative or absolute) of the deployment descriptor. The `path`property has to hold the value of the old path if `newPath` is specified		`path`
`suffix`	optional, string	Restored objects are given new names. A `suffix` or `prefix` can be specified for objects to be restored. If a `suffix` is specified then a `prefix` will be ignored A leading dash is added to a `suffix` programmatically A `prefix` is programmatically followed by a dash at the end If `suffix` and `prefix` are empty, then a `suffix`="-restored<integer>" is used, where <integer> is the smallest natural number that ensures the uniqueness of the names of the restored objects.
`prefix`	optional, string
`auditLog`	optional, object	Object that contains `comment`, `timeSpent` and `ticketLink`.	{ "comment": "Operational requirement!", "timeSpent": 2 }
`comment`	optional, string	Field in `auditLog` to comment this action, e.g. the reason.
`timeSpent`	optional, integer	Field in `auditLog` to enter the time spent in minutes.
`ticketLink`	optional, string	Field in `auditLog` to enter a link to a corresponding ticket.

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": "filter for descriptor restore",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "javaType": "com.sos.joc.model.descriptor.restore.RequestFilter",
    "type": "object",
    "extends": {
        "javaType": "com.sos.joc.model.descriptor.common.RequestFilter",
        "type": "object",
        "required": [
            "path"
        ],
        "properties": {
            "path": {
                "type": "string",
                "pattern": "^[^<>]*$",
                "maxLength": 255,
                "minLength": 1
            },
            "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
                    }
                }
            }
        }
    },
    "required": [
        "path",
        "objectType"
    ],
    "properties": {
        "newPath": {
            "type": "string",
            "pattern": "^[^<>]*$",
            "maxLength": 255
        },
        "objectType": {
            "javaType": "com.sos.joc.model.inventory.common.ConfigurationType",
            "type": "string",
            "enum": [
                "FOLDER",
                "WORKFLOW",
                "JOBCLASS",
                "JOBRESOURCE",
                "LOCK",
                "NOTICEBOARD",
                "FILEORDERSOURCE",
                "WORKINGDAYSCALENDAR",
                "NONWORKINGDAYSCALENDAR",
                "SCHEDULE",
                "INCLUDESCRIPT",
                "JOBTEMPLATE",
                "DEPLOYMENTDESCRIPTOR",
                "DESCRIPTORFOLDER"
            ]
        },
        "suffix": {
            "type": "string",
            "pattern": "^[^<>]*$",
            "maxLength": 100
        },
        "prefix": {
            "type": "string",
            "pattern": "^[^<>]*$",
            "maxLength": 100
        }
    }
}

{ "objectType": "DEPLOYMENTDESCRIPTOR", "path": "/a/b/myDescriptor" }

{
    "objectType": "DEPLOYMENTDESCRIPTOR",
    "path": "/a/b/myDescriptor"
}

Responses

Code	Description	Body
200		application/json model \| example { "title": "path of copied, restored or renamed object/folder", "$schema": "http://json-schema.org/draft-04/schema#", "javaType": "com.sos.joc.model.descriptor.common.ResponseRenamed", "type": "object", "description": "response of copy-, rename- and restore requests", "required": [ "deliveryDate", "path" ], "properties": { "deliveryDate": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" }, "path": { "type": "string", "pattern": "^[^<>]*$", "maxLength": 255 } } }
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 'restore'	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	'restore' 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": "restore failed!" } } { "deliveryDate": "2016-05-05T21:13:35Z", "surveyDate": "2016-05-05T21:13:33Z", "error": { "code": "JOC-420", "message": "restore 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 }