JOC API

/order/run_time

POST

run time as XML string embedded in JSON

Parameters in the POST body schema

Name	Type	Description	Example
`jobschedulerId`	required, string	JobScheduler Master ID	scheduler
`jobChain`	required, string	Path of a job chain	/sos/reporting/Inventory
`orderId`	required; string	The id of an order	inventory

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": "order filter",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "javaType": "com.sos.joc.model.order.OrderFilter",
    "type": "object",
    "required": [
        "jobschedulerId",
        "jobChain",
        "orderId"
    ],
    "properties": {
        "jobschedulerId": {
            "type": "string",
            "pattern": "^[^/\\<>?:\"|*]*$",
            "maxLength": 100
        },
        "jobChain": {
            "description": "absolute path based on live folder of a JobScheduler object.",
            "type": "string",
            "pattern": "^(/|(/[^/\\<>?:\"|*]+)+)$",
            "maxLength": 255
        },
        "orderId": {
            "type": "string",
            "pattern": "^[^<>]*$",
            "maxLength": 255
        },
        "compact": {
            "description": "controls if the object view is compact or detailed",
            "type": "boolean",
            "default": false
        },
        "suppressNotExistException": {
            "description": "controls if an exception raises when Object doesn't exist",
            "type": "boolean",
            "default": true
        }
    }
}

{ "jobschedulerId": "scheduler", "jobChain": "/test/foo/bar1", "orderId": "order1" }

{
    "jobschedulerId": "scheduler",
    "jobChain": "/test/foo/bar1",
    "orderId": "order1"
}

Responses

