JOC API

/orders/start

POST

Starts orders

this resource can be used in the GUI for three functions

start immediatly

start at (with at)

start at parametrised (with at and params)

Parameters in the POST body schema

Name	Type	Description	Example	Default
`jobschedulerId`	required, string	JobScheduler Master ID	scheduler
`orders`	required, array	Specified the orders which should be modified.	[{ "jobChain":"/sos/reporting/Inventory", "orderId":"Inventory" "at":"now+10" }]
`at`	optional, string field of each `orders` item	start time in ISO format yyyy-mm-dd HH:MM[:SS] or now or now + HH:MM[:SS] or now + SECONDS	now+10	now
`params`	optional, array field of each `orders` item	Parameter	params:[{"name":"...","value":"..."}]
`auditLog`	optional, object	Object which contains `comment`, `timeSpent` and `ticketLink`.	{ "comment":"It was not really necessary!", "timeSpent":2 }
`comment`	optional, string	Field in `auditLog` to comment this action, e.g. the reason.
`timeSpent`	optional, string	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

access_token*

Request requires authentication!

550e8400-e29b-11d4-a716-446655440000

string

Body

application/json

model | example

{
    "title": "modify order commands",
    "id": "schemas/order/modifyOrders",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "javaType": "com.sos.joc.model.order.ModifyOrders",
    "type": "object",
    "required": [
        "jobschedulerId",
        "orders"
    ],
    "properties": {
        "jobschedulerId": {
            "type": "string"
        },
        "orders": {
            "type": "array",
            "items": {
                "id": "schemas/order/modifyOrder",
                "javaType": "com.sos.joc.model.order.ModifyOrder",
                "type": "object",
                "description": "NOTE: orderId is required too except for add order",
                "required": [
                    "jobChain"
                ],
                "properties": {
                    "orderId": {
                        "type": "string"
                    },
                    "jobChain": {
                        "id": "schemas/common/path",
                        "description": "absolute path based on live folder of a JobScheduler object.",
                        "type": "string",
                        "pattern": "/([^/]+/)*[^/]+"
                    },
                    "state": {
                        "description": "the name of the node",
                        "type": "string"
                    },
                    "endState": {
                        "description": "the name of the end node",
                        "type": "string"
                    },
                    "at": {
                        "id": "schemas/common/timestampWithNow",
                        "description": "ISO format yyyy-mm-dd HH:MM[:SS] or now or now + HH:MM[:SS] or now + SECONDS",
                        "type": "string",
                        "oneOf": [{
                            "pattern": "now(\\s*\\+\\s*(\\d+|\\d{1,2}:\\d{1,2}(:\\d{1,2})?))?"
                        }, {
                            "format": "date-time"
                        }]
                    },
                    "resume": {
                        "description": "only useful when changing order state of suspended orders",
                        "type": "boolean"
                    },
                    "removeSetback": {
                        "description": "only useful when order has a setback",
                        "type": "boolean"
                    },
                    "title": {
                        "type": "string"
                    },
                    "priority": {
                        "id": "schemas/common/nonNegativeInteger",
                        "type": "integer",
                        "minimum": 0
                    },
                    "params": {
                        "id": "schemas/common/nameValuePairs",
                        "type": "array",
                        "items": {
                            "javaType": "com.sos.joc.model.common.NameValuePair",
                            "type": "object",
                            "required": [
                                "name",
                                "value"
                            ],
                            "properties": {
                                "name": {
                                    "type": "string"
                                },
                                "value": {
                                    "type": "string"
                                }
                            }
                        }
                    },
                    "runTime": {
                        "description": "A run_time xml is expected which is specified in the <xsd:complexType name='run_time'> element of  http://www.sos-berlin.com/schema/scheduler.xsd",
                        "type": "string"
                    }
                }
            }
        },
        "auditLog": {
            "id": "schemas/common/auditParams",
            "javaType": "com.sos.joc.model.audit.AuditParams",
            "type": "object",
            "properties": {
                "comment": {
                    "type": "string"
                },
                "timeSpent": {
                    "id": "schemas/common/nonNegativeInteger",
                    "type": "integer",
                    "minimum": 0
                },
                "ticketLink": {
                    "type": "string"
                }
            }
        }
    }
}

{ "jobschedulerId": "scheduler", "orders": [{ "orderId": "order1", "jobChain": "/test/testJobChain", "at": "now" }, { "orderId": "order2", "jobChain": "/test/testJobChain", "at": "now" }, { "orderId": "order3", "jobChain": "/test/testJobChain", "at": "now" }, { "orderId": "order4", "jobChain": "/test/testJobChain", "at": "now" }, { "orderId": "order5", "jobChain": "/test/testJobChain", "at": "now" }] }

