JOC API

/inventory/release

POST

Releases objects

Parameters in the POST body schema

Name	Type	Description	Example
`addOrdersDateFrom`	optional, string	Sets the starting date for orders to be added to the daily plan. The API accepts a date in the format YYYY-MM-DD or the string 'now' to indicate to add orders starting from the time of release. Previously planned or submitted orders will be canceled.	"addOrdersDateFrom" : "now"
`update`	optional, array	Contains releasable objects specified by its `id` or (`path` and `objectType`)	"update": [{ "path": "/eachFriday", "objectType": "WORKINGDAYSCALENDAR" }]
`path`	string	Path of the configuration item
`objectType`	string	Object type of the configuration item. Possible value are "WORKINGDAYSCALENDAR" "NONWORKINGDAYSCALENDAR" "SCHEDULE" "JOBTEMPLATE" "INCLUDESCRIPT" "REPORT"
`delete`	optional, array	Contains releasable objects specified by its `id` or (`path` and `objectType`) that release will be deleted for all controllers	"delete": [{ "path": "/eachFriday", "objectType": "WORKINGDAYSCALENDAR" }]
`path`	string	Path of the configuration item
`objectType`	string	Object type of the configuration item. Possible value are "WORKINGDAYSCALENDAR" "NONWORKINGDAYSCALENDAR" "SCHEDULE" "JOBTEMPLATE" "INCLUDESCRIPT" "REPORT"
`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": "release",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "javaType": "com.sos.joc.model.inventory.release.ReleaseFilter",
    "type": "object",
    "anyOf": [{
        "required": [
            "update"
        ]
    }, {
        "required": [
            "delete"
        ]
    }],
    "properties": {
        "update": {
            "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
                            }
                        }
                    }
                }
            }
        },
        "delete": {
            "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
                            }
                        }
                    }
                }
            }
        },
        "addOrdersDateFrom": {
            "type": "string",
            "pattern": "^[^<>]*$",
            "maxLength": 255
        },
        "includeLate": {
            "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	Confirm release 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 'release'	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 }
419	It returns an array of error items for each failed command at bulk operations.	application/json model \| { "title": "errors", "$schema": "http://json-schema.org/draft-04/schema#", "javaType": "com.sos.joc.model.common.Errs", "type": "object", "required": [ "deliveryDate", "errors" ], "properties": { "deliveryDate": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" }, "errors": { "type": "array", "items": { "javaType": "com.sos.joc.model.common.Err419", "type": "object", "required": [ "surveyDate", "path", "code", "message" ], "properties": { "surveyDate": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" }, "path": { "description": "absolute path of an object.", "type": "string", "pattern": "^(/\|(/[^/\\\\<>?:\"\|*]+)+)$", "maxLength": 255, "minLength": 1 }, "code": { "type": "string" }, "message": { "type": "string" } } } } } }
420	'release' 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": "release failed!" } } { "deliveryDate": "2016-05-05T21:13:35Z", "surveyDate": "2016-05-05T21:13:33Z", "error": { "code": "JOC-420", "message": "release 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 }