JOC API

/schedules

POST

Schedules (volatile part)

Parameters in the POST body schema

Name	Type	Description	Example
`jobschedulerId`	required, string	JobScheduler Master ID	scheduler
`regex`	optional, string	Regular expression to filter the collection	.*
`schedules`	optional, array	Filtered response by a collection of schedules specified by its path Some other parameters such as `folders` and `regex` are ignored if this parameter is defined.	[{ "schedule":"/test/weekdays" }]
`state`	optional, array	Filtered all schedules with states such as active and inactive.	["ACTIVE"]
`folders`	optional, array	collection of folder objects	[{ "folder": "/sos", "recursive": true }]

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": "schedulesFilter",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "javaType": "com.sos.joc.model.schedule.SchedulesFilter",
    "type": "object",
    "required": [
        "jobschedulerId"
    ],
    "properties": {
        "jobschedulerId": {
            "type": "string",
            "pattern": "^[^/\\<>?:\"|*]*$",
            "maxLength": 100
        },
        "schedules": {
            "type": "array",
            "items": {
                "javaType": "com.sos.joc.model.schedule.SchedulePath",
                "type": "object",
                "required": [
                    "schedule"
                ],
                "properties": {
                    "schedule": {
                        "description": "absolute path based on live folder of a JobScheduler object.",
                        "type": "string",
                        "pattern": "^(/|(/[^/\\<>?:\"|*]+)+)$",
                        "maxLength": 255
                    }
                }
            }
        },
        "regex": {
            "description": "regular expression to filter JobScheduler objects by matching the path",
            "type": "string",
            "pattern": "^((?!<script( |>)|<svg/on).)*$"
        },
        "folders": {
            "type": "array",
            "items": {
                "javaType": "com.sos.joc.model.common.Folder",
                "type": "object",
                "required": [
                    "folder"
                ],
                "properties": {
                    "folder": {
                        "description": "absolute path based on live folder of a JobScheduler object.",
                        "type": "string",
                        "pattern": "^(/|(/[^/\\<>?:\"|*]+)+)$",
                        "maxLength": 255
                    },
                    "recursive": {
                        "type": "boolean",
                        "default": true
                    }
                }
            }
        },
        "states": {
            "type": "array",
            "items": {
                "javaType": "com.sos.joc.model.schedule.ScheduleStateText",
                "type": "string",
                "enum": [
                    "ACTIVE",
                    "INACTIVE",
                    "UNKNOWN"
                ]
            }
        }
    }
}

{ "jobschedulerId": "scheduler", "compact": true }

{
    "jobschedulerId": "scheduler",
    "compact": true
}

Responses

Code	Description	Body
200	Required fields are surveyDate path name state Optional field is configurationStatus	application/json model \| example { "title": "schedules (volatile part)", "$schema": "http://json-schema.org/draft-04/schema#", "javaType": "com.sos.joc.model.schedule.SchedulesV", "type": "object", "required": [ "deliveryDate", "schedules" ], "properties": { "deliveryDate": { "description": "Date time. Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ", "type": "string", "format": "date-time" }, "schedules": { "type": "array", "items": { "javaType": "com.sos.joc.model.schedule.ScheduleV", "type": "object", "required": [ "surveyDate", "path", "name", "state" ], "properties": { "surveyDate": { "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": { "description": "absolute path based on live folder of a JobScheduler object.", "type": "string", "pattern": "^(/\|(/[^/\\<>?:\"\|*]+)+)$", "maxLength": 255 }, "name": { "type": "string" }, "state": { "javaType": "com.sos.joc.model.schedule.ScheduleState", "type": "object", "required": [ "severity", "_text" ], "properties": { "severity": { "description": "0=active; 1=inactive", "type": "integer" }, "_text": { "javaType": "com.sos.joc.model.schedule.ScheduleStateText", "type": "string", "enum": [ "ACTIVE", "INACTIVE", "UNKNOWN" ] } } }, "configurationStatus": { "javaType": "com.sos.joc.model.common.ConfigurationState", "type": "object", "required": [ "severity", "_text" ], "properties": { "severity": { "description": "4=ok; 5=replacement_is_standing_by,removing_delayed; 2=error_in_configuration_file,changed_file_not_loaded,resource_is_missing", "type": "integer" }, "_text": { "javaType": "com.sos.joc.model.common.ConfigurationStateText", "type": "string", "enum": [ "ERROR_IN_CONFIGURATION_FILE", "CHANGED_FILE_NOT_LOADED", "REMOVING_DELAYED", "RESOURCE_IS_MISSING", "REPLACEMENT_IS_STANDING_BY", "OK" ] }, "message": { "description": "contains e.g. error message", "type": "string" } } } } } } } } { "schedules": [{ "path": "/examples/20_SchedulingJobChains/MonthlySchedule", "state": { "_text": "ACTIVE", "severity": 0 }, "name": "MonthlySchedule" }, { "path": "/examples/10_RemoteExecutionUniversalAgent/schedule1", "state": { "_text": "ACTIVE", "severity": 0 }, "name": "schedule1" }, { "path": "/examples/20_SchedulingJobChains/DailySchedule", "state": { "_text": "ACTIVE", "severity": 0 }, "name": "DailySchedule" }, { "path": "/examples/20_SchedulingJobChains/WeeklySchedule", "state": { "_text": "ACTIVE", "severity": 0 }, "name": "WeeklySchedule" }], "deliveryDate": "2016-09-14T00:44:13Z" } { "schedules": [{ "path": "/examples/20_SchedulingJobChains/MonthlySchedule", "state": { "_text": "ACTIVE", "severity": 0 }, "name": "MonthlySchedule" }, { "path": "/examples/10_RemoteExecutionUniversalAgent/schedule1", "state": { "_text": "ACTIVE", "severity": 0 }, "name": "schedule1" }, { "path": "/examples/20_SchedulingJobChains/DailySchedule", "state": { "_text": "ACTIVE", "severity": 0 }, "name": "DailySchedule" }, { "path": "/examples/20_SchedulingJobChains/WeeklySchedule", "state": { "_text": "ACTIVE", "severity": 0 }, "name": "WeeklySchedule" }], "deliveryDate": "2016-09-14T00:44:13Z" }
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 'schedules'	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	'schedules' 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": "schedules failed!" } } { "deliveryDate": "2016-05-05T21:13:35Z", "surveyDate": "2016-05-05T21:13:33Z", "error": { "code": "JOC-420", "message": "schedules 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 }