JOC API

/tree/joe

POST

Collections of specified object with folders information in a tree structure

Parameters in the POST body schema

Name	Type	Description	Example
`jobschedulerId`	required, string	JobScheduler Master ID	scheduler
`folders`	optional, array	collection of folder objects	[{ "folder": "/sos", "recursive": true }]
`types`	optional, array	This parameter restricts the folders. Only folders are in the response which have subfolders or JobScheduler objects of this parameter	[ "JOBCHAIN", "JOB" ]

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": "treeFilter",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "javaType": "com.sos.joc.model.tree.TreeFilter",
    "type": "object",
    "required": [
        "jobschedulerId"
    ],
    "properties": {
        "jobschedulerId": {
            "type": "string",
            "pattern": "^[^/\\<>?:\"|*]*$",
            "maxLength": 100
        },
        "types": {
            "type": "array",
            "items": {
                "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"
                ]
            }
        },
        "compact": {
            "description": "controls if the object view is compact or detailed",
            "type": "boolean",
            "default": false
        },
        "force": {
            "title": "force full tree",
            "description": "controls whether the folder permissions are use. If true the full tree will be returned",
            "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
                    }
                }
            }
        },
        "forJoe": {
            "type": "boolean",
            "default": false
        }
    }
}

{ "jobschedulerId": "scheduler", "folders": [{ "path": "/", "recursive": true }] }

{
    "jobschedulerId": "scheduler",
    "folders": [{
        "path": "/",
        "recursive": true
    }]
}

Responses

