JOC API

/jobstreams/sessions

POST

A list of sessions.

Parameters in the POST body schema

Name	Type	Description	Example	Default
`jobschedulerId`	required, string	JobScheduler Master ID	scheduler
`session`	optional, Array	A list of session ids for instances that should be in the result list
`jobStream`	optional, string	Instances for this job job stream will be in the result	myJobStream
`jobStreamId`	optional, Number	Instances for this job job stream-id will be in the result	myJobStream
`jobStreamStarterId`	optional, Number	Instances that have been started by this starter	4711
`status`	optional, string	possible values are running and completed. To consider instances with this state	running
`dateFrom`	optional, String (yyyy-mm-dd)	To define a interval for the instances	2021-01-01
`dateTo`	optional, String (yyyy-mm-dd)	To define a interval for the instances	2021-01-01
`timeZone`	optional, string	If this parameter is set then it beats the time offset in `dateFrom` and `dateTo` See here the list for available time zones.	Berlin/Europe
`limit`	optional, integer	Restricts the number of responsed records, -1=unlimited	5000	10000

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": "JobStreamSessions Filter",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "description": "Reset Workflow, unconsume expressions",
    "javaType": "com.sos.joc.model.jobstreams.JobStreamSessionsFilter",
    "type": "object",
    "required": [
        "jobschedulerId"
    ],
    "properties": {
        "jobschedulerId": {
            "type": "string",
            "pattern": "^[^/\\<>?:\"|*]*$",
            "maxLength": 100
        },
        "session": {
            "type": "array",
            "items": {
                "type": "string",
                "pattern": "^[^<>]*$",
                "maxLength": 255
            }
        },
        "jobStream": {
            "type": "string",
            "pattern": "^[^<>]*$",
            "maxLength": 255
        },
        "jobStreamId": {
            "type": "number",
            "format": "utc-millisec",
            "minimum": 0
        },
        "jobStreamStarterId": {
            "type": "number",
            "format": "utc-millisec",
            "minimum": 0
        },
        "status": {
            "type": "string",
            "pattern": "^[^<>]*$",
            "maxLength": 255
        },
        "dateFrom": {
            "description": "0 or [number][smhdwMy] (where smhdwMy unit for second, minute, etc) or ISO 8601 timestamp",
            "type": "string",
            "pattern": "^([+-]?0|([+-]?[0-9]+[smhdwMy])+|\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}([,.]\\d{1,3})?)(Z|[+-]\\d{2}(:?\\d{2})?)?$"
        },
        "dateTo": {
            "description": "0 or [number][smhdwMy] (where smhdwMy unit for second, minute, etc) or ISO 8601 timestamp",
            "type": "string",
            "pattern": "^([+-]?0|([+-]?[0-9]+[smhdwMy])+|\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}([,.]\\d{1,3})?)(Z|[+-]\\d{2}(:?\\d{2})?)?$"
        },
        "timeZone": {
            "type": "string",
            "pattern": "^[^<>]*$",
            "maxLength": 255
        },
        "limit": {
            "type": "integer",
            "default": 10000
        }
    }
}