Code	Description	Body
200	Returns the run time	application/json model \| example { "title": "runtime with delivery date", "$schema": "http://json-schema.org/draft-04/schema#", "javaType": "com.sos.joc.model.common.RunTime200", "type": "object", "required": [ "deliveryDate", "runTime" ], "properties": { "deliveryDate": { "description": "Date time. Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ", "type": "string", "format": "date-time" }, "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", "javaType": "com.sos.joc.model.common.RunTime", "type": "object", "required": [ "surveyDate", "runTime", "runTimeIsTemporary" ], "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" }, "runTime": { "javaType": "com.sos.joc.model.joe.schedule.RunTime", "type": "object", "xmlElement": "run_time", "javaInterfaces": [ "com.sos.joc.model.joe.common.IJSObject" ], "extends": { "javaType": "com.sos.joc.model.joe.schedule.AbstractSchedule", "type": "object", "properties": { "timeZone": { "type": "string" }, "begin": { "description": "pattern: [0-9]{1,2}:[0-9]{2}(:[0-9]{2})?", "type": "string" }, "end": { "description": "pattern: [0-9]{1,2}:[0-9]{2}(:[0-9]{2})?", "type": "string" }, "letRun": { "description": "possible values: yes, no, 1, 0, true, false", "type": "string", "default": "false" }, "runOnce": { "xmlElement": "once", "description": "possible values: yes, no, 1, 0, true, false", "type": "string", "default": "false" }, "periods": { "xmlElement": "period", "type": "array", "items": { "javaType": "com.sos.joc.model.joe.schedule.Period", "type": "object", "properties": { "begin": { "description": "pattern: [0-9]{1,2}:[0-9]{2}(:[0-9]{2})?", "type": "string" }, "end": { "description": "pattern: [0-9]{1,2}:[0-9]{2}(:[0-9]{2})?", "type": "string" }, "singleStart": { "description": "pattern: [0-9]{1,2}:[0-9]{2}(:[0-9]{2})?", "type": "string" }, "letRun": { "description": "possible values: yes, no, 1, 0, true, false", "type": "string", "default": "false" }, "runOnce": { "xmlElement": "start_once", "description": "possible values: yes, no, 1, 0, true, false", "type": "string", "default": "false" }, "repeat": { "description": "pattern: ([0-9]+)\|([0-9]+:[0-9]{2}(:[0-9]{2})?)", "type": "string" }, "absoluteRepeat": { "description": "pattern: ([0-9]+)\|([0-9]+:[0-9]{2}(:[0-9]{2})?)", "type": "string" }, "whenHoliday": { "description": "possible values: suppress (default), ignore_holiday, previous_non_holiday, next_non_holiday", "type": "string", "default": "suppress" } } } }, "ats": { "xmlElement": "at", "type": "array", "items": { "type": "object", "javaType": "com.sos.joc.model.joe.schedule.At", "properties": { "at": { "description": "yyyy-mm-dd HH:MM[:SS]", "type": "string" } } } }, "dates": { "xmlElement": "date", "type": "array", "items": { "xmlElement": "date", "type": "object", "javaType": "com.sos.joc.model.joe.schedule.Date", "required": [ "date" ], "properties": { "date": { "type": "string" }, "calendar": { "type": "string" }, "periods": { "xmlElement": "period", "type": "array", "items": { "javaType": "com.sos.joc.model.joe.schedule.Period", "type": "object", "properties": { "begin": { "description": "pattern: [0-9]{1,2}:[0-9]{2}(:[0-9]{2})?", "type": "string" }, "end": { "description": "pattern: [0-9]{1,2}:[0-9]{2}(:[0-9]{2})?", "type": "string" }, "singleStart": { "description": "pattern: [0-9]{1,2}:[0-9]{2}(:[0-9]{2})?", "type": "string" }, "letRun": { "description": "possible values: yes, no, 1, 0, true, false", "type": "string", "default": "false" }, "runOnce": { "xmlElement": "start_once", "description": "possible values: yes, no, 1, 0, true, false", "type": "string", "default": "false" }, "repeat": { "description": "pattern: ([0-9]+)\|([0-9]+:[0-9]{2}(:[0-9]{2})?)", "type": "string" }, "absoluteRepeat": { "description": "pattern: ([0-9]+)\|([0-9]+:[0-9]{2}(:[0-9]{2})?)", "type": "string" }, "whenHoliday": { "description": "possible values: suppress (default), ignore_holiday, previous_non_holiday, next_non_holiday", "type": "string", "default": "suppress" } } } } } } }, "weekdays": { "type": "object", "javaType": "com.sos.joc.model.joe.schedule.Weekdays", "properties": { "days": { "xmlElement": "day", "type": "array", "items": { "xmlElement": "day", "type": "object", "javaType": "com.sos.joc.model.joe.schedule.Day", "required": [ "day" ], "properties": { "day": { "description": "[01234567]\|(so(nntag)?)\|(mo(ntag)?)\|(di(enstag)?)\|(mi(ttwoch)?)\|(do(nnerstag)?)\|(fr(eitag)?)\|(sa(mstag)?)\|(sun(day)?)\|(mon(day)?)\|(tue(sday)?)\|(wed(nesday)?)\|(thu(rsday)?)\|(fri(day)?)\|(sat(urday)?) for weekdays (where sunday is 0 or 7) or 1-31 for monthdays and 0-30 for ultimos", "type": "string" }, "periods": { "xmlElement": "period", "type": "array", "items": { "javaType": "com.sos.joc.model.joe.schedule.Period", "type": "object", "properties": { "begin": { "description": "pattern: [0-9]{1,2}:[0-9]{2}(:[0-9]{2})?", "type": "string" }, "end": { "description": "pattern: [0-9]{1,2}:[0-9]{2}(:[0-9]{2})?", "type": "string" }, "singleStart": { "description": "pattern: [0-9]{1,2}:[0-9]{2}(:[0-9]{2})?", "type": "string" }, "letRun": { "description": "possible values: yes, no, 1, 0, true, false", "type": "string", "default": "false" }, "runOnce": { "xmlElement": "start_once", "description": "possible values: yes, no, 1, 0, true, false", "type": "string", "default": "false" }, "repeat": { "description": "pattern: ([0-9]+)\|([0-9]+:[0-9]{2}(:[0-9]{2})?)", "type": "string" }, "absoluteRepeat": { "description": "pattern: ([0-9]+)\|([0-9]+:[0-9]{2}(:[0-9]{2})?)", "type": "string" }, "whenHoliday": { "description": "possible values: suppress (default), ignore_holiday, previous_non_holiday, next_non_holiday", "type": "string", "default": "suppress" } } } } } } } } }, "monthdays": { "type": "object", "javaType": "com.sos.joc.model.joe.schedule.Monthdays", "properties": { "days": { "xmlElement": "day", "type": "array", "items": { "xmlElement": "day", "type": "object", "javaType": "com.sos.joc.model.joe.schedule.Day", "required": [ "day" ], "properties": { "day": { "description": "[01234567]\|(so(nntag)?)\|(mo(ntag)?)\|(di(enstag)?)\|(mi(ttwoch)?)\|(do(nnerstag)?)\|(fr(eitag)?)\|(sa(mstag)?)\|(sun(day)?)\|(mon(day)?)\|(tue(sday)?)\|(wed(nesday)?)\|(thu(rsday)?)\|(fri(day)?)\|(sat(urday)?) for weekdays (where sunday is 0 or 7) or 1-31 for monthdays and 0-30 for ultimos", "type": "string" }, "periods": { "xmlElement": "period", "type": "array", "items": { "javaType": "com.sos.joc.model.joe.schedule.Period", "type": "object", "properties": { "begin": { "description": "pattern: [0-9]{1,2}:[0-9]{2}(:[0-9]{2})?", "type": "string" }, "end": { "description": "pattern: [0-9]{1,2}:[0-9]{2}(:[0-9]{2})?", "type": "string" }, "singleStart": { "description": "pattern: [0-9]{1,2}:[0-9]{2}(:[0-9]{2})?", "type": "string" }, "letRun": { "description": "possible values: yes, no, 1, 0, true, false", "type": "string", "default": "false" }, "runOnce": { "xmlElement": "start_once", "description": "possible values: yes, no, 1, 0, true, false", "type": "string", "default": "false" }, "repeat": { "description": "pattern: ([0-9]+)\|([0-9]+:[0-9]{2}(:[0-9]{2})?)", "type": "string" }, "absoluteRepeat": { "description": "pattern: ([0-9]+)\|([0-9]+:[0-9]{2}(:[0-9]{2})?)", "type": "string" }, "whenHoliday": { "description": "possible values: suppress (default), ignore_holiday, previous_non_holiday, next_non_holiday", "type": "string", "default": "suppress" } } } } } } }, "weekdays": { "type": "array", "xmlElement": "weekday", "items": { "type": "object", "javaType": "com.sos.joc.model.joe.schedule.WeekdayOfMonth", "xmlElement": "weekday", "required": [ "day", "which" ], "properties": { "day": { "description": "[01234567]\|(so(nntag)?)\|(mo(ntag)?)\|(di(enstag)?)\|(mi(ttwoch)?)\|(do(nnerstag)?)\|(fr(eitag)?)\|(sa(mstag)?)\|(sun(day)?)\|(mon(day)?)\|(tue(sday)?)\|(wed(nesday)?)\|(thu(rsday)?)\|(fri(day)?)\|(sat(urday)?)", "type": "string" }, "which": { "description": "possible value: -4, -3, -2, -1, 1, 2, 3, 4", "type": "integer" }, "periods": { "xmlElement": "period", "type": "array", "items": { "javaType": "com.sos.joc.model.joe.schedule.Period", "type": "object", "properties": { "begin": { "description": "pattern: [0-9]{1,2}:[0-9]{2}(:[0-9]{2})?", "type": "string" }, "end": { "description": "pattern: [0-9]{1,2}:[0-9]{2}(:[0-9]{2})?", "type": "string" }, "singleStart": { "description": "pattern: [0-9]{1,2}:[0-9]{2}(:[0-9]{2})?", "type": "string" }, "letRun": { "description": "possible values: yes, no, 1, 0, true, false", "type": "string", "default": "false" }, "runOnce": { "xmlElement": "start_once", "description": "possible values: yes, no, 1, 0, true, false", "type": "string", "default": "false" }, "repeat": { "description": "pattern: ([0-9]+)\|([0-9]+:[0-9]{2}(:[0-9]{2})?)", "type": "string" }, "absoluteRepeat": { "description": "pattern: ([0-9]+)\|([0-9]+:[0-9]{2}(:[0-9]{2})?)", "type": "string" }, "whenHoliday": { "description": "possible values: suppress (default), ignore_holiday, previous_non_holiday, next_non_holiday", "type": "string", "default": "suppress" } } } } } } } } }, "ultimos": { "type": "object", "javaType": "com.sos.joc.model.joe.schedule.Ultimos", "properties": { "days": { "xmlElement": "day", "type": "array", "items": { "xmlElement": "day", "type": "object", "javaType": "com.sos.joc.model.joe.schedule.Day", "required": [ "day" ], "properties": { "day": { "description": "[01234567]\|(so(nntag)?)\|(mo(ntag)?)\|(di(enstag)?)\|(mi(ttwoch)?)\|(do(nnerstag)?)\|(fr(eitag)?)\|(sa(mstag)?)\|(sun(day)?)\|(mon(day)?)\|(tue(sday)?)\|(wed(nesday)?)\|(thu(rsday)?)\|(fri(day)?)\|(sat(urday)?) for weekdays (where sunday is 0 or 7) or 1-31 for monthdays and 0-30 for ultimos", "type": "string" }, "periods": { "xmlElement": "period", "type": "array", "items": { "javaType": "com.sos.joc.model.joe.schedule.Period", "type": "object", "properties": { "begin": { "description": "pattern: [0-9]{1,2}:[0-9]{2}(:[0-9]{2})?", "type": "string" }, "end": { "description": "pattern: [0-9]{1,2}:[0-9]{2}(:[0-9]{2})?", "type": "string" }, "singleStart": { "description": "pattern: [0-9]{1,2}:[0-9]{2}(:[0-9]{2})?", "type": "string" }, "letRun": { "description": "possible values: yes, no, 1, 0, true, false", "type": "string", "default": "false" }, "runOnce": { "xmlElement": "start_once", "description": "possible values: yes, no, 1, 0, true, false", "type": "string", "default": "false" }, "repeat": { "description": "pattern: ([0-9]+)\|([0-9]+:[0-9]{2}(:[0-9]{2})?)", "type": "string" }, "absoluteRepeat": { "description": "pattern: ([0-9]+)\|([0-9]+:[0-9]{2}(:[0-9]{2})?)", "type": "string" }, "whenHoliday": { "description": "possible values: suppress (default), ignore_holiday, previous_non_holiday, next_non_holiday", "type": "string", "default": "suppress" } } } } } } } } }, "months": { "type": "array", "xmlElement": "month", "items": { "type": "object", "javaType": "com.sos.joc.model.joe.schedule.Month", "xmlElement": "month", "properties": { "month": { "description": "unordered space separated list of 1-12 or january, february, march, april, may, june, july, august, september, october, november, december", "type": "string" }, "periods": { "xmlElement": "period", "type": "array", "items": { "javaType": "com.sos.joc.model.joe.schedule.Period", "type": "object", "properties": { "begin": { "description": "pattern: [0-9]{1,2}:[0-9]{2}(:[0-9]{2})?", "type": "string" }, "end": { "description": "pattern: [0-9]{1,2}:[0-9]{2}(:[0-9]{2})?", "type": "string" }, "singleStart": { "description": "pattern: [0-9]{1,2}:[0-9]{2}(:[0-9]{2})?", "type": "string" }, "letRun": { "description": "possible values: yes, no, 1, 0, true, false", "type": "string", "default": "false" }, "runOnce": { "xmlElement": "start_once", "description": "possible values: yes, no, 1, 0, true, false", "type": "string", "default": "false" }, "repeat": { "description": "pattern: ([0-9]+)\|([0-9]+:[0-9]{2}(:[0-9]{2})?)", "type": "string" }, "absoluteRepeat": { "description": "pattern: ([0-9]+)\|([0-9]+:[0-9]{2}(:[0-9]{2})?)", "type": "string" }, "whenHoliday": { "description": "possible values: suppress (default), ignore_holiday, previous_non_holiday, next_non_holiday", "type": "string", "default": "suppress" } } } }, "weekdays": { "type": "object", "javaType": "com.sos.joc.model.joe.schedule.Weekdays", "properties": { "days": { "xmlElement": "day", "type": "array", "items": { "xmlElement": "day", "type": "object", "javaType": "com.sos.joc.model.joe.schedule.Day", "required": [ "day" ], "properties": { "day": { "description": "[01234567]\|(so(nntag)?)\|(mo(ntag)?)\|(di(enstag)?)\|(mi(ttwoch)?)\|(do(nnerstag)?)\|(fr(eitag)?)\|(sa(mstag)?)\|(sun(day)?)\|(mon(day)?)\|(tue(sday)?)\|(wed(nesday)?)\|(thu(rsday)?)\|(fri(day)?)\|(sat(urday)?) for weekdays (where sunday is 0 or 7) or 1-31 for monthdays and 0-30 for ultimos", "type": "string" }, "periods": { "xmlElement": "period", "type": "array", "items": { "javaType": "com.sos.joc.model.joe.schedule.Period", "type": "object", "properties": { "begin": { "description": "pattern: [0-9]{1,2}:[0-9]{2}(:[0-9]{2})?", "type": "string" }, "end": { "description": "pattern: [0-9]{1,2}:[0-9]{2}(:[0-9]{2})?", "type": "string" }, "singleStart": { "description": "pattern: [0-9]{1,2}:[0-9]{2}(:[0-9]{2})?", "type": "string" }, "letRun": { "description": "possible values: yes, no, 1, 0, true, false", "type": "string", "default": "false" }, "runOnce": { "xmlElement": "start_once", "description": "possible values: yes, no, 1, 0, true, false", "type": "string", "default": "false" }, "repeat": { "description": "pattern: ([0-9]+)\|([0-9]+:[0-9]{2}(:[0-9]{2})?)", "type": "string" }, "absoluteRepeat": { "description": "pattern: ([0-9]+)\|([0-9]+:[0-9]{2}(:[0-9]{2})?)", "type": "string" }, "whenHoliday": { "description": "possible values: suppress (default), ignore_holiday, previous_non_holiday, next_non_holiday", "type": "string", "default": "suppress" } } } } } } } } }, "monthdays": { "type": "object", "javaType": "com.sos.joc.model.joe.schedule.Monthdays", "properties": { "days": { "xmlElement": "day", "type": "array", "items": { "xmlElement": "day", "type": "object", "javaType": "com.sos.joc.model.joe.schedule.Day", "required": [ "day" ], "properties": { "day": { "description": "[01234567]\|(so(nntag)?)\|(mo(ntag)?)\|(di(enstag)?)\|(mi(ttwoch)?)\|(do(nnerstag)?)\|(fr(eitag)?)\|(sa(mstag)?)\|(sun(day)?)\|(mon(day)?)\|(tue(sday)?)\|(wed(nesday)?)\|(thu(rsday)?)\|(fri(day)?)\|(sat(urday)?) for weekdays (where sunday is 0 or 7) or 1-31 for monthdays and 0-30 for ultimos", "type": "string" }, "periods": { "xmlElement": "period", "type": "array", "items": { "javaType": "com.sos.joc.model.joe.schedule.Period", "type": "object", "properties": { "begin": { "description": "pattern: [0-9]{1,2}:[0-9]{2}(:[0-9]{2})?", "type": "string" }, "end": { "description": "pattern: [0-9]{1,2}:[0-9]{2}(:[0-9]{2})?", "type": "string" }, "singleStart": { "description": "pattern: [0-9]{1,2}:[0-9]{2}(:[0-9]{2})?", "type": "string" }, "letRun": { "description": "possible values: yes, no, 1, 0, true, false", "type": "string", "default": "false" }, "runOnce": { "xmlElement": "start_once", "description": "possible values: yes, no, 1, 0, true, false", "type": "string", "default": "false" }, "repeat": { "description": "pattern: ([0-9]+)\|([0-9]+:[0-9]{2}(:[0-9]{2})?)", "type": "string" }, "absoluteRepeat": { "description": "pattern: ([0-9]+)\|([0-9]+:[0-9]{2}(:[0-9]{2})?)", "type": "string" }, "whenHoliday": { "description": "possible values: suppress (default), ignore_holiday, previous_non_holiday, next_non_holiday", "type": "string", "default": "suppress" } } } } } } }, "weekdays": { "type": "array", "xmlElement": "weekday", "items": { "type": "object", "javaType": "com.sos.joc.model.joe.schedule.WeekdayOfMonth", "xmlElement": "weekday", "required": [ "day", "which" ], "properties": { "day": { "description": "[01234567]\|(so(nntag)?)\|(mo(ntag)?)\|(di(enstag)?)\|(mi(ttwoch)?)\|(do(nnerstag)?)\|(fr(eitag)?)\|(sa(mstag)?)\|(sun(day)?)\|(mon(day)?)\|(tue(sday)?)\|(wed(nesday)?)\|(thu(rsday)?)\|(fri(day)?)\|(sat(urday)?)", "type": "string" }, "which": { "description": "possible value: -4, -3, -2, -1, 1, 2, 3, 4", "type": "integer" }, "periods": { "xmlElement": "period", "type": "array", "items": { "javaType": "com.sos.joc.model.joe.schedule.Period", "type": "object", "properties": { "begin": { "description": "pattern: [0-9]{1,2}:[0-9]{2}(:[0-9]{2})?", "type": "string" }, "end": { "description": "pattern: [0-9]{1,2}:[0-9]{2}(:[0-9]{2})?", "type": "string" }, "singleStart": { "description": "pattern: [0-9]{1,2}:[0-9]{2}(:[0-9]{2})?", "type": "string" }, "letRun": { "description": "possible values: yes, no, 1, 0, true, false", "type": "string", "default": "false" }, "runOnce": { "xmlElement": "start_once", "description": "possible values: yes, no, 1, 0, true, false", "type": "string", "default": "false" }, "repeat": { "description": "pattern: ([0-9]+)\|([0-9]+:[0-9]{2}(:[0-9]{2})?)", "type": "string" }, "absoluteRepeat": { "description": "pattern: ([0-9]+)\|([0-9]+:[0-9]{2}(:[0-9]{2})?)", "type": "string" }, "whenHoliday": { "description": "possible values: suppress (default), ignore_holiday, previous_non_holiday, next_non_holiday", "type": "string", "default": "suppress" } } } } } } } } }, "ultimos": { "type": "object", "javaType": "com.sos.joc.model.joe.schedule.Ultimos", "properties": { "days": { "xmlElement": "day", "type": "array", "items": { "xmlElement": "day", "type": "object", "javaType": "com.sos.joc.model.joe.schedule.Day", "required": [ "day" ], "properties": { "day": { "description": "[01234567]\|(so(nntag)?)\|(mo(ntag)?)\|(di(enstag)?)\|(mi(ttwoch)?)\|(do(nnerstag)?)\|(fr(eitag)?)\|(sa(mstag)?)\|(sun(day)?)\|(mon(day)?)\|(tue(sday)?)\|(wed(nesday)?)\|(thu(rsday)?)\|(fri(day)?)\|(sat(urday)?) for weekdays (where sunday is 0 or 7) or 1-31 for monthdays and 0-30 for ultimos", "type": "string" }, "periods": { "xmlElement": "period", "type": "array", "items": { "javaType": "com.sos.joc.model.joe.schedule.Period", "type": "object", "properties": { "begin": { "description": "pattern: [0-9]{1,2}:[0-9]{2}(:[0-9]{2})?", "type": "string" }, "end": { "description": "pattern: [0-9]{1,2}:[0-9]{2}(:[0-9]{2})?", "type": "string" }, "singleStart": { "description": "pattern: [0-9]{1,2}:[0-9]{2}(:[0-9]{2})?", "type": "string" }, "letRun": { "description": "possible values: yes, no, 1, 0, true, false", "type": "string", "default": "false" }, "runOnce": { "xmlElement": "start_once", "description": "possible values: yes, no, 1, 0, true, false", "type": "string", "default": "false" }, "repeat": { "description": "pattern: ([0-9]+)\|([0-9]+:[0-9]{2}(:[0-9]{2})?)", "type": "string" }, "absoluteRepeat": { "description": "pattern: ([0-9]+)\|([0-9]+:[0-9]{2}(:[0-9]{2})?)", "type": "string" }, "whenHoliday": { "description": "possible values: suppress (default), ignore_holiday, previous_non_holiday, next_non_holiday", "type": "string", "default": "suppress" } } } } } } } } } } } }, "holidays": { "type": "object", "javaType": "com.sos.joc.model.joe.schedule.Holidays", "properties": { "includes": { "type": "array", "xmlElement": "include", "items": { "javaType": "com.sos.joc.model.joe.common.Include", "type": "object", "description": "usage of file and liveFile are exclusive", "properties": { "file": { "type": "string" }, "liveFile": { "type": "string" } } } }, "weekdays": { "type": "object", "javaType": "com.sos.joc.model.joe.schedule.Weekdays", "properties": { "days": { "xmlElement": "day", "type": "array", "items": { "xmlElement": "day", "type": "object", "javaType": "com.sos.joc.model.joe.schedule.Day", "required": [ "day" ], "properties": { "day": { "description": "[01234567]\|(so(nntag)?)\|(mo(ntag)?)\|(di(enstag)?)\|(mi(ttwoch)?)\|(do(nnerstag)?)\|(fr(eitag)?)\|(sa(mstag)?)\|(sun(day)?)\|(mon(day)?)\|(tue(sday)?)\|(wed(nesday)?)\|(thu(rsday)?)\|(fri(day)?)\|(sat(urday)?) for weekdays (where sunday is 0 or 7) or 1-31 for monthdays and 0-30 for ultimos", "type": "string" }, "periods": { "xmlElement": "period", "type": "array", "items": { "javaType": "com.sos.joc.model.joe.schedule.Period", "type": "object", "properties": { "begin": { "description": "pattern: [0-9]{1,2}:[0-9]{2}(:[0-9]{2})?", "type": "string" }, "end": { "description": "pattern: [0-9]{1,2}:[0-9]{2}(:[0-9]{2})?", "type": "string" }, "singleStart": { "description": "pattern: [0-9]{1,2}:[0-9]{2}(:[0-9]{2})?", "type": "string" }, "letRun": { "description": "possible values: yes, no, 1, 0, true, false", "type": "string", "default": "false" }, "runOnce": { "xmlElement": "start_once", "description": "possible values: yes, no, 1, 0, true, false", "type": "string", "default": "false" }, "repeat": { "description": "pattern: ([0-9]+)\|([0-9]+:[0-9]{2}(:[0-9]{2})?)", "type": "string" }, "absoluteRepeat": { "description": "pattern: ([0-9]+)\|([0-9]+:[0-9]{2}(:[0-9]{2})?)", "type": "string" }, "whenHoliday": { "description": "possible values: suppress (default), ignore_holiday, previous_non_holiday, next_non_holiday", "type": "string", "default": "suppress" } } } } } } } } }, "days": { "xmlElement": "holiday", "type": "array", "items": { "xmlElement": "holiday", "type": "object", "javaType": "com.sos.joc.model.joe.schedule.Holiday", "required": [ "date" ], "properties": { "date": { "type": "string" }, "calendar": { "type": "string" }, "periods": { "xmlElement": "period", "type": "array", "items": { "javaType": "com.sos.joc.model.joe.schedule.Period", "type": "object", "properties": { "begin": { "description": "pattern: [0-9]{1,2}:[0-9]{2}(:[0-9]{2})?", "type": "string" }, "end": { "description": "pattern: [0-9]{1,2}:[0-9]{2}(:[0-9]{2})?", "type": "string" }, "singleStart": { "description": "pattern: [0-9]{1,2}:[0-9]{2}(:[0-9]{2})?", "type": "string" }, "letRun": { "description": "possible values: yes, no, 1, 0, true, false", "type": "string", "default": "false" }, "runOnce": { "xmlElement": "start_once", "description": "possible values: yes, no, 1, 0, true, false", "type": "string", "default": "false" }, "repeat": { "description": "pattern: ([0-9]+)\|([0-9]+:[0-9]{2}(:[0-9]{2})?)", "type": "string" }, "absoluteRepeat": { "description": "pattern: ([0-9]+)\|([0-9]+:[0-9]{2}(:[0-9]{2})?)", "type": "string" }, "whenHoliday": { "description": "possible values: suppress (default), ignore_holiday, previous_non_holiday, next_non_holiday", "type": "string", "default": "suppress" } } } } } } } } }, "calendars": { "type": "string", "isXmlCData": true } } }, "properties": { "schedule": { "description": "path to a schedule", "type": "string" } } }, "runTimeXml": { "type": "string" }, "permanentRunTime": { "description": "is required iff runTimeIsTemporary = true", "type": "string" }, "runTimeIsTemporary": { "type": "boolean", "default": false }, "calendars": { "type": "array", "items": { "javaType": "com.sos.joc.model.calendar.Calendar", "type": "object", "properties": { "id": { "type": "number", "format": "utc-millisec", "minimum": 0 }, "path": { "description": "absolute path based on live folder of a JobScheduler object.", "type": "string", "pattern": "^(/\|(/[^/\\<>?:\"\|]+)+)$", "maxLength": 255 }, "name": { "type": "string", "pattern": "^[^/\\<>?:\"\|]$", "maxLength": 255 }, "basedOn": { "description": "absolute path based on live folder of a JobScheduler object.", "type": "string", "pattern": "^(/\|(/[^/\\<>?:\"\|]+)+)$", "maxLength": 255 }, "documentation": { "description": "absolute path based on live folder of a JobScheduler object.", "type": "string", "pattern": "^(/\|(/[^/\\<>?:\"\|]+)+)$", "maxLength": 255 }, "type": { "javaType": "com.sos.joc.model.calendar.CalendarType", "type": "string", "enum": [ "WORKING_DAYS", "NON_WORKING_DAYS", "JOB", "ORDER", "SCHEDULE" ], "default": "WORKING_DAYS" }, "category": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "title": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "from": { "description": "ISO date YYYY-MM-DD", "type": "string", "format": "date" }, "to": { "description": "ISO date YYYY-MM-DD", "type": "string", "format": "date" }, "periods": { "type": "array", "items": { "javaType": "com.sos.joc.model.calendar.Period", "type": "object", "properties": { "singleStart": { "type": "string", "pattern": "^[0-9:]$" }, "begin": { "type": "string", "pattern": "^[0-9:]$" }, "end": { "type": "string", "pattern": "^[0-9:]$" }, "repeat": { "type": "string", "pattern": "^[0-9:]$" }, "absoluteRepeat": { "type": "string", "pattern": "^[0-9:]$" }, "whenHoliday": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 } } } }, "includes": { "javaType": "com.sos.joc.model.calendar.Frequencies", "type": "object", "properties": { "dates": { "type": "array", "items": { "description": "ISO date YYYY-MM-DD", "type": "string", "format": "date" } }, "weekdays": { "type": "array", "items": { "javaType": "com.sos.joc.model.calendar.WeekDays", "type": "object", "required": [ "days" ], "properties": { "from": { "description": "ISO date YYYY-MM-DD", "type": "string", "format": "date" }, "to": { "description": "ISO date YYYY-MM-DD", "type": "string", "format": "date" }, "days": { "type": "array", "items": { "description": "digit from 0-6, 0=Sunday, 1=Monday, ..., 6=Saturday, 7=Sunday (again)", "type": "integer", "minimum": 0, "maximum": 7 } } } } }, "monthdays": { "type": "array", "items": { "javaType": "com.sos.joc.model.calendar.MonthDays", "type": "object", "properties": { "from": { "description": "ISO date YYYY-MM-DD", "type": "string", "format": "date" }, "to": { "description": "ISO date YYYY-MM-DD", "type": "string", "format": "date" }, "days": { "type": "array", "items": { "description": "digit from 1-31", "type": "integer", "minimum": 1, "maximum": 31 } }, "weeklyDays": { "type": "array", "items": { "javaType": "com.sos.joc.model.calendar.WeeklyDay", "type": "object", "properties": { "day": { "description": "digit from 0-6, 0=Sunday, 1=Monday, ..., 6=Saturday, 7=Sunday (again)", "type": "integer", "minimum": 0, "maximum": 7 }, "weekOfMonth": { "type": "integer", "minimum": 1, "maximum": 5 } } } } } } }, "ultimos": { "type": "array", "items": { "javaType": "com.sos.joc.model.calendar.MonthDays", "type": "object", "properties": { "from": { "description": "ISO date YYYY-MM-DD", "type": "string", "format": "date" }, "to": { "description": "ISO date YYYY-MM-DD", "type": "string", "format": "date" }, "days": { "type": "array", "items": { "description": "digit from 1-31", "type": "integer", "minimum": 1, "maximum": 31 } }, "weeklyDays": { "type": "array", "items": { "javaType": "com.sos.joc.model.calendar.WeeklyDay", "type": "object", "properties": { "day": { "description": "digit from 0-6, 0=Sunday, 1=Monday, ..., 6=Saturday, 7=Sunday (again)", "type": "integer", "minimum": 0, "maximum": 7 }, "weekOfMonth": { "type": "integer", "minimum": 1, "maximum": 5 } } } } } } }, "months": { "type": "array", "items": { "javaType": "com.sos.joc.model.calendar.Months", "type": "object", "required": [ "months" ], "properties": { "months": { "type": "array", "items": { "type": "integer", "minimum": 1, "maximum": 12 } }, "from": { "description": "ISO date YYYY-MM-DD", "type": "string", "format": "date" }, "to": { "description": "ISO date YYYY-MM-DD", "type": "string", "format": "date" }, "weekdays": { "type": "array", "items": { "javaType": "com.sos.joc.model.calendar.WeekDays", "type": "object", "required": [ "days" ], "properties": { "from": { "description": "ISO date YYYY-MM-DD", "type": "string", "format": "date" }, "to": { "description": "ISO date YYYY-MM-DD", "type": "string", "format": "date" }, "days": { "type": "array", "items": { "description": "digit from 0-6, 0=Sunday, 1=Monday, ..., 6=Saturday, 7=Sunday (again)", "type": "integer", "minimum": 0, "maximum": 7 } } } } }, "monthdays": { "type": "array", "items": { "javaType": "com.sos.joc.model.calendar.MonthDays", "type": "object", "properties": { "from": { "description": "ISO date YYYY-MM-DD", "type": "string", "format": "date" }, "to": { "description": "ISO date YYYY-MM-DD", "type": "string", "format": "date" }, "days": { "type": "array", "items": { "description": "digit from 1-31", "type": "integer", "minimum": 1, "maximum": 31 } }, "weeklyDays": { "type": "array", "items": { "javaType": "com.sos.joc.model.calendar.WeeklyDay", "type": "object", "properties": { "day": { "description": "digit from 0-6, 0=Sunday, 1=Monday, ..., 6=Saturday, 7=Sunday (again)", "type": "integer", "minimum": 0, "maximum": 7 }, "weekOfMonth": { "type": "integer", "minimum": 1, "maximum": 5 } } } } } } }, "ultimos": { "type": "array", "items": { "javaType": "com.sos.joc.model.calendar.MonthDays", "type": "object", "properties": { "from": { "description": "ISO date YYYY-MM-DD", "type": "string", "format": "date" }, "to": { "description": "ISO date YYYY-MM-DD", "type": "string", "format": "date" }, "days": { "type": "array", "items": { "description": "digit from 1-31", "type": "integer", "minimum": 1, "maximum": 31 } }, "weeklyDays": { "type": "array", "items": { "javaType": "com.sos.joc.model.calendar.WeeklyDay", "type": "object", "properties": { "day": { "description": "digit from 0-6, 0=Sunday, 1=Monday, ..., 6=Saturday, 7=Sunday (again)", "type": "integer", "minimum": 0, "maximum": 7 }, "weekOfMonth": { "type": "integer", "minimum": 1, "maximum": 5 } } } } } } } } } }, "holidays": { "type": "array", "items": { "javaType": "com.sos.joc.model.calendar.Holidays", "type": "object", "properties": { "nationalCalendar": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "dates": { "type": "array", "items": { "description": "ISO date YYYY-MM-DD", "type": "string", "format": "date" } } } } }, "repetitions": { "type": "array", "items": { "javaType": "com.sos.joc.model.calendar.Repetition", "type": "object", "required": [ "repetition" ], "properties": { "from": { "description": "ISO date YYYY-MM-DD", "type": "string", "format": "date" }, "to": { "description": "ISO date YYYY-MM-DD", "type": "string", "format": "date" }, "repetition": { "javaType": "com.sos.joc.model.calendar.RepetitionText", "type": "string", "enum": [ "DAILY", "WEEKLY", "MONTHLY", "YEARLY" ] }, "step": { "type": "integer", "minimum": 1, "default": 1 } } } } } }, "excludes": { "javaType": "com.sos.joc.model.calendar.Frequencies", "type": "object", "properties": { "dates": { "type": "array", "items": { "description": "ISO date YYYY-MM-DD", "type": "string", "format": "date" } }, "weekdays": { "type": "array", "items": { "javaType": "com.sos.joc.model.calendar.WeekDays", "type": "object", "required": [ "days" ], "properties": { "from": { "description": "ISO date YYYY-MM-DD", "type": "string", "format": "date" }, "to": { "description": "ISO date YYYY-MM-DD", "type": "string", "format": "date" }, "days": { "type": "array", "items": { "description": "digit from 0-6, 0=Sunday, 1=Monday, ..., 6=Saturday, 7=Sunday (again)", "type": "integer", "minimum": 0, "maximum": 7 } } } } }, "monthdays": { "type": "array", "items": { "javaType": "com.sos.joc.model.calendar.MonthDays", "type": "object", "properties": { "from": { "description": "ISO date YYYY-MM-DD", "type": "string", "format": "date" }, "to": { "description": "ISO date YYYY-MM-DD", "type": "string", "format": "date" }, "days": { "type": "array", "items": { "description": "digit from 1-31", "type": "integer", "minimum": 1, "maximum": 31 } }, "weeklyDays": { "type": "array", "items": { "javaType": "com.sos.joc.model.calendar.WeeklyDay", "type": "object", "properties": { "day": { "description": "digit from 0-6, 0=Sunday, 1=Monday, ..., 6=Saturday, 7=Sunday (again)", "type": "integer", "minimum": 0, "maximum": 7 }, "weekOfMonth": { "type": "integer", "minimum": 1, "maximum": 5 } } } } } } }, "ultimos": { "type": "array", "items": { "javaType": "com.sos.joc.model.calendar.MonthDays", "type": "object", "properties": { "from": { "description": "ISO date YYYY-MM-DD", "type": "string", "format": "date" }, "to": { "description": "ISO date YYYY-MM-DD", "type": "string", "format": "date" }, "days": { "type": "array", "items": { "description": "digit from 1-31", "type": "integer", "minimum": 1, "maximum": 31 } }, "weeklyDays": { "type": "array", "items": { "javaType": "com.sos.joc.model.calendar.WeeklyDay", "type": "object", "properties": { "day": { "description": "digit from 0-6, 0=Sunday, 1=Monday, ..., 6=Saturday, 7=Sunday (again)", "type": "integer", "minimum": 0, "maximum": 7 }, "weekOfMonth": { "type": "integer", "minimum": 1, "maximum": 5 } } } } } } }, "months": { "type": "array", "items": { "javaType": "com.sos.joc.model.calendar.Months", "type": "object", "required": [ "months" ], "properties": { "months": { "type": "array", "items": { "type": "integer", "minimum": 1, "maximum": 12 } }, "from": { "description": "ISO date YYYY-MM-DD", "type": "string", "format": "date" }, "to": { "description": "ISO date YYYY-MM-DD", "type": "string", "format": "date" }, "weekdays": { "type": "array", "items": { "javaType": "com.sos.joc.model.calendar.WeekDays", "type": "object", "required": [ "days" ], "properties": { "from": { "description": "ISO date YYYY-MM-DD", "type": "string", "format": "date" }, "to": { "description": "ISO date YYYY-MM-DD", "type": "string", "format": "date" }, "days": { "type": "array", "items": { "description": "digit from 0-6, 0=Sunday, 1=Monday, ..., 6=Saturday, 7=Sunday (again)", "type": "integer", "minimum": 0, "maximum": 7 } } } } }, "monthdays": { "type": "array", "items": { "javaType": "com.sos.joc.model.calendar.MonthDays", "type": "object", "properties": { "from": { "description": "ISO date YYYY-MM-DD", "type": "string", "format": "date" }, "to": { "description": "ISO date YYYY-MM-DD", "type": "string", "format": "date" }, "days": { "type": "array", "items": { "description": "digit from 1-31", "type": "integer", "minimum": 1, "maximum": 31 } }, "weeklyDays": { "type": "array", "items": { "javaType": "com.sos.joc.model.calendar.WeeklyDay", "type": "object", "properties": { "day": { "description": "digit from 0-6, 0=Sunday, 1=Monday, ..., 6=Saturday, 7=Sunday (again)", "type": "integer", "minimum": 0, "maximum": 7 }, "weekOfMonth": { "type": "integer", "minimum": 1, "maximum": 5 } } } } } } }, "ultimos": { "type": "array", "items": { "javaType": "com.sos.joc.model.calendar.MonthDays", "type": "object", "properties": { "from": { "description": "ISO date YYYY-MM-DD", "type": "string", "format": "date" }, "to": { "description": "ISO date YYYY-MM-DD", "type": "string", "format": "date" }, "days": { "type": "array", "items": { "description": "digit from 1-31", "type": "integer", "minimum": 1, "maximum": 31 } }, "weeklyDays": { "type": "array", "items": { "javaType": "com.sos.joc.model.calendar.WeeklyDay", "type": "object", "properties": { "day": { "description": "digit from 0-6, 0=Sunday, 1=Monday, ..., 6=Saturday, 7=Sunday (again)", "type": "integer", "minimum": 0, "maximum": 7 }, "weekOfMonth": { "type": "integer", "minimum": 1, "maximum": 5 } } } } } } } } } }, "holidays": { "type": "array", "items": { "javaType": "com.sos.joc.model.calendar.Holidays", "type": "object", "properties": { "nationalCalendar": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "dates": { "type": "array", "items": { "description": "ISO date YYYY-MM-DD", "type": "string", "format": "date" } } } } }, "repetitions": { "type": "array", "items": { "javaType": "com.sos.joc.model.calendar.Repetition", "type": "object", "required": [ "repetition" ], "properties": { "from": { "description": "ISO date YYYY-MM-DD", "type": "string", "format": "date" }, "to": { "description": "ISO date YYYY-MM-DD", "type": "string", "format": "date" }, "repetition": { "javaType": "com.sos.joc.model.calendar.RepetitionText", "type": "string", "enum": [ "DAILY", "WEEKLY", "MONTHLY", "YEARLY" ] }, "step": { "type": "integer", "minimum": 1, "default": 1 } } } } } }, "usedBy": { "javaType": "com.sos.joc.model.calendar.UsedBy", "type": "object", "properties": { "deliveryDate": { "description": "Date time. Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ", "type": "string", "format": "date-time" }, "jobs": { "type": "array", "items": { "description": "absolute path based on live folder of a JobScheduler object.", "type": "string", "pattern": "^(/\|(/[^/\\<>?:\"\|]+)+)$", "maxLength": 255 } }, "orders": { "type": "array", "items": { "description": "absolute path based on live folder of a JobScheduler object.", "type": "string", "pattern": "^(/\|(/[^/\\<>?:\"\|]+)+)$", "maxLength": 255 } }, "schedules": { "type": "array", "items": { "description": "absolute path based on live folder of a JobScheduler object.", "type": "string", "pattern": "^(/\|(/[^/\\<>?:\"\|]+)+)$", "maxLength": 255 } } } } } } } } } } } { "deliveryDate": "2020-01-06T20:34:51Z", "runTime": { "letRun": "false", "runOnce": "false", "monthdays": { "days": [{ "day": "20", "periods": [{ "singleStart": "10:00", "letRun": "false", "runOnce": "false", "whenHoliday": "suppress" }] }] } } } { "deliveryDate": "2020-01-06T20:34:51Z", "runTime": { "letRun": "false", "runOnce": "false", "monthdays": { "days": [{ "day": "20", "periods": [{ "singleStart": "10:00", "letRun": "false", "runOnce": "false", "whenHoliday": "suppress" }] }] } } }
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 'run_time'	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	'run_time' 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": "run_time failed!" } } { "deliveryDate": "2016-05-05T21:13:35Z", "surveyDate": "2016-05-05T21:13:33Z", "error": { "code": "JOC-420", "message": "run_time 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 }