JOC API

/inventory/trash/restore

POST

Restore a discarded inventory object

Parameters in the POST body schema

Name	Type	Description	Example	Default
`path`	string	Path of the configuration item
`objectType`	string	Object type of the configuration item. Possible value are "FOLDER" "WORKFLOW" "JOBRESOURCE" "LOCK" "NOTICEBOARD" "FILEORDERSOURCE" "WORKINGDAYSCALENDAR" "NONWORKINGDAYSCALENDAR" "SCHEDULE" "JOBTEMPLATE" "INCLUDESCRIPT"
`newPath`	optional, string	New path (relative or absolute) of the inventory object. The `path` has to have the old path if 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 restore",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "javaType": "com.sos.joc.model.inventory.restore.RequestFilter",
    "type": "object",
    "extends": {
        "javaType": "com.sos.joc.model.inventory.common.RequestFilter",
        "type": "object",
        "anyOf": [{
            "required": [
                "id"
            ]
        }, {
            "required": [
                "path",
                "objectType"
            ]
        }],
        "properties": {
            "controllerId": {
                "type": "string",
                "pattern": "^[^/\\<>?:\"|*]*$",
                "maxLength": 100
            },
            "id": {
                "type": "number",
                "format": "utc-millisec",
                "minimum": 0
            },
            "path": {
                "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"
                ]
            },
            "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
                    }
                }
            }
        }
    },
    "anyOf": [{
        "required": [
            "id"
        ]
    }, {
        "required": [
            "path",
            "objectType"
        ]
    }],
    "properties": {
        "newPath": {
            "type": "string",
            "pattern": "^[^<>]*$",
            "maxLength": 255
        },
        "suffix": {
            "type": "string",
            "pattern": "^[^<>]*$",
            "maxLength": 100
        },
        "prefix": {
            "type": "string",
            "pattern": "^[^<>]*$",
            "maxLength": 100
        }
    }
}

{ "objectType": "WORKFLOW", "path": "/a/b/myWorkflow" }

{
    "objectType": "WORKFLOW",
    "path": "/a/b/myWorkflow"
}

Responses

Code	Description	Body
200	id path objectType	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.inventory.common.ResponseNewPath", "type": "object", "description": "response of copy, rename, restore", "required": [ "deliveryDate", "path", "objectType" ], "properties": { "deliveryDate": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" }, "id": { "type": "number", "format": "utc-millisec", "minimum": 0 }, "path": { "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" ] } } }
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 }