JOC API

/orders/overview/snapshot

POST

Summary with number of

pending orders

running orders

suspended orders

orders with setback

waiting for resource orders

blacklist orders

Parameters in the POST body schema

Name	Type	Description	Example
`jobschedulerId`	required, string	JobScheduler Master ID	scheduler
`jobChains`	optional, array	Filtered response by a collection of job chains specified by its path Some other parameters such as `folders` and `regex` are ignored if this parameter is defined.	[{ "jobChain":"/sos/reporting/Inventory" }]
`folders`	optional, array	collection of folder objects	[{ "folder": "/sos", "recursive": true }]

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": "jobChainsFilter",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "javaType": "com.sos.joc.model.jobChain.JobChainsFilter",
    "type": "object",
    "required": [
        "jobschedulerId"
    ],
    "properties": {
        "jobschedulerId": {
            "type": "string",
            "pattern": "^[^/\\<>?:\"|*]*$",
            "maxLength": 100
        },
        "jobChains": {
            "type": "array",
            "items": {
                "javaType": "com.sos.joc.model.jobChain.JobChainPath",
                "type": "object",
                "required": [
                    "jobChain"
                ],
                "properties": {
                    "jobChain": {
                        "description": "absolute path based on live folder of a JobScheduler object.",
                        "type": "string",
                        "pattern": "^(/|(/[^/\\<>?:\"|*]+)+)$",
                        "maxLength": 255
                    }
                }
            }
        },
        "compact": {
            "description": "controls if the object view is compact or detailed",
            "type": "boolean",
            "default": false
        },
        "compactView": {
            "type": "boolean",
            "default": false
        },
        "regex": {
            "description": "regular expression to filter JobScheduler objects by matching the path",
            "type": "string",
            "pattern": "^((?!<script( |>)|<svg/on).)*$"
        },
        "folders": {
            "type": "array",
            "items": {
                "javaType": "com.sos.joc.model.common.Folder",
                "type": "object",
                "required": [
                    "folder"
                ],
                "properties": {
                    "folder": {
                        "description": "absolute path based on live folder of a JobScheduler object.",
                        "type": "string",
                        "pattern": "^(/|(/[^/\\<>?:\"|*]+)+)$",
                        "maxLength": 255
                    },
                    "recursive": {
                        "type": "boolean",
                        "default": true
                    }
                }
            }
        },
        "states": {
            "type": "array",
            "items": {
                "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": {
            "type": "integer",
            "minimum": 0
        },
        "job": {
            "type": "object",
            "javaType": "com.sos.joc.model.jobChain.JobsFilter",
            "properties": {
                "regex": {
                    "description": "regular expression to filter JobScheduler objects by matching the path",
                    "type": "string",
                    "pattern": "^((?!<script( |>)|<svg/on).)*$"
                },
                "folders": {
                    "type": "array",
                    "items": {
                        "javaType": "com.sos.joc.model.common.Folder",
                        "type": "object",
                        "required": [
                            "folder"
                        ],
                        "properties": {
                            "folder": {
                                "description": "absolute path based on live folder of a JobScheduler object.",
                                "type": "string",
                                "pattern": "^(/|(/[^/\\<>?:\"|*]+)+)$",
                                "maxLength": 255
                            },
                            "recursive": {
                                "type": "boolean",
                                "default": true
                            }
                        }
                    }
                }
            }
        }
    }
}

TODO

TODO

Responses

Code	Description	Body
200		application/json model \| example { "title": "orders overview snapshot", "$schema": "http://json-schema.org/draft-04/schema#", "javaType": "com.sos.joc.model.order.OrdersSnapshot", "type": "object", "required": [ "deliveryDate", "surveyDate" ], "properties": { "deliveryDate": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" }, "surveyDate": { "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": { "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": { "type": "integer", "minimum": 0 }, "running": { "type": "integer", "minimum": 0 }, "suspended": { "type": "integer", "minimum": 0 }, "setback": { "type": "integer", "minimum": 0 }, "waitingForResource": { "type": "integer", "minimum": 0 }, "blacklist": { "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", "$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 'snapshot'	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	'snapshot' 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": "snapshot failed!" } } { "deliveryDate": "2016-05-05T21:13:35Z", "surveyDate": "2016-05-05T21:13:33Z", "error": { "code": "JOC-420", "message": "snapshot 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 }

Summary with number of

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

Parameters in the POST body schema

pending orders

running orders

suspended orders

orders with setback

waiting for resource orders

blacklist orders