JOC API

/inventory/replace

POST

Searches/replaces names of inventory objects

Parameters in the POST body schema

Name	Type	Description	Example
`objects`	required, array[object]	Each item of this array specifies an inventory object with Either `id` or the tupel (`path` and `objectType`). `id` beats a specified `path`/`objectType` tuple
`id`	integer	ID of the inventory item
`path`	string	Path of the inventory item
`objectType`	string	Object type of the inventory item. Possible value are "WORKFLOW" "JOBRESOURCE" "LOCK" "NOTICEBOARD" "FILEORDERSOURCE" "WORKINGDAYSCALENDAR" "NONWORKINGDAYSCALENDAR" "SCHEDULE" "INCLUDESCRIPT"
`search`	required, string	Pattern (regular expression) that will be replaced by `replace`. Example to remove a "copy" suffix: "-copy[0-9]*$"
`replace`	required, string	This string replace all matches from the `search`. Up to nine groups can be addressed with $1, ..., $9
`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 replace",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "javaType": "com.sos.joc.model.inventory.replace.RequestFilters",
    "type": "object",
    "extends": {
        "javaType": "com.sos.joc.model.inventory.common.RequestFilters",
        "type": "object",
        "required": [
            "objects"
        ],
        "properties": {
            "objects": {
                "type": "array",
                "uniqueItems": true,
                "minItems": 1,
                "items": {
                    "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
                                }
                            }
                        }
                    }
                }
            },
            "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
                    }
                }
            }
        }
    },
    "required": [
        "objects",
        "search",
        "replace"
    ],
    "properties": {
        "search": {
            "type": "string",
            "pattern": "^[^/]*$",
            "minLength": 1
        },
        "replace": {
            "type": "string",
            "pattern": "^[^/]*$"
        }
    }
}

{ "objects": [{ "objectType": "WORKFLOW", "path": "/a/b/myWorkflow" }], "search": "-copy[0-9]*$", "replace": "" }

{
    "objects": [{
        "objectType": "WORKFLOW",
        "path": "/a/b/myWorkflow"
    }],
    "search": "-copy[0-9]*$",
    "replace": ""
}

Responses

Code	Description	Body
200	Confirm replace 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 'replace'	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	'replace' 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": "replace failed!" } } { "deliveryDate": "2016-05-05T21:13:35Z", "surveyDate": "2016-05-05T21:13:33Z", "error": { "code": "JOC-420", "message": "replace 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 }