JOC API

/daily_plan/orders/modify

POST

Modifies Orders for the daily plan

Parameters in the POST body schema

Name	Type	Description	Example	Default
`controllerId`	required, string	Controller ID	myController
`scheduledFor`	optional, string	A start time in ISO format "yyyy-mm-dd HH:MM[:SS]" or "now" or "now + HH:MM[:SS]" or "now + SECONDS" or "never" is expected	now+10
`timeZone`	optional, string	This parameter set the time zone for the time stamp in the `scheduledFor` parameter. See here the list for available time zones.	Europe/Berlin	Etc/UTC
`cycle`	optional, string	For cyclic orders the cycle will be defined with begin, end and repeat attribute. The values have to have the format hh:mm:ss	begin: 00:00:00 end: 20:00:00 repeat: 00:10:00
`variables`	optional, object	An object with key-value pairs for the order. The value can be a string, number or boolean. The variables that already exist will be updated with the new values. The variables that do not exist will be added. To remove variables use the removeVariables array.	"variables":{ "myString": "stringValue", "myNumber": 3.14, "myBoolean": true }
`removeVariables`	optional, object	An object with key-value pairs for the order. The value can be a string, number or boolean. The given Variables will be removed.	"removeVariables":{ "myString": "stringValue", "myNumber": 3.14, "myBoolean": true }
`orderIds`	optional; array[string]	Filters all orders in the given daily plan that have one of the order IDs in the given list of orderIds.	["#2020-09-15#P0000000046-myOrderName"]
`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": "Daily Plan Change Startime",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "javaType": "com.sos.joc.model.dailyplan.DailyPlanModifyOrder",
    "type": "object",
    "description": "To change the starttime of given order",
    "properties": {
        "controllerId": {
            "type": "string",
            "pattern": "^[^/\\<>?:\"|*]*$",
            "maxLength": 100
        },
        "scheduledFor": {
            "description": "ISO format yyyy-mm-dd HH:MM[:SS] or now or now + HH:MM[:SS] or now + SECONDS or empty",
            "type": "string",
            "pattern": "^(now(\\s*\\+\\s*(\\d{1,2}:\\d{1,2}(:\\d{1,2})?|\\d+)?)?||never|\\d{4}-\\d{2}-\\d{2}\\s\\d{1,2}:\\d{1,2}(:\\d{1,2})?)$"
        },
        "cycle": {
            "type": "object",
            "javaType": "com.sos.joc.model.dailyplan.Cycle",
            "properties": {
                "begin": {
                    "type": "string",
                    "pattern": "^[0-9:]*$"
                },
                "end": {
                    "type": "string",
                    "pattern": "^[0-9:]*$"
                },
                "repeat": {
                    "type": "string",
                    "pattern": "^[0-9:]*$"
                }
            }
        },
        "timeZone": {
            "type": "string",
            "pattern": "^[^<>]*$",
            "maxLength": 255
        },
        "variables": {
            "description": "a map for arbitrary key-value pairs",
            "javaType": "com.sos.inventory.model.common.Variables",
            "type": "object",
            "additionalProperties": true
        },
        "removeVariables": {
            "description": "a map for arbitrary key-value pairs",
            "javaType": "com.sos.inventory.model.common.Variables",
            "type": "object",
            "additionalProperties": true
        },
        "orderIds": {
            "type": "array",
            "items": {
                "type": "string"
            }
        },
        "dailyPlanDate": {
            "description": "ISO date YYYY-MM-DD",
            "type": "string",
            "format": "date"
        },
        "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
                }
            }
        }
    }
}

Responses

Code	Description	Body
200	This API changes the OrderId. For ad hoc orders, a map in the form `"oldOrderId": "newOrderId"` is returned.	application/json model \| example { "title": "OrderIdMap", "$schema": "http://json-schema.org/draft-04/schema#", "javaType": "com.sos.joc.model.order.OrderIdMap200", "type": "object", "required": [ "deliveryDate" ], "properties": { "deliveryDate": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" }, "orderIds": { "type": "object", "javaType": "com.sos.joc.model.order.OrderIdMap", "additionalProperties": { "type": "string" } } }, "additionalProperties": false } { "deliveryDate": "2022-01-11T20:53:45.214+0000", "orderIds": { "#2022-01-11#T93402688601-root": "#2022-01-11#T93441726300-root" } } { "deliveryDate": "2022-01-11T20:53:45.214+0000", "orderIds": { "#2022-01-11#T93402688601-root": "#2022-01-11#T93441726300-root" } }
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 'modify'	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	'modify' 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": "modify failed!" } } { "deliveryDate": "2016-05-05T21:13:35Z", "surveyDate": "2016-05-05T21:13:33Z", "error": { "code": "JOC-420", "message": "modify 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 }