JOC API

/orders/overview/snapshot/event

POST

Summary with number of

pending orders

running orders

suspended orders

orders with setback

waiting for resource orders

blacklist orders

NOTE
The response comes not immediatly.
It comes when a value has changed but the latest after one minute.
It uses the envent from the JobScheduler.

Parameters in the POST body schema

Name	Type	Description	Example	Default
`jobschedulerId`	required, string	JobScheduler Master ID	scheduler
`jobChains`	optional, array	Filtered response by a collection of job chains specified by its path All other parameters such as `folders` are ignored if this parameter is defined.	[{ "jobChain":"/sos/reporting/Inventory" }]
`folders`	optional, string	collection of folder objects	[{ "folder": "/sos", "recursive": true }]
`close`	optional, boolean	This parameter finished a still unresponsed previous request of ./event	"close":false	false

Request

Name

Description

Example

Type

Constraints

Default

Headers

access_token*

Request requires authentication!

550e8400-e29b-11d4-a716-446655440000

string

Body

application/json

model | example

{
    "title": "jobChainsFilter",
    "id": "schemas/jobChain/jobChainsFilter",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "javaType": "com.sos.joc.model.jobChain.JobChainsFilter",
    "type": "object",
    "required": [
        "jobschedulerId"
    ],
    "properties": {
        "jobschedulerId": {
            "type": "string"
        },
        "jobChains": {
            "type": "array",
            "items": {
                "javaType": "com.sos.joc.model.jobChain.JobChainPath",
                "type": "object",
                "required": [
                    "jobChain"
                ],
                "properties": {
                    "jobChain": {
                        "id": "schemas/common/path",
                        "description": "absolute path based on live folder of a JobScheduler object.",
                        "type": "string",
                        "pattern": "/([^/]+/)*[^/]+"
                    }
                }
            }
        },
        "compact": {
            "id": "schemas/common/compactParam",
            "description": "controls if the object view is compact or detailed",
            "type": "boolean",
            "default": false
        },
        "regex": {
            "id": "schemas/common/regexFilter",
            "description": "regular expression to filter JobScheduler objects by matching the path",
            "type": "string"
        },
        "folders": {
            "id": "schemas/common/folders",
            "type": "array",
            "items": {
                "javaType": "com.sos.joc.model.common.Folder",
                "type": "object",
                "required": [
                    "folder"
                ],
                "properties": {
                    "folder": {
                        "id": "schemas/common/path",
                        "description": "absolute path based on live folder of a JobScheduler object.",
                        "type": "string",
                        "pattern": "/([^/]+/)*[^/]+"
                    },
                    "recursive": {
                        "type": "boolean",
                        "default": true
                    }
                }
            }
        },
        "states": {
            "type": "array",
            "items": {
                "id": "schemas/jobChain/jobChainStateText",
                "javaType": "com.sos.joc.model.jobChain.JobChainStateText",
                "type": "string",
                "enum": [
                    "NOT_INITIALIZED",
                    "INITIALIZED",
                    "ACTIVE",
                    "UNDER_CONSTRUCTION",
                    "STOPPED"
                ]
            }
        },
        "close": {
            "description": "concerns only events",
            "type": "boolean",
            "default": false
        },
        "maxOrders": {
            "id": "schemas/common/nonNegativeInteger",
            "type": "integer",
            "minimum": 0
        }
    }
}

TODO

TODO

Responses

Code	Description	Body
200		application/json model \| example { "title": "orders overview snapshot", "id": "schemas/orders/snapshot", "$schema": "http://json-schema.org/draft-04/schema#", "javaType": "com.sos.joc.model.order.OrdersSnapshot", "type": "object", "required": [ "deliveryDate", "surveyDate" ], "properties": { "deliveryDate": { "id": "schemas/common/timestamp", "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" }, "surveyDate": { "id": "schemas/common/surveyDate_v", "description": "Current date of the JobScheduler Master/Agent. Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ", "type": "string", "format": "date-time" }, "orders": { "id": "schemas/order/ordersSummary", "description": "only relevant for order jobs and is empty if job's order queue is empty", "javaType": "com.sos.joc.model.order.OrdersSummary", "type": "object", "properties": { "pending": { "id": "schemas/common/nonNegativeInteger", "type": "integer", "minimum": 0 }, "running": { "id": "schemas/common/nonNegativeInteger", "type": "integer", "minimum": 0 }, "suspended": { "id": "schemas/common/nonNegativeInteger", "type": "integer", "minimum": 0 }, "setback": { "id": "schemas/common/nonNegativeInteger", "type": "integer", "minimum": 0 }, "waitingForResource": { "id": "schemas/common/nonNegativeInteger", "type": "integer", "minimum": 0 }, "blacklist": { "id": "schemas/common/nonNegativeInteger", "type": "integer", "minimum": 0 } } } } } { "deliveryDate": "2016-05-05T21:13:35Z", "surveyDate": "2016-05-05T21:13:35Z", "orders": { "pending": 58, "running": 4, "suspended": 1, "setback": 0, "waitingForResource": 1, "blacklist": 0 } } { "deliveryDate": "2016-05-05T21:13:35Z", "surveyDate": "2016-05-05T21:13:35Z", "orders": { "pending": 58, "running": 4, "suspended": 1, "setback": 0, "waitingForResource": 1, "blacklist": 0 } }
401	Unauthorized!	application/json model \| example { "title": "security", "id": "schemas/user/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 'event'	application/json model \| example { "title": "security", "id": "schemas/user/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	'event' failed!	application/json model \| example { "title": "error object with delivery date", "id": "schemas/common/error420", "$schema": "http://json-schema.org/draft-04/schema#", "javaType": "com.sos.joc.model.common.Err420", "type": "object", "required": [ "deliveryDate", "error" ], "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" }, "surveyDate": { "description": "is also required for permanent or volatile requests", "type": "string", "format": "date-time" }, "error": { "id": "schemas/common/error", "javaType": "com.sos.joc.model.common.Err", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } { "deliveryDate": "2016-05-05T21:13:35Z", "surveyDate": "2016-05-05T21:13:33Z", "error": { "code": "JOC-420", "message": "event failed!" } } { "deliveryDate": "2016-05-05T21:13:35Z", "surveyDate": "2016-05-05T21:13:33Z", "error": { "code": "JOC-420", "message": "event failed!" } }
440	Login Timeout! The client's session has expired and must log in again.	application/json model \| example { "title": "security", "id": "schemas/user/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 }

Summary with number of

pending orders running orders suspended orders orders with setback waiting for resource orders blacklist orders

NOTE The response comes not immediatly. It comes when a value has changed but the latest after one minute. It uses the envent from the JobScheduler.

Parameters in the POST body schema

pending orders

running orders

suspended orders

orders with setback

waiting for resource orders

blacklist orders

NOTE
The response comes not immediatly.
It comes when a value has changed but the latest after one minute.
It uses the envent from the JobScheduler.