{
    "jobschedulerId": "scheduler",
    "orders": [{
        "orderId": "order1",
        "jobChain": "/test/testJobChain",
        "at": "now"
    }, {
        "orderId": "order2",
        "jobChain": "/test/testJobChain",
        "at": "now"
    }, {
        "orderId": "order3",
        "jobChain": "/test/testJobChain",
        "at": "now"
    }, {
        "orderId": "order4",
        "jobChain": "/test/testJobChain",
        "at": "now"
    }, {
        "orderId": "order5",
        "jobChain": "/test/testJobChain",
        "at": "now"
    }]
}

Responses

Code	Description	Body
200	It returns an ok. This reply code comes only for bulk operations if all commands were successful.	application/json model \| example { "title": "ok answer", "id": "schemas/common/ok", "$schema": "http://json-schema.org/draft-04/schema#", "javaType": "com.sos.joc.model.common.Ok", "type": "object", "required": [ "deliveryDate", "ok" ], "properties": { "deliveryDate": { "id": "schemas/common/deliveryDate", "description": "Current date of the JOC server/REST service. Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ", "type": "string", "format": "date-time" }, "surveyDate": { "description": "is also required for permanent or volatile requests", "type": "string", "format": "date-time" }, "ok": { "type": "boolean" } } } { "deliveryDate": "2016-05-05T21:13:35Z", "surveyDate": "2016-05-05T21:13:34Z", "ok": true } { "deliveryDate": "2016-05-05T21:13:35Z", "surveyDate": "2016-05-05T21:13:34Z", "ok": true }
401	Unauthorized!	application/json model \| example { "title": "security", "id": "schemas/user/security", "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "required": [ "isAuthenticated" ], "properties": { "user": { "type": "string" }, "accessToken": { "type": "string" }, "message": { "type": "string" }, "hasRole": { "type": "boolean", "default": false }, "isAuthenticated": { "type": "boolean" }, "isPermitted": { "type": "boolean", "default": false }, "sessionTimeout": { "type": "integer", "default": 1800 }, "enableTouch": { "type": "boolean", "default": true } } } { "user": "root", "message": "Oops!", "hasRole": false, "isAuthenticated": false, "isPermitted": false } { "user": "root", "message": "Oops!", "hasRole": false, "isAuthenticated": false, "isPermitted": false }
403	Forbidden! The user doesn't have sufficient permissions for 'start'	application/json model \| example { "title": "security", "id": "schemas/user/security", "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "required": [ "isAuthenticated" ], "properties": { "user": { "type": "string" }, "accessToken": { "type": "string" }, "message": { "type": "string" }, "hasRole": { "type": "boolean", "default": false }, "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 ...", "hasRole": false, "isAuthenticated": true, "isPermitted": false } { "user": "root", "message": "You don't have sufficient permissions for ...", "hasRole": false, "isAuthenticated": true, "isPermitted": false }
419	It returns an array of error items for each failed command at bulk operations.	application/json model \| { "title": "errors", "id": "schemas/common/errors", "$schema": "http://json-schema.org/draft-04/schema#", "javaType": "com.sos.joc.model.common.Errs", "type": "object", "required": [ "deliveryDate", "errors" ], "properties": { "deliveryDate": { "id": "schemas/common/deliveryDate", "description": "Current date of the JOC server/REST service. Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ", "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": { "id": "schemas/common/surveyDate_v", "description": "Current date of the JobScheduler Master/Agent. Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ", "type": "string", "format": "date-time" }, "path": { "id": "schemas/common/path", "description": "absolute path based on live folder of a JobScheduler object.", "type": "string", "pattern": "/([^/]+/)*[^/]+" }, "code": { "type": "string" }, "message": { "type": "string" } } } } } }
420	'start' failed!	application/json model \| example { "title": "error object with delivery date", "id": "schemas/common/error420", "$schema": "http://json-schema.org/draft-04/schema#", "javaType": "com.sos.joc.model.common.Err420", "type": "object", "required": [ "deliveryDate", "error" ], "properties": { "deliveryDate": { "id": "schemas/common/deliveryDate", "description": "Current date of the JOC server/REST service. Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ", "type": "string", "format": "date-time" }, "surveyDate": { "description": "is also required for permanent or volatile requests", "type": "string", "format": "date-time" }, "error": { "id": "schemas/common/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": "start failed!" } } { "deliveryDate": "2016-05-05T21:13:35Z", "surveyDate": "2016-05-05T21:13:33Z", "error": { "code": "JOC-420", "message": "start failed!" } }
440	Login Timeout! The client's session has expired and must log in again.	application/json model \| example { "title": "security", "id": "schemas/user/security", "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "required": [ "isAuthenticated" ], "properties": { "user": { "type": "string" }, "accessToken": { "type": "string" }, "message": { "type": "string" }, "hasRole": { "type": "boolean", "default": false }, "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", "hasRole": false, "isAuthenticated": false, "isPermitted": false } { "user": "root", "message": "Session has expired. Please log in again", "hasRole": false, "isAuthenticated": false, "isPermitted": false }