Code	Description	Body
200	Folders collection in tree format are responsed that means a form such as "folders": { "path":"/", "name":"", "folders": [ { "path":"/sos", "name":"sos", "folders": [ { "path":"/sos/housekeeping", "name":"housekeeping" }, { "path":"/sos/events", "name":"events" } ] } ] } Content of the folders collection depends on `folders` parameter If `types` parameter is specified then any folder which don't have subfolders or JobScheduler objects from the `types` parameter are omit Supplementary to the ./tree response you get additional information of a folder (see example)	application/json model \| example { "title": "treeView", "$schema": "http://json-schema.org/draft-04/schema#", "description": "collections of JobScheduler objects besides folder tree structure.", "javaType": "com.sos.joc.model.tree.JoeTreeView", "type": "object", "required": [ "deliveryDate", "folders" ], "properties": { "deliveryDate": { "description": "Date time. Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ", "type": "string", "format": "date-time" }, "folders": { "type": "array", "items": { "javaType": "com.sos.joc.model.tree.JoeTree", "type": "object", "extends": { "javaType": "com.sos.joc.model.tree.Tree", "type": "object", "properties": { "path": { "description": "absolute path based on live folder of a JobScheduler object.", "type": "string", "pattern": "^(/\|(/[^/\\<>?:\"\|*]+)+)$", "maxLength": 255 }, "name": { "type": "string" }, "deleted": { "type": "boolean" }, "lockedBy": { "type": "string" }, "lockedSince": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" }, "folders": { "type": "array", "items": { "description": "tree-schema.json" } } }, "required": [ "path", "name" ] }, "properties": { "jobs": { "type": "array", "items": { "javaType": "com.sos.joc.model.joe.other.FolderItem", "type": "object", "required": [ "name", "deployed", "deleted" ], "properties": { "name": { "type": "string" }, "deployed": { "type": "boolean", "default": false }, "deleted": { "type": "boolean", "default": false }, "title": { "type": "string" }, "processClass": { "description": "for jobs and job chains", "type": "string" }, "isOrderJob": { "description": "for jobs", "type": "boolean" }, "priority": { "description": "for orders", "type": "string" }, "initialState": { "description": "for orders", "type": "string" }, "endState": { "description": "for orders", "type": "string" }, "maxProcesses": { "type": "integer", "minimum": 0 }, "maxNonExclusive": { "type": "integer", "minimum": 0 }, "validFrom": { "description": "for schedule: yyyy-mm-dd HH:MM[:SS]", "type": "string" }, "validTo": { "description": "for schedule: yyyy-mm-dd HH:MM[:SS]", "type": "string" }, "substitute": { "description": "for schedule: path to another schedule", "type": "string" } } }, "uniqueItems": true }, "jobChains": { "type": "array", "items": { "javaType": "com.sos.joc.model.joe.other.FolderItem", "type": "object", "required": [ "name", "deployed", "deleted" ], "properties": { "name": { "type": "string" }, "deployed": { "type": "boolean", "default": false }, "deleted": { "type": "boolean", "default": false }, "title": { "type": "string" }, "processClass": { "description": "for jobs and job chains", "type": "string" }, "isOrderJob": { "description": "for jobs", "type": "boolean" }, "priority": { "description": "for orders", "type": "string" }, "initialState": { "description": "for orders", "type": "string" }, "endState": { "description": "for orders", "type": "string" }, "maxProcesses": { "type": "integer", "minimum": 0 }, "maxNonExclusive": { "type": "integer", "minimum": 0 }, "validFrom": { "description": "for schedule: yyyy-mm-dd HH:MM[:SS]", "type": "string" }, "validTo": { "description": "for schedule: yyyy-mm-dd HH:MM[:SS]", "type": "string" }, "substitute": { "description": "for schedule: path to another schedule", "type": "string" } } }, "uniqueItems": true }, "orders": { "type": "array", "items": { "javaType": "com.sos.joc.model.joe.other.FolderItem", "type": "object", "required": [ "name", "deployed", "deleted" ], "properties": { "name": { "type": "string" }, "deployed": { "type": "boolean", "default": false }, "deleted": { "type": "boolean", "default": false }, "title": { "type": "string" }, "processClass": { "description": "for jobs and job chains", "type": "string" }, "isOrderJob": { "description": "for jobs", "type": "boolean" }, "priority": { "description": "for orders", "type": "string" }, "initialState": { "description": "for orders", "type": "string" }, "endState": { "description": "for orders", "type": "string" }, "maxProcesses": { "type": "integer", "minimum": 0 }, "maxNonExclusive": { "type": "integer", "minimum": 0 }, "validFrom": { "description": "for schedule: yyyy-mm-dd HH:MM[:SS]", "type": "string" }, "validTo": { "description": "for schedule: yyyy-mm-dd HH:MM[:SS]", "type": "string" }, "substitute": { "description": "for schedule: path to another schedule", "type": "string" } } }, "uniqueItems": true }, "agentClusters": { "type": "array", "items": { "javaType": "com.sos.joc.model.joe.other.FolderItem", "type": "object", "required": [ "name", "deployed", "deleted" ], "properties": { "name": { "type": "string" }, "deployed": { "type": "boolean", "default": false }, "deleted": { "type": "boolean", "default": false }, "title": { "type": "string" }, "processClass": { "description": "for jobs and job chains", "type": "string" }, "isOrderJob": { "description": "for jobs", "type": "boolean" }, "priority": { "description": "for orders", "type": "string" }, "initialState": { "description": "for orders", "type": "string" }, "endState": { "description": "for orders", "type": "string" }, "maxProcesses": { "type": "integer", "minimum": 0 }, "maxNonExclusive": { "type": "integer", "minimum": 0 }, "validFrom": { "description": "for schedule: yyyy-mm-dd HH:MM[:SS]", "type": "string" }, "validTo": { "description": "for schedule: yyyy-mm-dd HH:MM[:SS]", "type": "string" }, "substitute": { "description": "for schedule: path to another schedule", "type": "string" } } }, "uniqueItems": true }, "processClasses": { "type": "array", "items": { "javaType": "com.sos.joc.model.joe.other.FolderItem", "type": "object", "required": [ "name", "deployed", "deleted" ], "properties": { "name": { "type": "string" }, "deployed": { "type": "boolean", "default": false }, "deleted": { "type": "boolean", "default": false }, "title": { "type": "string" }, "processClass": { "description": "for jobs and job chains", "type": "string" }, "isOrderJob": { "description": "for jobs", "type": "boolean" }, "priority": { "description": "for orders", "type": "string" }, "initialState": { "description": "for orders", "type": "string" }, "endState": { "description": "for orders", "type": "string" }, "maxProcesses": { "type": "integer", "minimum": 0 }, "maxNonExclusive": { "type": "integer", "minimum": 0 }, "validFrom": { "description": "for schedule: yyyy-mm-dd HH:MM[:SS]", "type": "string" }, "validTo": { "description": "for schedule: yyyy-mm-dd HH:MM[:SS]", "type": "string" }, "substitute": { "description": "for schedule: path to another schedule", "type": "string" } } }, "uniqueItems": true }, "locks": { "type": "array", "items": { "javaType": "com.sos.joc.model.joe.other.FolderItem", "type": "object", "required": [ "name", "deployed", "deleted" ], "properties": { "name": { "type": "string" }, "deployed": { "type": "boolean", "default": false }, "deleted": { "type": "boolean", "default": false }, "title": { "type": "string" }, "processClass": { "description": "for jobs and job chains", "type": "string" }, "isOrderJob": { "description": "for jobs", "type": "boolean" }, "priority": { "description": "for orders", "type": "string" }, "initialState": { "description": "for orders", "type": "string" }, "endState": { "description": "for orders", "type": "string" }, "maxProcesses": { "type": "integer", "minimum": 0 }, "maxNonExclusive": { "type": "integer", "minimum": 0 }, "validFrom": { "description": "for schedule: yyyy-mm-dd HH:MM[:SS]", "type": "string" }, "validTo": { "description": "for schedule: yyyy-mm-dd HH:MM[:SS]", "type": "string" }, "substitute": { "description": "for schedule: path to another schedule", "type": "string" } } }, "uniqueItems": true }, "schedules": { "type": "array", "items": { "javaType": "com.sos.joc.model.joe.other.FolderItem", "type": "object", "required": [ "name", "deployed", "deleted" ], "properties": { "name": { "type": "string" }, "deployed": { "type": "boolean", "default": false }, "deleted": { "type": "boolean", "default": false }, "title": { "type": "string" }, "processClass": { "description": "for jobs and job chains", "type": "string" }, "isOrderJob": { "description": "for jobs", "type": "boolean" }, "priority": { "description": "for orders", "type": "string" }, "initialState": { "description": "for orders", "type": "string" }, "endState": { "description": "for orders", "type": "string" }, "maxProcesses": { "type": "integer", "minimum": 0 }, "maxNonExclusive": { "type": "integer", "minimum": 0 }, "validFrom": { "description": "for schedule: yyyy-mm-dd HH:MM[:SS]", "type": "string" }, "validTo": { "description": "for schedule: yyyy-mm-dd HH:MM[:SS]", "type": "string" }, "substitute": { "description": "for schedule: path to another schedule", "type": "string" } } }, "uniqueItems": true }, "monitors": { "type": "array", "items": { "javaType": "com.sos.joc.model.joe.other.FolderItem", "type": "object", "required": [ "name", "deployed", "deleted" ], "properties": { "name": { "type": "string" }, "deployed": { "type": "boolean", "default": false }, "deleted": { "type": "boolean", "default": false }, "title": { "type": "string" }, "processClass": { "description": "for jobs and job chains", "type": "string" }, "isOrderJob": { "description": "for jobs", "type": "boolean" }, "priority": { "description": "for orders", "type": "string" }, "initialState": { "description": "for orders", "type": "string" }, "endState": { "description": "for orders", "type": "string" }, "maxProcesses": { "type": "integer", "minimum": 0 }, "maxNonExclusive": { "type": "integer", "minimum": 0 }, "validFrom": { "description": "for schedule: yyyy-mm-dd HH:MM[:SS]", "type": "string" }, "validTo": { "description": "for schedule: yyyy-mm-dd HH:MM[:SS]", "type": "string" }, "substitute": { "description": "for schedule: path to another schedule", "type": "string" } } }, "uniqueItems": true }, "nodeParams": { "type": "array", "items": { "javaType": "com.sos.joc.model.joe.other.FolderItem", "type": "object", "required": [ "name", "deployed", "deleted" ], "properties": { "name": { "type": "string" }, "deployed": { "type": "boolean", "default": false }, "deleted": { "type": "boolean", "default": false }, "title": { "type": "string" }, "processClass": { "description": "for jobs and job chains", "type": "string" }, "isOrderJob": { "description": "for jobs", "type": "boolean" }, "priority": { "description": "for orders", "type": "string" }, "initialState": { "description": "for orders", "type": "string" }, "endState": { "description": "for orders", "type": "string" }, "maxProcesses": { "type": "integer", "minimum": 0 }, "maxNonExclusive": { "type": "integer", "minimum": 0 }, "validFrom": { "description": "for schedule: yyyy-mm-dd HH:MM[:SS]", "type": "string" }, "validTo": { "description": "for schedule: yyyy-mm-dd HH:MM[:SS]", "type": "string" }, "substitute": { "description": "for schedule: path to another schedule", "type": "string" } } }, "uniqueItems": true } } } } } } { "deliveryDate": "2019-11-07T12:19:12.105Z", "folders": [{ "folders": [{ "lockedBy": "root", "lockedSince": "2019-11-06T13:24:26Z", "name": "Jobs", "path": "/Jobs", "jobs": [{ "deleted": false, "deployed": true, "isOrderJob": false, "name": "job1" }] }, { "folders": [{ "name": "dailyplan", "path": "/sos/dailyplan", "jobChains": [{ "deleted": false, "deployed": true, "name": "CreateDailyPlan" }], "jobs": [{ "deleted": false, "deployed": true, "isOrderJob": true, "name": "CreateDailyPlan", "title": "Creating a daily plan depending on actual Runtimes" }] }, { "name": "housekeeping", "path": "/sos/housekeeping", "jobs": [{ "deleted": false, "deployed": true, "isOrderJob": false, "name": "scheduler_cleanup_files", "title": "Remove temporary files" }, { "deleted": false, "deployed": true, "isOrderJob": false, "name": "scheduler_dequeue_mail", "title": "Send buffered mails from mail queue" }, { "deleted": false, "deployed": true, "isOrderJob": false, "name": "scheduler_restart", "title": "Restart Job Scheduler" }, { "deleted": false, "deployed": true, "isOrderJob": false, "name": "scheduler_rotate_log", "title": "Rotate and compress logfiles" }] }, { "name": "jitl", "path": "/sos/jitl", "jobs": [{ "deleted": false, "deployed": true, "isOrderJob": true, "name": "JobChainEnd", "title": "Job chain end node" }, { "deleted": false, "deployed": true, "isOrderJob": true, "name": "JobChainSplitter", "title": "Start a parallel processing in a jobchain" }, { "deleted": false, "deployed": true, "isOrderJob": true, "name": "JobChainStart", "title": "Job chain start node to load configuration monitor" }] }, { "name": "notification", "path": "/sos/notification", "jobChains": [{ "deleted": false, "deployed": true, "name": "CleanupNotifications" }, { "deleted": false, "deployed": true, "name": "ResetNotifications" }, { "deleted": false, "deployed": true, "name": "SystemNotifier" }], "jobs": [{ "deleted": false, "deployed": true, "isOrderJob": true, "name": "CleanupNotifications", "title": "Cleanup Notifications" }, { "deleted": false, "deployed": true, "isOrderJob": true, "name": "ResetNotifications", "title": "Reset notifications" }, { "deleted": false, "deployed": true, "isOrderJob": true, "name": "SystemNotifier", "title": "System notifier" }] }, { "folders": [{ "name": "criticalpath", "path": "/sos/operations/criticalpath", "jobChains": [{ "deleted": false, "deployed": true, "name": "UncriticalJobNodes", "title": "Critical path for uncritical job nodes" }], "jobs": [{ "deleted": false, "deployed": true, "isOrderJob": true, "name": "UncriticalJobNodes", "title": "Critical path handler for uncritical job nodes" }] }], "name": "operations", "path": "/sos/operations" }, { "name": "reporting", "path": "/sos/reporting", "jobChains": [{ "deleted": false, "deployed": true, "name": "Reporting-Export2CSV", "title": "Export data into a CSV file" }, { "deleted": false, "deployed": true, "name": "Reporting", "title": "Aggregation of facts" }], "jobs": [{ "deleted": false, "deployed": true, "isOrderJob": true, "name": "Reporting-Export2CSV", "title": "Export data into a CSV file" }, { "deleted": false, "deployed": true, "isOrderJob": true, "name": "ReportingAggregation", "title": "Create aggregations from the Reporting fact tables" }] }, { "name": "rest", "path": "/sos/rest", "jobChains": [{ "deleted": false, "deployed": true, "name": "createApiAccessToken" }], "jobs": [{ "deleted": false, "deployed": true, "isOrderJob": true, "name": "createApiAccessToken" }] }, { "name": "sendMail", "path": "/sos/sendMail", "jobChains": [{ "deleted": false, "deployed": true, "name": "sendMail" }], "jobs": [{ "deleted": false, "deployed": true, "isOrderJob": true, "name": "sendMail", "title": "Send Mails from JobScheduler" }, { "deleted": false, "deployed": true, "isOrderJob": true, "name": "wait", "title": "wait until the file is completed" }] }], "name": "sos", "path": "/sos" }, { "deleted": true, "lockedBy": "test", "lockedSince": "2019-11-06T13:18:01Z", "name": "testtest", "path": "/testtest", "jobs": [{ "deleted": false, "deployed": false, "isOrderJob": false, "name": "job1" }] }], "lockedBy": "root", "lockedSince": "2019-11-04T15:11:01Z", "name": "", "path": "/", "agentClusters": [{ "deleted": false, "deployed": true, "maxProcesses": 30, "name": "agent_oh_4445" }], "jobChains": [{ "deleted": false, "deployed": true, "name": "job_chain2" }], "jobs": [{ "deleted": false, "deployed": false, "isOrderJob": false, "name": "job1" }, { "deleted": false, "deployed": false, "name": "job2" }], "processClasses": [{ "deleted": false, "deployed": true, "maxProcesses": 1, "name": "p1" }], "schedules": [{ "deleted": false, "deployed": false, "name": "schedule1" }] }] } { "deliveryDate": "2019-11-07T12:19:12.105Z", "folders": [{ "folders": [{ "lockedBy": "root", "lockedSince": "2019-11-06T13:24:26Z", "name": "Jobs", "path": "/Jobs", "jobs": [{ "deleted": false, "deployed": true, "isOrderJob": false, "name": "job1" }] }, { "folders": [{ "name": "dailyplan", "path": "/sos/dailyplan", "jobChains": [{ "deleted": false, "deployed": true, "name": "CreateDailyPlan" }], "jobs": [{ "deleted": false, "deployed": true, "isOrderJob": true, "name": "CreateDailyPlan", "title": "Creating a daily plan depending on actual Runtimes" }] }, { "name": "housekeeping", "path": "/sos/housekeeping", "jobs": [{ "deleted": false, "deployed": true, "isOrderJob": false, "name": "scheduler_cleanup_files", "title": "Remove temporary files" }, { "deleted": false, "deployed": true, "isOrderJob": false, "name": "scheduler_dequeue_mail", "title": "Send buffered mails from mail queue" }, { "deleted": false, "deployed": true, "isOrderJob": false, "name": "scheduler_restart", "title": "Restart Job Scheduler" }, { "deleted": false, "deployed": true, "isOrderJob": false, "name": "scheduler_rotate_log", "title": "Rotate and compress logfiles" }] }, { "name": "jitl", "path": "/sos/jitl", "jobs": [{ "deleted": false, "deployed": true, "isOrderJob": true, "name": "JobChainEnd", "title": "Job chain end node" }, { "deleted": false, "deployed": true, "isOrderJob": true, "name": "JobChainSplitter", "title": "Start a parallel processing in a jobchain" }, { "deleted": false, "deployed": true, "isOrderJob": true, "name": "JobChainStart", "title": "Job chain start node to load configuration monitor" }] }, { "name": "notification", "path": "/sos/notification", "jobChains": [{ "deleted": false, "deployed": true, "name": "CleanupNotifications" }, { "deleted": false, "deployed": true, "name": "ResetNotifications" }, { "deleted": false, "deployed": true, "name": "SystemNotifier" }], "jobs": [{ "deleted": false, "deployed": true, "isOrderJob": true, "name": "CleanupNotifications", "title": "Cleanup Notifications" }, { "deleted": false, "deployed": true, "isOrderJob": true, "name": "ResetNotifications", "title": "Reset notifications" }, { "deleted": false, "deployed": true, "isOrderJob": true, "name": "SystemNotifier", "title": "System notifier" }] }, { "folders": [{ "name": "criticalpath", "path": "/sos/operations/criticalpath", "jobChains": [{ "deleted": false, "deployed": true, "name": "UncriticalJobNodes", "title": "Critical path for uncritical job nodes" }], "jobs": [{ "deleted": false, "deployed": true, "isOrderJob": true, "name": "UncriticalJobNodes", "title": "Critical path handler for uncritical job nodes" }] }], "name": "operations", "path": "/sos/operations" }, { "name": "reporting", "path": "/sos/reporting", "jobChains": [{ "deleted": false, "deployed": true, "name": "Reporting-Export2CSV", "title": "Export data into a CSV file" }, { "deleted": false, "deployed": true, "name": "Reporting", "title": "Aggregation of facts" }], "jobs": [{ "deleted": false, "deployed": true, "isOrderJob": true, "name": "Reporting-Export2CSV", "title": "Export data into a CSV file" }, { "deleted": false, "deployed": true, "isOrderJob": true, "name": "ReportingAggregation", "title": "Create aggregations from the Reporting fact tables" }] }, { "name": "rest", "path": "/sos/rest", "jobChains": [{ "deleted": false, "deployed": true, "name": "createApiAccessToken" }], "jobs": [{ "deleted": false, "deployed": true, "isOrderJob": true, "name": "createApiAccessToken" }] }, { "name": "sendMail", "path": "/sos/sendMail", "jobChains": [{ "deleted": false, "deployed": true, "name": "sendMail" }], "jobs": [{ "deleted": false, "deployed": true, "isOrderJob": true, "name": "sendMail", "title": "Send Mails from JobScheduler" }, { "deleted": false, "deployed": true, "isOrderJob": true, "name": "wait", "title": "wait until the file is completed" }] }], "name": "sos", "path": "/sos" }, { "deleted": true, "lockedBy": "test", "lockedSince": "2019-11-06T13:18:01Z", "name": "testtest", "path": "/testtest", "jobs": [{ "deleted": false, "deployed": false, "isOrderJob": false, "name": "job1" }] }], "lockedBy": "root", "lockedSince": "2019-11-04T15:11:01Z", "name": "", "path": "/", "agentClusters": [{ "deleted": false, "deployed": true, "maxProcesses": 30, "name": "agent_oh_4445" }], "jobChains": [{ "deleted": false, "deployed": true, "name": "job_chain2" }], "jobs": [{ "deleted": false, "deployed": false, "isOrderJob": false, "name": "job1" }, { "deleted": false, "deployed": false, "name": "job2" }], "processClasses": [{ "deleted": false, "deployed": true, "maxProcesses": 1, "name": "p1" }], "schedules": [{ "deleted": false, "deployed": false, "name": "schedule1" }] }] }
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 'joe'	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	'joe' 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": "joe failed!" } } { "deliveryDate": "2016-05-05T21:13:35Z", "surveyDate": "2016-05-05T21:13:33Z", "error": { "code": "JOC-420", "message": "joe 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 }