{ "deliveryDate": "2021-03-23T19:11:14.884Z", "jobstreamSessions": [{ "ended": "2021-03-23T19:10:06Z", "id": 18065, "jobStream": "test1", "jobStreamId": 1975, "jobStreamStarter": { "jobStreamStarterId": 1895, "jobs": [], "nextStart": "2021-03-23T20:05:00Z", "params": [], "state": "active", "title": "aa" }, "jobschedulerId": "scheduler_joc_cockpit", "jobstreamTasks": [{ "created": "2021-03-23T19:10:04Z", "id": 121564, "job": "/jobstream/test1/xjob3", "taskId": 84459 }, { "created": "2021-03-23T19:10:02Z", "id": 121563, "job": "/jobstream/test1/xjob2", "taskId": 84458 }, { "created": "2021-03-23T19:10:00Z", "id": 121562, "job": "/jobstream/test1/xjob11", "taskId": 84457 }], "running": false, "session": "ab83570f-f6a7-4030-86b2-e62cccf01c19", "started": "2021-03-23T19:10:00Z" }, { "ended": "2021-03-23T18:15:08Z", "id": 18064, "jobStream": "test1", "jobStreamId": 1975, "jobStreamStarter": { "jobStreamStarterId": 1895, "jobs": [], "nextStart": "2021-03-23T20:05:00Z", "params": [], "state": "active", "title": "aa" }, "jobschedulerId": "scheduler_joc_cockpit", "jobstreamTasks": [{ "created": "2021-03-23T18:15:06Z", "id": 121561, "job": "/jobstream/test1/xjob3", "taskId": 84456 }, { "created": "2021-03-23T18:15:04Z", "id": 121560, "job": "/jobstream/test1/xjob2", "taskId": 84455 }, { "created": "2021-03-23T18:15:02Z", "id": 121559, "job": "/jobstream/test1/xjob11", "taskId": 84454 }], "running": false, "session": "ffc39e0b-9125-4517-bb5b-1bff1db756fd", "started": "2021-03-23T18:15:00Z" }, { "ended": "2021-03-23T17:20:06Z", "id": 18063, "jobStream": "test1", "jobStreamId": 1975, "jobStreamStarter": { "jobStreamStarterId": 1895, "jobs": [], "nextStart": "2021-03-23T20:05:00Z", "params": [], "state": "active", "title": "aa" }, "jobschedulerId": "scheduler_joc_cockpit", "jobstreamTasks": [{ "created": "2021-03-23T17:20:04Z", "id": 121558, "job": "/jobstream/test1/xjob3", "taskId": 84453 }, { "created": "2021-03-23T17:20:02Z", "id": 121557, "job": "/jobstream/test1/xjob2", "taskId": 84452 }, { "created": "2021-03-23T17:20:00Z", "id": 121556, "job": "/jobstream/test1/xjob11", "taskId": 84451 }], "running": false, "session": "1560cf56-c9f0-4dfe-8962-efb819360252", "started": "2021-03-23T17:20:00Z" }] }

{
    "deliveryDate": "2021-03-23T19:11:14.884Z",
    "jobstreamSessions": [{
        "ended": "2021-03-23T19:10:06Z",
        "id": 18065,
        "jobStream": "test1",
        "jobStreamId": 1975,
        "jobStreamStarter": {
            "jobStreamStarterId": 1895,
            "jobs": [],
            "nextStart": "2021-03-23T20:05:00Z",
            "params": [],
            "state": "active",
            "title": "aa"
        },
        "jobschedulerId": "scheduler_joc_cockpit",
        "jobstreamTasks": [{
            "created": "2021-03-23T19:10:04Z",
            "id": 121564,
            "job": "/jobstream/test1/xjob3",
            "taskId": 84459
        }, {
            "created": "2021-03-23T19:10:02Z",
            "id": 121563,
            "job": "/jobstream/test1/xjob2",
            "taskId": 84458
        }, {
            "created": "2021-03-23T19:10:00Z",
            "id": 121562,
            "job": "/jobstream/test1/xjob11",
            "taskId": 84457
        }],
        "running": false,
        "session": "ab83570f-f6a7-4030-86b2-e62cccf01c19",
        "started": "2021-03-23T19:10:00Z"
    }, {
        "ended": "2021-03-23T18:15:08Z",
        "id": 18064,
        "jobStream": "test1",
        "jobStreamId": 1975,
        "jobStreamStarter": {
            "jobStreamStarterId": 1895,
            "jobs": [],
            "nextStart": "2021-03-23T20:05:00Z",
            "params": [],
            "state": "active",
            "title": "aa"
        },
        "jobschedulerId": "scheduler_joc_cockpit",
        "jobstreamTasks": [{
            "created": "2021-03-23T18:15:06Z",
            "id": 121561,
            "job": "/jobstream/test1/xjob3",
            "taskId": 84456
        }, {
            "created": "2021-03-23T18:15:04Z",
            "id": 121560,
            "job": "/jobstream/test1/xjob2",
            "taskId": 84455
        }, {
            "created": "2021-03-23T18:15:02Z",
            "id": 121559,
            "job": "/jobstream/test1/xjob11",
            "taskId": 84454
        }],
        "running": false,
        "session": "ffc39e0b-9125-4517-bb5b-1bff1db756fd",
        "started": "2021-03-23T18:15:00Z"
    }, {
        "ended": "2021-03-23T17:20:06Z",
        "id": 18063,
        "jobStream": "test1",
        "jobStreamId": 1975,
        "jobStreamStarter": {
            "jobStreamStarterId": 1895,
            "jobs": [],
            "nextStart": "2021-03-23T20:05:00Z",
            "params": [],
            "state": "active",
            "title": "aa"
        },
        "jobschedulerId": "scheduler_joc_cockpit",
        "jobstreamTasks": [{
            "created": "2021-03-23T17:20:04Z",
            "id": 121558,
            "job": "/jobstream/test1/xjob3",
            "taskId": 84453
        }, {
            "created": "2021-03-23T17:20:02Z",
            "id": 121557,
            "job": "/jobstream/test1/xjob2",
            "taskId": 84452
        }, {
            "created": "2021-03-23T17:20:00Z",
            "id": 121556,
            "job": "/jobstream/test1/xjob11",
            "taskId": 84451
        }],
        "running": false,
        "session": "1560cf56-c9f0-4dfe-8962-efb819360252",
        "started": "2021-03-23T17:20:00Z"
    }]
}

