JOC API

/events

POST

Register JobScheduler objects for collecting events

Events can be sent for multiple JobScheduler. The request remains open until a requested event has been received or a timeout of ~6min is reached. Only one ./event request should be active per browser tab.

Parameters in the POST body schema

Name	Type	Description	Example	Default
`jobscheduler`	required, array	This collection contains a required `jobschedulerId` and its objects of interest The first item of the collection has to be the current jobschedulerId.	[{ "jobschedulerId":"scheduler.1.11", "eventId":1480088631000000, "objects":[{...objects...}] }]
`objects`	optional, array	Contains the objects of interest where each object has a `path`and a `type`. If no objects are specified then all event are responsed. The path can specify only a folder then the optional `recursive` can be set (default true). Note that the path of an order contains the job chain path and the orderId with a comma as separator This parameter is not yet considered by the web service. We are not sure if this parameter make sense.	[{ "path":"/sos/reporting,Reporting", "type":"ORDER" }]
`close`	optional, boolean	This parameter finished a still unresponsed previous request of ./event It has to be called together with ./logout	"close":false	false
`eventId`	optional, string	Every response except `close`=true contains for each jobScheduler a new eventId for the next call. If the eventId is empty then the web service calculates the eventId.	"eventId":"1480088631000000"	false

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": "register event",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "javaType": "com.sos.joc.model.event.RegisterEvent",
    "type": "object",
    "required": [
        "jobscheduler"
    ],
    "properties": {
        "jobscheduler": {
            "type": "array",
            "items": {
                "javaType": "com.sos.joc.model.event.JobSchedulerObjects",
                "type": "object",
                "required": [
                    "jobschedulerId"
                ],
                "properties": {
                    "jobschedulerId": {
                        "type": "string",
                        "pattern": "^[^/\\<>?:\"|*]*$",
                        "maxLength": 100
                    },
                    "eventId": {
                        "type": "string",
                        "pattern": "^\\d*$"
                    },
                    "objects": {
                        "description": "collection of JobScheduler object with path and type",
                        "type": "array",
                        "items": {
                            "javaType": "com.sos.joc.model.event.JobSchedulerObject",
                            "type": "object",
                            "required": [
                                "path",
                                "type"
                            ],
                            "properties": {
                                "path": {
                                    "description": "absolute path based on live folder of a JobScheduler object.",
                                    "type": "string",
                                    "pattern": "^(/|(/[^/\\<>?:\"|*]+)+)$",
                                    "maxLength": 255
                                },
                                "type": {
                                    "javaType": "com.sos.joc.model.common.JobSchedulerObjectType",
                                    "type": "string",
                                    "enum": [
                                        "JOB",
                                        "JOBCHAIN",
                                        "ORDER",
                                        "PROCESSCLASS",
                                        "AGENTCLUSTER",
                                        "LOCK",
                                        "SCHEDULE",
                                        "WORKINGDAYSCALENDAR",
                                        "NONWORKINGDAYSCALENDAR",
                                        "FOLDER",
                                        "JOBSCHEDULER",
                                        "DOCUMENTATION",
                                        "MONITOR",
                                        "NODEPARAMS",
                                        "HOLIDAYS",
                                        "JOE",
                                        "OTHER"
                                    ]
                                },
                                "recursive": {
                                    "type": "boolean",
                                    "default": true
                                }
                            }
                        }
                    }
                }
            }
        },
        "close": {
            "type": "boolean",
            "default": false
        }
    }
}

TODO

TODO

Responses

Code	Description	Body
200	TODO	application/json model \| example { "title": "events", "$schema": "http://json-schema.org/draft-04/schema#", "javaType": "com.sos.joc.model.event.JobSchedulerEvents", "type": "object", "required": [ "events", "deliveryDate" ], "properties": { "events": { "type": "array", "items": { "javaType": "com.sos.joc.model.event.JobSchedulerEvent", "type": "object", "properties": { "jobschedulerId": { "type": "string", "pattern": "^[^/\\<>?:\"\|]$", "maxLength": 100 }, "error": { "javaType": "com.sos.joc.model.common.Err", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "message": { "type": "string" } } }, "eventId": { "type": "string", "pattern": "^\\d$" }, "eventSnapshots": { "type": "array", "items": { "javaType": "com.sos.joc.model.event.EventSnapshot", "type": "object", "required": [ "eventId", "path", "eventType", "objectType" ], "properties": { "eventId": { "description": "unique id of an event, monoton increasing, id/1000=milliseconds of UTC time", "type": "string", "pattern": "^\\d$" }, "path": { "description": "absolute path based on live folder of a JobScheduler object.", "type": "string", "pattern": "^(/\|(/[^/\\<>?:\"\|]+)+)$", "maxLength": 255 }, "eventType": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "objectType": { "javaType": "com.sos.joc.model.common.JobSchedulerObjectType", "type": "string", "enum": [ "JOB", "JOBCHAIN", "ORDER", "PROCESSCLASS", "AGENTCLUSTER", "LOCK", "SCHEDULE", "WORKINGDAYSCALENDAR", "NONWORKINGDAYSCALENDAR", "FOLDER", "JOBSCHEDULER", "DOCUMENTATION", "MONITOR", "NODEPARAMS", "HOLIDAYS", "JOE", "OTHER" ] }, "nodeId": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "fromNodeId": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "taskId": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "state": { "type": "string", "pattern": "^[^<>]*$", "maxLength": 255 }, "nodeTransition": { "description": "comes with event OrderStepEnded", "javaType": "com.sos.joc.model.event.NodeTransition", "type": "object", "required": [ "type" ], "properties": { "type": { "javaType": "com.sos.joc.model.event.NodeTransitionType", "type": "string", "enum": [ "SUCCESS", "KEEP", "PROCEEDING", "ERROR" ] }, "returnCode": { "description": "if type=ERROR", "type": "integer" } } } } } } } } }, "deliveryDate": { "description": "Date time. Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ", "type": "string", "format": "date-time" } } } TODO TODO
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 'events'	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	'events' 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": "events failed!" } } { "deliveryDate": "2016-05-05T21:13:35Z", "surveyDate": "2016-05-05T21:13:33Z", "error": { "code": "JOC-420", "message": "events failed!" } }
434	'events' failed! JOC GUI doesn't alert this exception	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": "events failed!" } } { "deliveryDate": "2016-05-05T21:13:35Z", "surveyDate": "2016-05-05T21:13:33Z", "error": { "code": "JOC-420", "message": "events 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 }

Register JobScheduler objects for collecting events

Parameters in the POST body schema

JOC GUI doesn't alert this exception