JOC API

/jobscheduler/switch

POST

Send a JobScheduler Id when the user switches the JobScheduler

Parameters in the POST body schema

Name	Type	Description	Example	Default
`jobschedulerId`	required, string	JobScheduler Master ID	scheduler

Request

Name

Description

Example

Type

Constraints

Default

Headers

X-Access-Token*

Request requires authentication!

550e8400-e29b-11d4-a716-446655440000

string

access_token*

Request requires authentication! This header is deprecated. Please use X-Access-Token

550e8400-e29b-11d4-a716-446655440000

string

Body

application/json

model | example

{
    "title": "JobScheduler id",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "javaType": "com.sos.joc.model.common.JobSchedulerId",
    "type": "object",
    "properties": {
        "jobschedulerId": {
            "type": "string",
            "pattern": "^[^<>]*$",
            "maxLength": 100
        }
    }
}

{ "jobschedulerId": "scheduler" }

{
    "jobschedulerId": "scheduler"
}

Responses

Code	Description	Body
200		application/json model \| example { "title": "permissions", "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "required": [ "isAuthenticated" ], "properties": { "isAuthenticated": { "type": "boolean" }, "user": { "type": "string" }, "accessToken": { "type": "string" }, "JobschedulerMaster": { "type": "object", "properties": { "view": { "type": "object", "properties": { "status": { "type": "boolean", "default": false }, "mainlog": { "type": "boolean", "default": false } } }, "pause": { "type": "boolean", "default": false }, "continue": { "type": "boolean", "default": false }, "terminate": { "type": "boolean", "default": false }, "abort": { "type": "boolean", "default": false }, "restart": { "type": "object", "properties": { "terminate": { "type": "boolean", "default": false }, "abort": { "type": "boolean", "default": false } } }, "manageCategories": { "type": "boolean", "default": false } } }, "JobschedulerMasterCluster": { "type": "object", "properties": { "view": { "type": "object", "properties": { "clusterStatus": { "type": "boolean", "default": false } } }, "terminate": { "type": "boolean", "default": false }, "terminateFailSafe": { "type": "boolean", "default": false }, "restart": { "type": "boolean", "default": false } } }, "JobschedulerUniversalAgent": { "type": "object", "properties": { "view": { "type": "object", "properties": { "status": { "type": "boolean", "default": false } } }, "terminate": { "type": "boolean", "default": false }, "abort": { "type": "boolean", "default": false }, "restart": { "type": "object", "properties": { "terminate": { "type": "boolean", "default": false }, "abort": { "type": "boolean", "default": false } } } } }, "DailyPlan": { "type": "object", "properties": { "view": { "type": "object", "properties": { "status": { "type": "boolean", "default": false } } } } }, "History": { "type": "object", "properties": { "view": { "type": "object", "properties": { "status": { "type": "boolean", "default": false } } } } }, "Order": { "type": "object", "properties": { "view": { "type": "object", "properties": { "status": { "type": "boolean", "default": false }, "configuration": { "type": "boolean", "default": false }, "history": { "type": "boolean", "default": false }, "orderLog": { "type": "boolean", "default": false } } }, "start": { "type": "boolean", "default": false }, "update": { "type": "boolean", "default": false }, "suspend": { "type": "boolean", "default": false }, "resume": { "type": "boolean", "default": false }, "delete": { "type": "object", "properties": { "permanent": { "type": "boolean", "default": false }, "temporary": { "type": "boolean", "default": false } } }, "removeSetback": { "type": "boolean", "default": false } } }, "JobChain": { "type": "object", "properties": { "view": { "type": "object", "properties": { "status": { "type": "boolean", "default": false }, "configuration": { "type": "boolean", "default": false }, "history": { "type": "boolean", "default": false } } }, "stop": { "type": "boolean", "default": false }, "unstop": { "type": "boolean", "default": false }, "skipJobChainNode": { "type": "boolean", "default": false }, "unskipJobChainNode": { "type": "boolean", "default": false }, "stopJobChainNode": { "type": "boolean", "default": false }, "unstopJobChainNode": { "type": "boolean", "default": false } } }, "Job": { "type": "object", "properties": { "view": { "type": "object", "properties": { "status": { "type": "boolean", "default": false }, "configuration": { "type": "boolean", "default": false }, "history": { "type": "boolean", "default": false }, "taskLog": { "type": "boolean", "default": false } } }, "start": { "type": "boolean", "default": false }, "stop": { "type": "boolean", "default": false }, "unstop": { "type": "boolean", "default": false }, "terminate": { "type": "boolean", "default": false }, "kill": { "type": "boolean", "default": false }, "history": { "type": "boolean", "default": false } } }, "ProcessClass": { "type": "object", "properties": { "view": { "type": "object", "properties": { "status": { "type": "boolean", "default": false }, "configuration": { "type": "boolean", "default": false } } } } }, "Schedule": { "type": "object", "properties": { "view": { "type": "object", "properties": { "status": { "type": "boolean", "default": false }, "configuration": { "type": "boolean", "default": false } } }, "edit": { "type": "boolean", "default": false }, "addSubstitute": { "type": "boolean", "default": false } } }, "Lock": { "type": "object", "properties": { "view": { "type": "object", "properties": { "status": { "type": "boolean", "default": false }, "configuration": { "type": "boolean", "default": false } } } } }, "Event": { "type": "object", "properties": { "view": { "type": "object", "properties": { "status": { "type": "boolean", "default": false } } }, "delete": { "type": "boolean", "default": false } } }, "EventAction": { "type": "object", "properties": { "view": { "type": "object", "properties": { "status": { "type": "boolean", "default": false } } }, "createEventsManually": { "type": "boolean", "default": false } } }, "HolidayCalendar": { "type": "object", "properties": { "view": { "type": "object", "properties": { "status": { "type": "boolean", "default": false } } } } }, "MaintenanceWindow": { "type": "object", "properties": { "view": { "type": "object", "properties": { "status": { "type": "boolean", "default": false } } }, "enableDisableMaintenanceWindow": { "type": "boolean", "default": false } } }, "AuditLog": { "type": "object", "properties": { "view": { "type": "object", "properties": { "status": { "type": "boolean", "default": false } } } } }, "SOSPermissionRoles": { "type": "object", "properties": { "SOSPermissionRole": { "type": "array", "items": { "description": "possible values are 'application_manager','it_operator','incident_manager','business_user'", "type": "string" } } } } } } { "isAuthenticated": true, "user": "root", "accessToken": "41de2635-0f0e-4a39-b247-6936e237ca5f", "JobschedulerMaster": { "view": { "status": true, "mainlog": true }, "pause": true, "continue": true, "terminate": true, "abort": true, "restart": { "terminate": true, "abort": true }, "manageCategories": true }, "JobschedulerMasterCluster": { "view": { "clusterStatus": true }, "terminate": true, "terminateFailSafe": true, "restart": true }, "JobschedulerUniversalAgent": { "view": { "status": true }, "terminate": true, "abort": true, "restart": { "terminate": true, "abort": true } }, "DailyPlan": { "view": { "status": true } }, "History": { "view": true }, "Order": { "view": { "configuration": true, "history": true, "orderLog": true, "status": true }, "change": { "startAndEndNode": true, "timeForAdhocOrder": true, "parameter": true }, "start": true, "update": true, "suspend": true, "resume": true, "delete": { "permanent": true, "temporary": true }, "removeSetback": true }, "JobChain": { "view": { "configuration": true, "history": true, "status": true }, "stop": true, "unstop": true, "addOrder": true, "skipJobChainNode": true, "unskipJobChainNode": true, "stopJobChainNode": true, "unstopJobChainNode": true }, "Job": { "view": { "status": true, "taskLog": true, "configuration": true, "history": true }, "start": { "task": true, "taskImmediate": true }, "stop": true, "unstop": true, "terminate": true, "kill": true }, "ProcessClass": { "view": { "status": true, "configuration": true } }, "Schedule": { "view": { "status": true, "configuration": true }, "edit": true, "addSubstitute": true }, "Lock": { "view": { "status": true, "configuration": true } }, "Event": { "view": { "status": true }, "delete": true }, "EventAction": { "view": { "status": true }, "createEventsManually": true }, "HolidayCalendar": { "view": { "status": true } }, "MaintenanceWindow": { "view": { "status": true }, "enableDisableMaintenanceWindow": true }, "SOSPermissionRoles": { "SOSPermissionRole": [ "application_manager", "it_operator", "incident_manager", "business_user" ] } } { "isAuthenticated": true, "user": "root", "accessToken": "41de2635-0f0e-4a39-b247-6936e237ca5f", "JobschedulerMaster": { "view": { "status": true, "mainlog": true }, "pause": true, "continue": true, "terminate": true, "abort": true, "restart": { "terminate": true, "abort": true }, "manageCategories": true }, "JobschedulerMasterCluster": { "view": { "clusterStatus": true }, "terminate": true, "terminateFailSafe": true, "restart": true }, "JobschedulerUniversalAgent": { "view": { "status": true }, "terminate": true, "abort": true, "restart": { "terminate": true, "abort": true } }, "DailyPlan": { "view": { "status": true } }, "History": { "view": true }, "Order": { "view": { "configuration": true, "history": true, "orderLog": true, "status": true }, "change": { "startAndEndNode": true, "timeForAdhocOrder": true, "parameter": true }, "start": true, "update": true, "suspend": true, "resume": true, "delete": { "permanent": true, "temporary": true }, "removeSetback": true }, "JobChain": { "view": { "configuration": true, "history": true, "status": true }, "stop": true, "unstop": true, "addOrder": true, "skipJobChainNode": true, "unskipJobChainNode": true, "stopJobChainNode": true, "unstopJobChainNode": true }, "Job": { "view": { "status": true, "taskLog": true, "configuration": true, "history": true }, "start": { "task": true, "taskImmediate": true }, "stop": true, "unstop": true, "terminate": true, "kill": true }, "ProcessClass": { "view": { "status": true, "configuration": true } }, "Schedule": { "view": { "status": true, "configuration": true }, "edit": true, "addSubstitute": true }, "Lock": { "view": { "status": true, "configuration": true } }, "Event": { "view": { "status": true }, "delete": true }, "EventAction": { "view": { "status": true }, "createEventsManually": true }, "HolidayCalendar": { "view": { "status": true } }, "MaintenanceWindow": { "view": { "status": true }, "enableDisableMaintenanceWindow": true }, "SOSPermissionRoles": { "SOSPermissionRole": [ "application_manager", "it_operator", "incident_manager", "business_user" ] } }
401	Unauthorized!	application/json model \| example { "title": "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 'switch'	application/json model \| example { "title": "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 }
420	'switch' 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": "Date time. 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": { "javaType": "com.sos.joc.model.common.Err", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "pattern": "^[^<>]*$", "maxLength": 255 }, "message": { "type": "string" } } } } } { "deliveryDate": "2016-05-05T21:13:35Z", "surveyDate": "2016-05-05T21:13:33Z", "error": { "code": "JOC-420", "message": "switch failed!" } } { "deliveryDate": "2016-05-05T21:13:35Z", "surveyDate": "2016-05-05T21:13:33Z", "error": { "code": "JOC-420", "message": "switch failed!" } }
440	Login Timeout! The client's session has expired and must log in again.	application/json model \| example { "title": "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 }