JOC API

/joc/cluster/run

POST

Immediately run JOC services such as dailyplan,cleanup

Parameters in the POST body schema

Name	Type	Description	Example	Default
`type`	required, string	Possible values are dailyplan cleanup

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": "Immediately run JOC services such as dailyplan,cleanup",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "javaType": "com.sos.joc.model.cluster.ClusterServiceRun",
    "type": "object",
    "required": [
        "type"
    ],
    "properties": {
        "type": {
            "javaType": "com.sos.joc.model.cluster.common.ClusterServices",
            "type": "string",
            "enum": [
                "cluster",
                "history",
                "dailyplan",
                "cleanup",
                "monitor",
                "lognotification"
            ],
            "javaEnumNames": [
                "cluster",
                "history",
                "dailyplan",
                "cleanup",
                "monitor",
                "lognotification"
            ]
        }
    }
}

Responses

Code	Description	Body
200		application/json model \| example { "title": "JOC cluster response", "$schema": "http://json-schema.org/draft-04/schema#", "javaType": "com.sos.joc.model.cluster.ClusterResponse", "type": "object", "required": [ "deliveryDate", "type", "state" ], "properties": { "deliveryDate": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" }, "type": { "javaType": "com.sos.joc.model.cluster.common.ClusterServices", "type": "string", "enum": [ "cluster", "history", "dailyplan", "cleanup", "monitor", "lognotification" ], "javaEnumNames": [ "cluster", "history", "dailyplan", "cleanup", "monitor", "lognotification" ] }, "state": { "javaType": "com.sos.joc.model.cluster.common.state.JocClusterState", "type": "string", "enum": [ "STARTED", "RUNNING", "STOPPED", "RESTARTED", "ALREADY_STARTED", "ALREADY_RUNNING", "ALREADY_STOPPED", "SWITCH_MEMBER", "MISSING_CONFIGURATION", "MISSING_HANDLERS", "MISSING_LICENSE", "ERROR", "COMPLETED", "UNCOMPLETED" ], "javaEnumNames": [ "STARTED", "RUNNING", "STOPPED", "RESTARTED", "ALREADY_STARTED", "ALREADY_RUNNING", "ALREADY_STOPPED", "SWITCH_MEMBER", "MISSING_CONFIGURATION", "MISSING_HANDLERS", "MISSING_LICENSE", "ERROR", "COMPLETED", "UNCOMPLETED" ] } } }
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 'run'	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	'run' 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": "run failed!" } } { "deliveryDate": "2016-05-05T21:13:35Z", "surveyDate": "2016-05-05T21:13:33Z", "error": { "code": "JOC-420", "message": "run 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 }