JOC API

/jobscheduler/supervisor

POST

Volatile information of the supervisor such as its status

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",
    "id": "schemas/common/jobSchedulerId",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "javaType": "com.sos.joc.model.common.JobSchedulerId",
    "type": "object",
    "required": [
        "jobschedulerId"
    ],
    "properties": {
        "jobschedulerId": {
            "type": "string"
        }
    }
}

{ "jobschedulerId": "scheduler" }

{
    "jobschedulerId": "scheduler"
}

Responses

Code	Description	Body
200	Returns particularly status such as starting running paused waiting for activation waiting for database terminating dead unreachable If the master doesn't have a Supervisor then the "jobschedulder" object is empty	application/json model \| example { "title": "jobscheduler with delivry date (volatile part)", "id": "schemas/jobscheduler/jobscheduler_v", "$schema": "http://json-schema.org/draft-04/schema#", "javaType": "com.sos.joc.model.jobscheduler.JobSchedulerV200", "type": "object", "required": [ "deliveryDate", "jobscheduler" ], "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" }, "jobscheduler": { "id": "schemas/jobscheduler/jobscheduler_v", "javaType": "com.sos.joc.model.jobscheduler.JobSchedulerV", "type": "object", "oneOf": [{ "description": "if state.text=unreachable", "required": [ "jobschedulerId", "host", "port", "state" ] }, { "required": [ "surveyDate", "jobschedulerId", "host", "port", "state", "startedAt" ] }], "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" }, "jobschedulerId": { "type": "string" }, "host": { "type": "string" }, "port": { "id": "schemas/common/port", "type": "integer", "minimum": 0, "maximum": 65535 }, "state": { "id": "schemas/jobscheduler/state", "javaType": "com.sos.joc.model.jobscheduler.JobSchedulerState", "type": "object", "required": [ "severity", "_text" ], "properties": { "severity": { "description": "0=running/starting, 1=paused, 3=waiting_for_activation/terminating, 2=waiting_for_database/dead/unreachable", "type": "integer" }, "_text": { "id": "schemas/jobscheduler/stateText", "javaType": "com.sos.joc.model.jobscheduler.JobSchedulerStateText", "type": "string", "enum": [ "STARTING", "RUNNING", "PAUSED", "WAITING_FOR_ACTIVATION", "TERMINATING", "WAITING_FOR_DATABASE", "DEAD", "UNREACHABLE", "UNKNOWN_AGENT" ] } } }, "url": { "type": "string" }, "clusterType": { "id": "schemas/jobscheduler/clusterMemberType", "javaType": "com.sos.joc.model.jobscheduler.ClusterMemberType", "type": "object", "required": [ "_type" ], "properties": { "_type": { "id": "schemas/jobscheduler/clusterType", "javaType": "com.sos.joc.model.jobscheduler.ClusterType", "type": "string", "description": "Possible values are: 'standalone','active','passive'; JobScheduler doesn't run in a cluster (standalone) or is member of an active (distributed orders) or passive cluster (backup)", "enum": [ "standalone", "active", "passive" ] }, "precedence": { "id": "schemas/common/nonNegativeInteger", "type": "integer", "minimum": 0 } } }, "startedAt": { "id": "schemas/common/timestamp", "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "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:45Z", "jobscheduler": { "surveyDate": "2016-05-05T21:13:45Z", "jobschedulerId": "supervisor", "version": "1.11.0", "host": "super.sos", "port": 4444, "timeZone": "Europe/Berlin", "clusterType": { "type": "standalone" }, "state": { "severity": 0, "_text": "running" }, "startedAt": "2016-05-03T14:48:01Z" } } { "deliveryDate": "2016-05-05T21:13:45Z", "jobscheduler": { "surveyDate": "2016-05-05T21:13:45Z", "jobschedulerId": "supervisor", "version": "1.11.0", "host": "super.sos", "port": 4444, "timeZone": "Europe/Berlin", "clusterType": { "type": "standalone" }, "state": { "severity": 0, "_text": "running" }, "startedAt": "2016-05-03T14:48:01Z" } }
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 'supervisor'	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 }
420	'supervisor' 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": "supervisor failed!" } } { "deliveryDate": "2016-05-05T21:13:35Z", "surveyDate": "2016-05-05T21:13:33Z", "error": { "code": "JOC-420", "message": "supervisor 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 }