200 |
|
|
application/json
model |
example
{
"title": "ConditionEvents",
"$schema": "http://json-schema.org/draft-04/schema#",
"javaType": "com.sos.joc.model.jobstreams.ConditionEvents",
"type": "object",
"required": [
"deliveryDate",
"conditionEvents"
],
"properties": {
"deliveryDate": {
"description": "Date time. Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ",
"type": "string",
"format": "date-time"
},
"session": {
"type": "string",
"pattern": "^[^<>]*$",
"maxLength": 100
},
"conditionEvents": {
"type": "array",
"items": {
"javaType": "com.sos.joc.model.jobstreams.ConditionEvent",
"type": "object",
"required": [
"jobschedulerId",
"jobStream",
"outConditionId",
"event"
],
"properties": {
"jobschedulerId": {
"type": "string",
"pattern": "^[^/\\<>?:\"|*]*$",
"maxLength": 100
},
"event": {
"type": "string",
"pattern": "^[^<>]*$",
"maxLength": 255
},
"globalEvent": {
"type": "boolean"
},
"path": {
"description": "absolute path based on live folder of a JobScheduler object.",
"type": "string",
"pattern": "^(/|(/[^/\\<>?:\"|*]+)+)$",
"maxLength": 255
},
"jobStream": {
"type": "string",
"pattern": "^[^<>]*$",
"maxLength": 255
},
"session": {
"type": "string",
"pattern": "^[^<>]*$",
"maxLength": 100
},
"outConditionId": {
"type": "number",
"format": "utc-millisec",
"minimum": 0
}
}
}
},
"conditionMissingEvents": {
"type": "array",
"items": {
"javaType": "com.sos.joc.model.jobstreams.ConditionEvent",
"type": "object",
"required": [
"jobschedulerId",
"jobStream",
"outConditionId",
"event"
],
"properties": {
"jobschedulerId": {
"type": "string",
"pattern": "^[^/\\<>?:\"|*]*$",
"maxLength": 100
},
"event": {
"type": "string",
"pattern": "^[^<>]*$",
"maxLength": 255
},
"globalEvent": {
"type": "boolean"
},
"path": {
"description": "absolute path based on live folder of a JobScheduler object.",
"type": "string",
"pattern": "^(/|(/[^/\\<>?:\"|*]+)+)$",
"maxLength": 255
},
"jobStream": {
"type": "string",
"pattern": "^[^<>]*$",
"maxLength": 255
},
"session": {
"type": "string",
"pattern": "^[^<>]*$",
"maxLength": 100
},
"outConditionId": {
"type": "number",
"format": "utc-millisec",
"minimum": 0
}
}
}
}
}
}
{ "conditionEvents": [{ "event": "xjob11", "globalEvent": false, "jobStream": "test1", "outConditionId": 11515, "path": "/jobstream/test1", "session": "4d203337-19c5-488d-b9d9-ef67ae173b1f" }, { "event": "xjob2", "globalEvent": false, "jobStream": "test1", "outConditionId": 11516, "path": "/jobstream/test1", "session": "4d203337-19c5-488d-b9d9-ef67ae173b1f" }, { "event": "xjob3", "globalEvent": false, "jobStream": "test1", "outConditionId": 11517, "path": "/jobstream/test1", "session": "4d203337-19c5-488d-b9d9-ef67ae173b1f" }], "conditionMissingEvents": [], "deliveryDate": "2021-03-23T15:01:29.728Z", "session": "4d203337-19c5-488d-b9d9-ef67ae173b1f" }
{
"conditionEvents": [{
"event": "xjob11",
"globalEvent": false,
"jobStream": "test1",
"outConditionId": 11515,
"path": "/jobstream/test1",
"session": "4d203337-19c5-488d-b9d9-ef67ae173b1f"
}, {
"event": "xjob2",
"globalEvent": false,
"jobStream": "test1",
"outConditionId": 11516,
"path": "/jobstream/test1",
"session": "4d203337-19c5-488d-b9d9-ef67ae173b1f"
}, {
"event": "xjob3",
"globalEvent": false,
"jobStream": "test1",
"outConditionId": 11517,
"path": "/jobstream/test1",
"session": "4d203337-19c5-488d-b9d9-ef67ae173b1f"
}],
"conditionMissingEvents": [],
"deliveryDate": "2021-03-23T15:01:29.728Z",
"session": "4d203337-19c5-488d-b9d9-ef67ae173b1f"
}
|
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 'eventlist' |
|
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 |
'eventlist' 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": "eventlist failed!" } }
{
"deliveryDate": "2016-05-05T21:13:35Z",
"surveyDate": "2016-05-05T21:13:33Z",
"error": {
"code": "JOC-420",
"message": "eventlist 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
}
|