200 |
The response contains
- deliveryDate
- totalNumOfSuccesfulTasks
- totalNumOfJobs (number of distinct jobs per day)
- agents which is a collection where each agent has following fields
- agent
- cause
- jobschedulerId
- numOfSuccessfulTasks
- numOfJobs (number of distinct jobs per day)
|
|
application/json
model |
example
{
"title": "agents",
"$schema": "http://json-schema.org/draft-04/schema#",
"javaType": "com.sos.joc.model.report.Agents",
"type": "object",
"required": [
"deliveryDate",
"agents"
],
"properties": {
"deliveryDate": {
"description": "Date time. Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ",
"type": "string",
"format": "date-time"
},
"agents": {
"type": "array",
"items": {
"javaType": "com.sos.joc.model.report.Agent",
"type": "object",
"required": [
"agent",
"cause",
"numOfSuccessfulTasks",
"numOfJobs"
],
"properties": {
"jobschedulerId": {
"type": "string"
},
"agent": {
"description": "Url of an Agent",
"type": "string",
"pattern": "^https?://.+$"
},
"cause": {
"description": "For order jobs only cause=order possible",
"javaType": "com.sos.joc.model.job.TaskCause",
"type": "string",
"enum": [
"NONE",
"MIN_TASKS",
"PERIOD_ONCE",
"PERIOD_SINGLE",
"PERIOD_REPEAT",
"QUEUE",
"QUEUE_AT",
"DIRECTORY",
"DELAY_AFTER_ERROR",
"ORDER"
]
},
"numOfSuccessfulTasks": {
"type": "number",
"format": "utc-millisec",
"minimum": 0
},
"numOfJobs": {
"type": "number",
"format": "utc-millisec",
"minimum": 0
}
}
}
},
"totalNumOfSuccessfulTasks": {
"type": "number",
"format": "utc-millisec",
"minimum": 0
},
"totalNumOfJobs": {
"type": "number",
"format": "utc-millisec",
"minimum": 0
}
}
}
{ "agents": [{ "agent": "http://oh2:4445", "cause": "PERIOD_SINGLE", "jobschedulerId": "scheduler.1.11", "numOfSuccessfulTasks": 2 }, { "agent": "http://oh2:4445", "cause": "QUEUE_AT", "jobschedulerId": "scheduler.1.11", "numOfSuccessfulTasks": 16 }, { "agent": "http://galadriel.sos:4454", "cause": "QUEUE_AT", "jobschedulerId": "scheduler.1.11-reporting", "numOfSuccessfulTasks": 1 }, { "agent": "http://localhost:4441", "cause": "ORDER", "jobschedulerId": "scheduler.1.11-reporting", "numOfSuccessfulTasks": 21 }, { "agent": "http://oh.sos:4447", "cause": "ORDER", "jobschedulerId": "scheduler.1.11-reporting", "numOfSuccessfulTasks": 936 }, { "agent": "http://oh.sos:4447", "cause": "QUEUE_AT", "jobschedulerId": "scheduler.1.11-reporting", "numOfSuccessfulTasks": 1 }, { "agent": "http://galadriel:4445", "cause": "QUEUE_AT", "jobschedulerId": "scheduler.1.11.oh", "numOfSuccessfulTasks": 15 }, { "agent": "http://oh:4445", "cause": "ORDER", "jobschedulerId": "scheduler.1.11.oh", "numOfSuccessfulTasks": 3 }, { "agent": "http://oh:4445", "cause": "PERIOD_SINGLE", "jobschedulerId": "scheduler.1.11.oh", "numOfSuccessfulTasks": 20 }, { "agent": "http://oh:4445", "cause": "QUEUE_AT", "jobschedulerId": "scheduler.1.11.oh", "numOfSuccessfulTasks": 58 }, { "agent": "http://oh2:4445", "cause": "QUEUE_AT", "jobschedulerId": "scheduler.1.11.oh", "numOfSuccessfulTasks": 4 }], "deliveryDate": "2017-11-02T12:17:43.326Z", "totalNumOfSuccessfulTasks": 1077 }
{
"agents": [{
"agent": "http://oh2:4445",
"cause": "PERIOD_SINGLE",
"jobschedulerId": "scheduler.1.11",
"numOfSuccessfulTasks": 2
}, {
"agent": "http://oh2:4445",
"cause": "QUEUE_AT",
"jobschedulerId": "scheduler.1.11",
"numOfSuccessfulTasks": 16
}, {
"agent": "http://galadriel.sos:4454",
"cause": "QUEUE_AT",
"jobschedulerId": "scheduler.1.11-reporting",
"numOfSuccessfulTasks": 1
}, {
"agent": "http://localhost:4441",
"cause": "ORDER",
"jobschedulerId": "scheduler.1.11-reporting",
"numOfSuccessfulTasks": 21
}, {
"agent": "http://oh.sos:4447",
"cause": "ORDER",
"jobschedulerId": "scheduler.1.11-reporting",
"numOfSuccessfulTasks": 936
}, {
"agent": "http://oh.sos:4447",
"cause": "QUEUE_AT",
"jobschedulerId": "scheduler.1.11-reporting",
"numOfSuccessfulTasks": 1
}, {
"agent": "http://galadriel:4445",
"cause": "QUEUE_AT",
"jobschedulerId": "scheduler.1.11.oh",
"numOfSuccessfulTasks": 15
}, {
"agent": "http://oh:4445",
"cause": "ORDER",
"jobschedulerId": "scheduler.1.11.oh",
"numOfSuccessfulTasks": 3
}, {
"agent": "http://oh:4445",
"cause": "PERIOD_SINGLE",
"jobschedulerId": "scheduler.1.11.oh",
"numOfSuccessfulTasks": 20
}, {
"agent": "http://oh:4445",
"cause": "QUEUE_AT",
"jobschedulerId": "scheduler.1.11.oh",
"numOfSuccessfulTasks": 58
}, {
"agent": "http://oh2:4445",
"cause": "QUEUE_AT",
"jobschedulerId": "scheduler.1.11.oh",
"numOfSuccessfulTasks": 4
}],
"deliveryDate": "2017-11-02T12:17:43.326Z",
"totalNumOfSuccessfulTasks": 1077
}
|
403 |
Forbidden! The user doesn't have sufficient permissions for 'agents' |
|
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 |
'agents' 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": "agents failed!" } }
{
"deliveryDate": "2016-05-05T21:13:35Z",
"surveyDate": "2016-05-05T21:13:33Z",
"error": {
"code": "JOC-420",
"message": "agents 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
}
|