|
model | example
{
"title": "modify order commands",
"id": "schemas/order/modifyOrders",
"$schema": "http://json-schema.org/draft-04/schema#",
"javaType": "com.sos.joc.model.order.ModifyOrders",
"type": "object",
"required": [
"jobschedulerId",
"orders"
],
"properties": {
"jobschedulerId": {
"type": "string"
},
"orders": {
"type": "array",
"items": {
"id": "schemas/order/modifyOrder",
"javaType": "com.sos.joc.model.order.ModifyOrder",
"type": "object",
"description": "NOTE: orderId is required too except for add order",
"required": [
"jobChain"
],
"properties": {
"orderId": {
"type": "string"
},
"jobChain": {
"id": "schemas/common/path",
"description": "absolute path based on live folder of a JobScheduler object.",
"type": "string",
"pattern": "/([^/]+/)*[^/]+"
},
"state": {
"description": "the name of the node",
"type": "string"
},
"endState": {
"description": "the name of the end node",
"type": "string"
},
"at": {
"id": "schemas/common/timestampWithNow",
"description": "ISO format yyyy-mm-dd HH:MM[:SS] or now or now + HH:MM[:SS] or now + SECONDS",
"type": "string",
"oneOf": [{
"pattern": "now(\\s*\\+\\s*(\\d+|\\d{1,2}:\\d{1,2}(:\\d{1,2})?))?"
}, {
"format": "date-time"
}]
},
"timeZone": {
"description": "see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones",
"type": "string"
},
"resume": {
"description": "only useful when changing order state of suspended orders",
"type": "boolean"
},
"removeSetback": {
"description": "only useful when order has a setback",
"type": "boolean"
},
"title": {
"type": "string"
},
"priority": {
"id": "schemas/common/nonNegativeInteger",
"type": "integer",
"minimum": 0
},
"params": {
"id": "schemas/common/nameValuePairs",
"type": "array",
"items": {
"javaType": "com.sos.joc.model.common.NameValuePair",
"type": "object",
"required": [
"name",
"value"
],
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
}
}
},
"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",
"type": "string"
},
"calendars": {
"type": "array",
"items": {
"id": "schemas/calendar/calendar",
"javaType": "com.sos.joc.model.calendar.Calendar",
"type": "object",
"properties": {
"id": {
"id": "schemas/common/nonNegativeLong",
"type": "string",
"format": "utc-millisec"
},
"path": {
"id": "schemas/common/path",
"description": "absolute path based on live folder of a JobScheduler object.",
"type": "string",
"pattern": "/([^/]+/)*[^/]+"
},
"name": {
"type": "string"
},
"basedOn": {
"id": "schemas/common/path",
"description": "absolute path based on live folder of a JobScheduler object.",
"type": "string",
"pattern": "/([^/]+/)*[^/]+"
},
"type": {
"id": "schemas/calendar/calendarType",
"javaType": "com.sos.joc.model.calendar.CalendarType",
"type": "string",
"enum": [
"WORKING_DAYS",
"NON_WORKING_DAYS",
"JOB",
"ORDER",
"SCHEDULE"
],
"default": "WORKING_DAYS"
},
"category": {
"type": "string"
},
"title": {
"type": "string"
},
"from": {
"id": "schemas/common/date",
"description": "ISO date YYYY-MM-DD",
"type": "string",
"format": "date"
},
"to": {
"id": "schemas/common/date",
"description": "ISO date YYYY-MM-DD",
"type": "string",
"format": "date"
},
"periods": {
"type": "array",
"items": {
"id": "schemas/calendar/periods",
"javaType": "com.sos.joc.model.calendar.Period",
"type": "object",
"properties": {
"singleStart": {
"type": "string"
},
"begin": {
"type": "string"
},
"end": {
"type": "string"
},
"repeat": {
"type": "string"
},
"absoluteRepeat": {
"type": "string"
},
"whenHoliday": {
"type": "string"
}
}
}
},
"includes": {
"id": "schemas/calendar/frequencies",
"javaType": "com.sos.joc.model.calendar.Frequencies",
"type": "object",
"properties": {
"dates": {
"type": "array",
"items": {
"id": "schemas/common/date",
"description": "ISO date YYYY-MM-DD",
"type": "string",
"format": "date"
}
},
"weekdays": {
"type": "array",
"items": {
"id": "schemas/calendar/weekDays",
"javaType": "com.sos.joc.model.calendar.WeekDays",
"type": "object",
"required": [
"days"
],
"properties": {
"from": {
"id": "schemas/common/date",
"description": "ISO date YYYY-MM-DD",
"type": "string",
"format": "date"
},
"to": {
"id": "schemas/common/date",
"description": "ISO date YYYY-MM-DD",
"type": "string",
"format": "date"
},
"days": {
"type": "array",
"items": {
"id": "schemas/calendar/dayOfWeek",
"description": "digit from 0-6, 0=Sunday, 1=Monday, ..., 6=Saturday",
"type": "integer",
"minimum": 0,
"maximum": 6
}
}
}
}
},
"monthdays": {
"type": "array",
"items": {
"id": "schemas/calendar/monthDays",
"javaType": "com.sos.joc.model.calendar.MonthDays",
"type": "object",
"properties": {
"from": {
"id": "schemas/common/date",
"description": "ISO date YYYY-MM-DD",
"type": "string",
"format": "date"
},
"to": {
"id": "schemas/common/date",
"description": "ISO date YYYY-MM-DD",
"type": "string",
"format": "date"
},
"days": {
"type": "array",
"items": {
"id": "schemas/calendar/dayOfWeek",
"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": {
"id": "schemas/calendar/dayOfWeek",
"description": "digit from 0-6, 0=Sunday, 1=Monday, ..., 6=Saturday",
"type": "integer",
"minimum": 0,
"maximum": 6
},
"weekOfMonth": {
"type": "integer",
"minimum": 1,
"maximum": 5
}
}
}
}
}
}
},
"ultimos": {
"type": "array",
"items": {
"id": "schemas/calendar/monthDays",
"javaType": "com.sos.joc.model.calendar.MonthDays",
"type": "object",
"properties": {
"from": {
"id": "schemas/common/date",
"description": "ISO date YYYY-MM-DD",
"type": "string",
"format": "date"
},
"to": {
"id": "schemas/common/date",
"description": "ISO date YYYY-MM-DD",
"type": "string",
"format": "date"
},
"days": {
"type": "array",
"items": {
"id": "schemas/calendar/dayOfWeek",
"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": {
"id": "schemas/calendar/dayOfWeek",
"description": "digit from 0-6, 0=Sunday, 1=Monday, ..., 6=Saturday",
"type": "integer",
"minimum": 0,
"maximum": 6
},
"weekOfMonth": {
"type": "integer",
"minimum": 1,
"maximum": 5
}
}
}
}
}
}
},
"months": {
"type": "array",
"items": {
"id": "schemas/calendar/month",
"javaType": "com.sos.joc.model.calendar.Months",
"type": "object",
"required": [
"months"
],
"properties": {
"months": {
"type": "array",
"items": {
"type": "integer",
"minimum": 1,
"maximum": 12
}
},
"from": {
"id": "schemas/common/date",
"description": "ISO date YYYY-MM-DD",
"type": "string",
"format": "date"
},
"to": {
"id": "schemas/common/date",
"description": "ISO date YYYY-MM-DD",
"type": "string",
"format": "date"
},
"weekdays": {
"type": "array",
"items": {
"id": "schemas/calendar/weekDays",
"javaType": "com.sos.joc.model.calendar.WeekDays",
"type": "object",
"required": [
"days"
],
"properties": {
"from": {
"id": "schemas/common/date",
"description": "ISO date YYYY-MM-DD",
"type": "string",
"format": "date"
},
"to": {
"id": "schemas/common/date",
"description": "ISO date YYYY-MM-DD",
"type": "string",
"format": "date"
},
"days": {
"type": "array",
"items": {
"id": "schemas/calendar/dayOfWeek",
"description": "digit from 0-6, 0=Sunday, 1=Monday, ..., 6=Saturday",
"type": "integer",
"minimum": 0,
"maximum": 6
}
}
}
}
},
"monthdays": {
"type": "array",
"items": {
"id": "schemas/calendar/monthDays",
"javaType": "com.sos.joc.model.calendar.MonthDays",
"type": "object",
"properties": {
"from": {
"id": "schemas/common/date",
"description": "ISO date YYYY-MM-DD",
"type": "string",
"format": "date"
},
"to": {
"id": "schemas/common/date",
"description": "ISO date YYYY-MM-DD",
"type": "string",
"format": "date"
},
"days": {
"type": "array",
"items": {
"id": "schemas/calendar/dayOfWeek",
"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": {
"id": "schemas/calendar/dayOfWeek",
"description": "digit from 0-6, 0=Sunday, 1=Monday, ..., 6=Saturday",
"type": "integer",
"minimum": 0,
"maximum": 6
},
"weekOfMonth": {
"type": "integer",
"minimum": 1,
"maximum": 5
}
}
}
}
}
}
},
"ultimos": {
"type": "array",
"items": {
"id": "schemas/calendar/monthDays",
"javaType": "com.sos.joc.model.calendar.MonthDays",
"type": "object",
"properties": {
"from": {
"id": "schemas/common/date",
"description": "ISO date YYYY-MM-DD",
"type": "string",
"format": "date"
},
"to": {
"id": "schemas/common/date",
"description": "ISO date YYYY-MM-DD",
"type": "string",
"format": "date"
},
"days": {
"type": "array",
"items": {
"id": "schemas/calendar/dayOfWeek",
"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": {
"id": "schemas/calendar/dayOfWeek",
"description": "digit from 0-6, 0=Sunday, 1=Monday, ..., 6=Saturday",
"type": "integer",
"minimum": 0,
"maximum": 6
},
"weekOfMonth": {
"type": "integer",
"minimum": 1,
"maximum": 5
}
}
}
}
}
}
}
}
}
},
"holidays": {
"type": "array",
"items": {
"id": "schemas/calendar/holidays",
"javaType": "com.sos.joc.model.calendar.Holidays",
"type": "object",
"properties": {
"nationalCalendar": {
"type": "string"
},
"dates": {
"type": "array",
"items": {
"id": "schemas/common/date",
"description": "ISO date YYYY-MM-DD",
"type": "string",
"format": "date"
}
}
}
}
},
"repetitions": {
"type": "array",
"items": {
"id": "schemas/calendar/every",
"javaType": "com.sos.joc.model.calendar.Repetition",
"type": "object",
"required": [
"repetition"
],
"properties": {
"from": {
"id": "schemas/common/date",
"description": "ISO date YYYY-MM-DD",
"type": "string",
"format": "date"
},
"to": {
"id": "schemas/common/date",
"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": {
"id": "schemas/calendar/frequencies",
"javaType": "com.sos.joc.model.calendar.Frequencies",
"type": "object",
"properties": {
"dates": {
"type": "array",
"items": {
"id": "schemas/common/date",
"description": "ISO date YYYY-MM-DD",
"type": "string",
"format": "date"
}
},
"weekdays": {
"type": "array",
"items": {
"id": "schemas/calendar/weekDays",
"javaType": "com.sos.joc.model.calendar.WeekDays",
"type": "object",
"required": [
"days"
],
"properties": {
"from": {
"id": "schemas/common/date",
"description": "ISO date YYYY-MM-DD",
"type": "string",
"format": "date"
},
"to": {
"id": "schemas/common/date",
"description": "ISO date YYYY-MM-DD",
"type": "string",
"format": "date"
},
"days": {
"type": "array",
"items": {
"id": "schemas/calendar/dayOfWeek",
"description": "digit from 0-6, 0=Sunday, 1=Monday, ..., 6=Saturday",
"type": "integer",
"minimum": 0,
"maximum": 6
}
}
}
}
},
"monthdays": {
"type": "array",
"items": {
"id": "schemas/calendar/monthDays",
"javaType": "com.sos.joc.model.calendar.MonthDays",
"type": "object",
"properties": {
"from": {
"id": "schemas/common/date",
"description": "ISO date YYYY-MM-DD",
"type": "string",
"format": "date"
},
"to": {
"id": "schemas/common/date",
"description": "ISO date YYYY-MM-DD",
"type": "string",
"format": "date"
},
"days": {
"type": "array",
"items": {
"id": "schemas/calendar/dayOfWeek",
"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": {
"id": "schemas/calendar/dayOfWeek",
"description": "digit from 0-6, 0=Sunday, 1=Monday, ..., 6=Saturday",
"type": "integer",
"minimum": 0,
"maximum": 6
},
"weekOfMonth": {
"type": "integer",
"minimum": 1,
"maximum": 5
}
}
}
}
}
}
},
"ultimos": {
"type": "array",
"items": {
"id": "schemas/calendar/monthDays",
"javaType": "com.sos.joc.model.calendar.MonthDays",
"type": "object",
"properties": {
"from": {
"id": "schemas/common/date",
"description": "ISO date YYYY-MM-DD",
"type": "string",
"format": "date"
},
"to": {
"id": "schemas/common/date",
"description": "ISO date YYYY-MM-DD",
"type": "string",
"format": "date"
},
"days": {
"type": "array",
"items": {
"id": "schemas/calendar/dayOfWeek",
"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": {
"id": "schemas/calendar/dayOfWeek",
"description": "digit from 0-6, 0=Sunday, 1=Monday, ..., 6=Saturday",
"type": "integer",
"minimum": 0,
"maximum": 6
},
"weekOfMonth": {
"type": "integer",
"minimum": 1,
"maximum": 5
}
}
}
}
}
}
},
"months": {
"type": "array",
"items": {
"id": "schemas/calendar/month",
"javaType": "com.sos.joc.model.calendar.Months",
"type": "object",
"required": [
"months"
],
"properties": {
"months": {
"type": "array",
"items": {
"type": "integer",
"minimum": 1,
"maximum": 12
}
},
"from": {
"id": "schemas/common/date",
"description": "ISO date YYYY-MM-DD",
"type": "string",
"format": "date"
},
"to": {
"id": "schemas/common/date",
"description": "ISO date YYYY-MM-DD",
"type": "string",
"format": "date"
},
"weekdays": {
"type": "array",
"items": {
"id": "schemas/calendar/weekDays",
"javaType": "com.sos.joc.model.calendar.WeekDays",
"type": "object",
"required": [
"days"
],
"properties": {
"from": {
"id": "schemas/common/date",
"description": "ISO date YYYY-MM-DD",
"type": "string",
"format": "date"
},
"to": {
"id": "schemas/common/date",
"description": "ISO date YYYY-MM-DD",
"type": "string",
"format": "date"
},
"days": {
"type": "array",
"items": {
"id": "schemas/calendar/dayOfWeek",
"description": "digit from 0-6, 0=Sunday, 1=Monday, ..., 6=Saturday",
"type": "integer",
"minimum": 0,
"maximum": 6
}
}
}
}
},
"monthdays": {
"type": "array",
"items": {
"id": "schemas/calendar/monthDays",
"javaType": "com.sos.joc.model.calendar.MonthDays",
"type": "object",
"properties": {
"from": {
"id": "schemas/common/date",
"description": "ISO date YYYY-MM-DD",
"type": "string",
"format": "date"
},
"to": {
"id": "schemas/common/date",
"description": "ISO date YYYY-MM-DD",
"type": "string",
"format": "date"
},
"days": {
"type": "array",
"items": {
"id": "schemas/calendar/dayOfWeek",
"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": {
"id": "schemas/calendar/dayOfWeek",
"description": "digit from 0-6, 0=Sunday, 1=Monday, ..., 6=Saturday",
"type": "integer",
"minimum": 0,
"maximum": 6
},
"weekOfMonth": {
"type": "integer",
"minimum": 1,
"maximum": 5
}
}
}
}
}
}
},
"ultimos": {
"type": "array",
"items": {
"id": "schemas/calendar/monthDays",
"javaType": "com.sos.joc.model.calendar.MonthDays",
"type": "object",
"properties": {
"from": {
"id": "schemas/common/date",
"description": "ISO date YYYY-MM-DD",
"type": "string",
"format": "date"
},
"to": {
"id": "schemas/common/date",
"description": "ISO date YYYY-MM-DD",
"type": "string",
"format": "date"
},
"days": {
"type": "array",
"items": {
"id": "schemas/calendar/dayOfWeek",
"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": {
"id": "schemas/calendar/dayOfWeek",
"description": "digit from 0-6, 0=Sunday, 1=Monday, ..., 6=Saturday",
"type": "integer",
"minimum": 0,
"maximum": 6
},
"weekOfMonth": {
"type": "integer",
"minimum": 1,
"maximum": 5
}
}
}
}
}
}
}
}
}
},
"holidays": {
"type": "array",
"items": {
"id": "schemas/calendar/holidays",
"javaType": "com.sos.joc.model.calendar.Holidays",
"type": "object",
"properties": {
"nationalCalendar": {
"type": "string"
},
"dates": {
"type": "array",
"items": {
"id": "schemas/common/date",
"description": "ISO date YYYY-MM-DD",
"type": "string",
"format": "date"
}
}
}
}
},
"repetitions": {
"type": "array",
"items": {
"id": "schemas/calendar/every",
"javaType": "com.sos.joc.model.calendar.Repetition",
"type": "object",
"required": [
"repetition"
],
"properties": {
"from": {
"id": "schemas/common/date",
"description": "ISO date YYYY-MM-DD",
"type": "string",
"format": "date"
},
"to": {
"id": "schemas/common/date",
"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": {
"id": "schemas/calendar/usedBy",
"javaType": "com.sos.joc.model.calendar.UsedBy",
"type": "object",
"required": [
"deliveryDate"
],
"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"
},
"jobs": {
"type": "array",
"items": {
"id": "schemas/common/path",
"description": "absolute path based on live folder of a JobScheduler object.",
"type": "string",
"pattern": "/([^/]+/)*[^/]+"
}
},
"orders": {
"type": "array",
"items": {
"id": "schemas/common/path",
"description": "absolute path based on live folder of a JobScheduler object.",
"type": "string",
"pattern": "/([^/]+/)*[^/]+"
}
},
"schedules": {
"type": "array",
"items": {
"id": "schemas/common/path",
"description": "absolute path based on live folder of a JobScheduler object.",
"type": "string",
"pattern": "/([^/]+/)*[^/]+"
}
}
}
}
}
}
}
}
}
},
"auditLog": {
"id": "schemas/common/auditParams",
"javaType": "com.sos.joc.model.audit.AuditParams",
"type": "object",
"properties": {
"comment": {
"type": "string"
},
"timeSpent": {
"id": "schemas/common/nonNegativeInteger",
"type": "integer",
"minimum": 0
},
"ticketLink": {
"type": "string"
}
}
}
}
}
{ "jobschedulerId": "scheduler", "orders": [{ "orderId": "order1", "jobChain": "/test/testJobChain", "runTime": "<run_time><weekdays><day day='1 2 3 4 5'><period single_start='12:00'/></day></weekdays></run_time>" }, { "orderId": "order2", "jobChain": "/test/testJobChain", "runTime": "<run_time><weekdays><day day='1 2 3 4 5'><period single_start='12:00'/></day></weekdays></run_time>" }, { "orderId": "order3", "jobChain": "/test/testJobChain", "runTime": "<run_time><weekdays><day day='1 2 3 4 5'><period single_start='12:00'/></day></weekdays></run_time>" }, { "orderId": "order4", "jobChain": "/test/testJobChain", "runTime": "<run_time><weekdays><day day='1 2 3 4 5'><period single_start='12:00'/></day></weekdays></run_time>" }, { "orderId": "order5", "jobChain": "/test/testJobChain", "runTime": "<run_time><weekdays><day day='1 2 3 4 5'><period single_start='12:00'/></day></weekdays></run_time>" }] }
{
"jobschedulerId": "scheduler",
"orders": [{
"orderId": "order1",
"jobChain": "/test/testJobChain",
"runTime": "<run_time><weekdays><day day='1 2 3 4 5'><period single_start='12:00'/></day></weekdays></run_time>"
}, {
"orderId": "order2",
"jobChain": "/test/testJobChain",
"runTime": "<run_time><weekdays><day day='1 2 3 4 5'><period single_start='12:00'/></day></weekdays></run_time>"
}, {
"orderId": "order3",
"jobChain": "/test/testJobChain",
"runTime": "<run_time><weekdays><day day='1 2 3 4 5'><period single_start='12:00'/></day></weekdays></run_time>"
}, {
"orderId": "order4",
"jobChain": "/test/testJobChain",
"runTime": "<run_time><weekdays><day day='1 2 3 4 5'><period single_start='12:00'/></day></weekdays></run_time>"
}, {
"orderId": "order5",
"jobChain": "/test/testJobChain",
"runTime": "<run_time><weekdays><day day='1 2 3 4 5'><period single_start='12:00'/></day></weekdays></run_time>"
}]
}
|
|