JOC API

/inventory/change/remove

POST

removes Inventory objects from a given change

Parameters in the POST body schema

Name	Type	Description	Example
`change`	required, object	A change object specified by its name.
`name`	required, string	The name of the desired change.	"name" : "myFirstChange"
`remove`	required, array	An array of inventory objects that should be removed from the given change.
`name`	required, string	The name of the desired inventory object to be removed from the given change.	"name" : "myWorkflow"
`objectType`	required, string	available types are: "WORKFLOW" "JOBRESOURCE" "LOCK" "NOTICEBOARD" "FILEORDERSOURCE" "WORKINGDAYSCALENDAR" "NONWORKINGDAYSCALENDAR" "SCHEDULE" "JOBTEMPLATE"	"type" : "WORKFLOW"
`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": "changes",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "javaType": "com.sos.joc.model.inventory.changes.RemoveFromChangeRequest",
    "type": "object",
    "required": [
        "change",
        "remove"
    ],
    "properties": {
        "change": {
            "javaType": "com.sos.joc.model.inventory.changes.common.Change",
            "type": "object",
            "extends": {
                "javaType": "com.sos.joc.model.inventory.changes.common.ChangeIdentifier",
                "type": "object",
                "required": [
                    "name"
                ],
                "properties": {
                    "name": {
                        "type": "string",
                        "pattern": "^[^<>]*$",
                        "maxLength": 100
                    },
                    "title": {
                        "type": "string",
                        "pattern": "^[^<>]*$",
                        "maxLength": 255
                    },
                    "state": {
                        "javaType": "com.sos.joc.model.inventory.changes.common.ChangeState",
                        "type": "string",
                        "enum": [
                            "OPEN",
                            "CLOSED",
                            "PUBLISHED"
                        ]
                    }
                },
                "additionalProperties": false
            },
            "required": [
                "name"
            ],
            "properties": {
                "created": {
                    "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty",
                    "type": "string",
                    "format": "date-time"
                },
                "modified": {
                    "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty",
                    "type": "string",
                    "format": "date-time"
                },
                "closed": {
                    "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty",
                    "type": "string",
                    "format": "date-time"
                },
                "owner": {
                    "type": "string",
                    "pattern": "^[^<>]*$",
                    "maxLength": 255
                },
                "lastPublishedBy": {
                    "type": "string",
                    "pattern": "^[^<>]*$",
                    "maxLength": 255
                },
                "configurations": {
                    "type": "array",
                    "uniqueItems": true,
                    "items": {
                        "javaType": "com.sos.joc.model.inventory.changes.common.ChangeItem",
                        "type": "object",
                        "properties": {
                            "name": {
                                "type": "string",
                                "pattern": "^[^<>]*$",
                                "maxLength": 255
                            },
                            "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",
                                    "INCLUDESCRIPT",
                                    "JOBTEMPLATE",
                                    "DEPLOYMENTDESCRIPTOR",
                                    "DESCRIPTORFOLDER"
                                ]
                            }
                        },
                        "additionalProperties": false
                    }
                }
            },
            "additionalProperties": false
        },
        "remove": {
            "type": "array",
            "minItems": 1,
            "items": {
                "javaType": "com.sos.joc.model.inventory.changes.common.ChangeItem",
                "type": "object",
                "properties": {
                    "name": {
                        "type": "string",
                        "pattern": "^[^<>]*$",
                        "maxLength": 255
                    },
                    "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",
                            "INCLUDESCRIPT",
                            "JOBTEMPLATE",
                            "DEPLOYMENTDESCRIPTOR",
                            "DESCRIPTORFOLDER"
                        ]
                    }
                },
                "additionalProperties": false
            }
        }
    },
    "additionalProperties": false
}

{ "change": { "name": "myFirstChange" }, "remove": [{ "name": "wf_test_2_expect", "objectType": "WORKFLOW" }, { "name": "wf_lock_test", "objectType": "WORKFLOW" }, { "name": "not_available", "objectType": "WORKFLOW" }] }

{
    "change": {
        "name": "myFirstChange"
    },
    "remove": [{
        "name": "wf_test_2_expect",
        "objectType": "WORKFLOW"
    }, {
        "name": "wf_lock_test",
        "objectType": "WORKFLOW"
    }, {
        "name": "not_available",
        "objectType": "WORKFLOW"
    }]
}

Responses

Code	Description	Body
200	Confirm remove successfully	application/json model \| example { "title": "ok answer", "$schema": "http://json-schema.org/draft-04/schema#", "javaType": "com.sos.joc.model.common.Ok", "type": "object", "required": [ "deliveryDate", "ok" ], "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" }, "ok": { "type": "boolean" } } } { "deliveryDate": "2020-05-05T21:13:35Z", "ok": true } { "deliveryDate": "2020-05-05T21:13:35Z", "ok": true }
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 'remove'	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	'remove' 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": "remove failed!" } } { "deliveryDate": "2016-05-05T21:13:35Z", "surveyDate": "2016-05-05T21:13:33Z", "error": { "code": "JOC-420", "message": "remove 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 }