JOC API

/inventory/copy

POST

Copies inventory object

Parameters in the POST body schema

Name	Type	Description	Example	Default
	Either `id` or (`path` and `objectType`) are required! `id` beats a specified `path`/`objectType` tuple
`id`	integer	ID of the configuration item
`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" "INCLUDESCRIPT"
`newPath`	required, string	New path (relative or absolute) of the inventory object. The `path` has to have the old path if specified
`shallowCopy`	optional, boolean	Shallow Copy (this parameter is true) References to existing objects are retained. For objects that do not contain references, copying should be omitted, e.g. for Locks, because with Shallow Copy no copied Workflow would reference the copied Lock. Therefore: Shallow Copy copies objects that contain references, currently Workflows, Schedules. If a single object is copied, then a copy is always made, even for objects that do not contain references. If folders are copied, then objects are not copied unless they contain references. Deep Copy (this parameter is false) All objects are copied, without exception. All existing references to objects are updated with regard to the copied objects. If, for example, a workflow references a Lock that is not itself the object of the copy operation, the previous reference is retained. If, on the other hand, the referenced Lock is also copied, then the reference in the Workflow is updated.		false
`suffix`	optional, string	Copied objects are given new names. A `suffix` or `prefix` can be specified for objects to be copied. 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`="-copy<integer>" is used if necessary, where <integer> is the smallest natural number that ensures the uniqueness of the names of the copied 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.	5
`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 copy",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "javaType": "com.sos.joc.model.inventory.copy.RequestFilter",
    "type": "object",
    "extends": {
        "javaType": "com.sos.joc.model.inventory.common.RequestFilter",
        "type": "object",
        "anyOf": [{
            "required": [
                "id"
            ]
        }, {
            "required": [
                "path",
                "objectType"
            ]
        }],
        "properties": {
            "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",
                    "JOB"
                ]
            },
            "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",
            "newPath"
        ]
    }, {
        "required": [
            "path",
            "objectType",
            "newPath"
        ]
    }],
    "properties": {
        "newPath": {
            "type": "string",
            "pattern": "^[^<>]*$",
            "maxLength": 255
        },
        "suffix": {
            "type": "string",
            "pattern": "^[^<>]*$",
            "maxLength": 100
        },
        "prefix": {
            "type": "string",
            "pattern": "^[^<>]*$",
            "maxLength": 100
        },
        "shallowCopy": {
            "type": "boolean",
            "default": false
        }
    }
}

{ "objectType": "FOLDER", "path": "/test3", "newPath": "test4" }

{
    "objectType": "FOLDER",
    "path": "/test3",
    "newPath": "test4"
}

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", "JOB" ] } } }
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 'copy'	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	'copy' 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": "copy failed!" } } { "deliveryDate": "2016-05-05T21:13:35Z", "surveyDate": "2016-05-05T21:13:33Z", "error": { "code": "JOC-420", "message": "copy 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 }