Responses

Code	Description	Body
200		application/json model \| example { "title": "jobStreamSessions", "$schema": "http://json-schema.org/draft-04/schema#", "description": "List of all jobStreams and their folders", "javaType": "com.sos.joc.model.jobstreams.JobStreamSessions", "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" }, "jobstreamSessions": { "type": "array", "items": { "description": "Reset Workflow, unconsume expressions", "javaType": "com.sos.joc.model.jobstreams.JobStreamSesssion", "type": "object", "required": [ "jobschedulerId" ], "properties": { "id": { "type": "number", "format": "utc-millisec", "minimum": 0 }, "jobschedulerId": { "type": "string", "pattern": "^[^/\\<>?:\"\|]$", "maxLength": 100 }, "jobStreamId": { "type": "number", "format": "utc-millisec", "minimum": 0 }, "jobStream": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "session": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "jobStreamStarter": { "description": "List of all jobStream starters", "javaType": "com.sos.joc.model.jobstreams.JobStreamStarter", "type": "object", "properties": { "state": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "jobStreamStarterId": { "type": "number", "format": "utc-millisec", "minimum": 0 }, "starterName": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "title": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "nextStart": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" }, "endOfJobStream": { "description": "absolute path based on live folder of a JobScheduler object.", "type": "string", "pattern": "^(/\|(/[^/\\<>?:\"\|]+)+)$", "maxLength": 255 }, "requiredJob": { "description": "absolute path based on live folder of a JobScheduler object.", "type": "string", "pattern": "^(/\|(/[^/\\<>?:\"\|]+)+)$", "maxLength": 255 }, "jobs": { "type": "array", "items": { "description": "A job started by the jobstream starter", "javaType": "com.sos.joc.model.jobstreams.JobStreamJob", "type": "object", "properties": { "jobId": { "type": "number", "format": "utc-millisec", "minimum": 0 }, "job": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "startDelay": { "type": "number", "format": "utc-millisec", "minimum": 0 }, "nextPeriod": { "description": "Date time. Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ", "type": "string", "format": "date-time" }, "skipOutCondition": { "type": "boolean" }, "inconditions": { "type": "array", "items": { "description": "In Condition", "javaType": "com.sos.joc.model.jobstreams.InCondition", "type": "object", "properties": { "id": { "type": "number", "format": "utc-millisec", "minimum": 0 }, "jobStream": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "consumed": { "type": "boolean" }, "markExpression": { "type": "boolean" }, "skipOutCondition": { "type": "boolean" }, "haveReferenceToOtherFolders": { "type": "boolean" }, "conditionExpression": { "description": "Expression for Condition", "javaType": "com.sos.joc.model.jobstreams.ConditionExpression", "type": "object", "properties": { "expression": { "type": "string", "pattern": "^(?s)((?!<script( \|>)\|<svg/on).)$" }, "validatedExpression": { "type": "string", "pattern": "^(?s)((?!<script( \|>)\|<svg/on).)$" }, "value": { "type": "boolean" }, "jobStreamEvents": { "type": "array", "items": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 } } } }, "nextPeriod": { "description": "Date time. Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ", "type": "string", "format": "date-time" }, "inconditionCommands": { "type": "array", "items": { "description": "In Condition", "javaType": "com.sos.joc.model.jobstreams.InConditionCommand", "type": "object", "properties": { "id": { "type": "number", "format": "utc-millisec", "minimum": 0 }, "command": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "commandParam": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 } } } }, "outconditions": { "type": "array", "items": { "description": "List of all Conditions using an event", "javaType": "com.sos.joc.model.jobstreams.JobstreamConditions", "type": "object", "properties": { "jobStream": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "jobs": { "type": "array", "items": { "description": "In Condition", "javaType": "com.sos.joc.model.jobstreams.ConditionRef", "type": "object", "properties": { "job": { "description": "absolute path based on live folder of a JobScheduler object.", "type": "string", "pattern": "^(/\|(/[^/\\<>?:\"\|]+)+)$", "maxLength": 255 }, "expressions": { "type": "array", "items": { "type": "string", "pattern": "^(?s)((?!<script( \|>)\|<svg/on).)$" } } } } } } } } } } }, "outconditions": { "type": "array", "items": { "description": "Out Condition", "javaType": "com.sos.joc.model.jobstreams.OutCondition", "type": "object", "properties": { "id": { "type": "number", "format": "utc-millisec", "minimum": 0 }, "jobStream": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "conditionExpression": { "description": "Expression for Condition", "javaType": "com.sos.joc.model.jobstreams.ConditionExpression", "type": "object", "properties": { "expression": { "type": "string", "pattern": "^(?s)((?!<script( \|>)\|<svg/on).)$" }, "validatedExpression": { "type": "string", "pattern": "^(?s)((?!<script( \|>)\|<svg/on).)$" }, "value": { "type": "boolean" }, "jobStreamEvents": { "type": "array", "items": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 } } } }, "outconditionEvents": { "type": "array", "items": { "description": "Out Condition Event", "javaType": "com.sos.joc.model.jobstreams.OutConditionEvent", "type": "object", "properties": { "id": { "type": "number", "format": "utc-millisec", "minimum": 0 }, "command": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "event": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "exists": { "type": "boolean" }, "globalEvent": { "type": "boolean" }, "existsInJobStream": { "type": "boolean" }, "jobStream": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 } } } }, "inconditions": { "type": "array", "items": { "description": "List of all Conditions using an event", "javaType": "com.sos.joc.model.jobstreams.JobstreamConditions", "type": "object", "properties": { "jobStream": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "jobs": { "type": "array", "items": { "description": "In Condition", "javaType": "com.sos.joc.model.jobstreams.ConditionRef", "type": "object", "properties": { "job": { "description": "absolute path based on live folder of a JobScheduler object.", "type": "string", "pattern": "^(/\|(/[^/\\<>?:\"\|]+)+)$", "maxLength": 255 }, "expressions": { "type": "array", "items": { "type": "string", "pattern": "^(?s)((?!<script( \|>)\|<svg/on).)$" } } } } } } } } } } } } } }, "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" } } }, "params": { "type": "array", "items": { "javaType": "com.sos.joc.model.common.NameValuePair", "type": "object", "required": [ "name", "value" ], "properties": { "name": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "value": { "type": "string", "pattern": "^(?s)((?!<script( \|>)\|<svg/on).)$" } } } } } }, "running": { "type": "boolean" }, "started": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" }, "ended": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" }, "jobstreamTasks": { "type": "array", "items": { "description": "Reset Workflow, unconsume expressions", "javaType": "com.sos.joc.model.jobstreams.JobStreamTask", "type": "object", "required": [ "jobschedulerId" ], "properties": { "id": { "type": "number", "format": "utc-millisec", "minimum": 0 }, "jobStream": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "job": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "taskId": { "type": "number", "format": "utc-millisec", "minimum": 0 }, "session": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "created": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" } } } } } } } } }
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 'sessions'	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	'sessions' 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": "sessions failed!" } } { "deliveryDate": "2016-05-05T21:13:35Z", "surveyDate": "2016-05-05T21:13:33Z", "error": { "code": "JOC-420", "message": "sessions 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 }