JOC API

/inventory/delete_draft/folder

POST

Reverts draft configuration of inventory objects by folder

Parameters in the POST body schema

Name	Type	Description	Example
`path`	required, string	Path of a folder
`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 of a folder",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "javaType": "com.sos.joc.model.inventory.common.RequestFolder",
    "type": "object",
    "required": [
        "path"
    ],
    "properties": {
        "controllerId": {
            "type": "string",
            "pattern": "^[^/\\<>?:\"|*]*$",
            "maxLength": 100
        },
        "path": {
            "description": "absolute path of an object.",
            "type": "string",
            "pattern": "^(/|(/[^/\\\\<>?:\"|*]+)+)$",
            "maxLength": 255,
            "minLength": 1
        },
        "recursive": {
            "type": "boolean",
            "default": false
        },
        "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",
                    "JOBTEMPLATE"
                ]
            }
        },
        "onlyValidObjects": {
            "type": "boolean",
            "default": false
        },
        "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
                }
            }
        }
    }
}

TODO

TODO

Responses

Code	Description	Body
200		application/json model \| example { "title": "response Delete Draft", "$schema": "http://json-schema.org/draft-04/schema#", "javaType": "com.sos.joc.model.inventory.delete.ResponseItem", "type": "object", "properties": { "deliveryDate": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" }, "updated": { "type": "array", "items": { "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 } } } } } }, "deleted": { "type": "array", "items": { "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 } } } } } } } } { "deleted": [{ "id": 30, "objectType": "WORKFLOW", "path": "/a/b/workflow1" }, { "id": 35, "objectType": "WORKINGDAYSCALENDAR", "path": "/a/b/calendar1" }, { "id": 9, "objectType": "WORKFLOW", "path": "/a/b/workflow2" }, { "id": 29, "objectType": "WORKFLOW", "path": "/a/b/c/workflow3" }, { "id": 28, "objectType": "FOLDER", "path": "/a/b/c" }, { "id": 27, "objectType": "FOLDER", "path": "/a/b" }], "deliveryDate": "2021-01-15T12:27:08.98Z", "updated": [] } { "deleted": [{ "id": 30, "objectType": "WORKFLOW", "path": "/a/b/workflow1" }, { "id": 35, "objectType": "WORKINGDAYSCALENDAR", "path": "/a/b/calendar1" }, { "id": 9, "objectType": "WORKFLOW", "path": "/a/b/workflow2" }, { "id": 29, "objectType": "WORKFLOW", "path": "/a/b/c/workflow3" }, { "id": 28, "objectType": "FOLDER", "path": "/a/b/c" }, { "id": 27, "objectType": "FOLDER", "path": "/a/b" }], "deliveryDate": "2021-01-15T12:27:08.98Z", "updated": [] }
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 }