JOC API

/joe/read/folder

POST

Read folder content

Parameters in the POST body schema

Name	Type	Description	Example	Default
`jobschedulerId`	required, string	JobScheduler Master ID	scheduler
`path`	required, string	Path of the folder

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": "filter for joe requests",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "javaType": "com.sos.joc.model.joe.common.Filter",
    "type": "object",
    "description": "oldPath is used for a move/rename, auditLog only for deploy, forceLive only for read/file",
    "required": [
        "jobschedulerId",
        "path"
    ],
    "properties": {
        "jobschedulerId": {
            "type": "string",
            "pattern": "^[^/\\<>?:\"|*]*$",
            "maxLength": 100
        },
        "path": {
            "description": "absolute path based on live folder of a JobScheduler object.",
            "type": "string",
            "pattern": "^(/|(/[^/\\<>?:\"|*]+)+)$",
            "maxLength": 255
        },
        "oldPath": {
            "description": "absolute path based on live folder of a JobScheduler object.",
            "type": "string",
            "pattern": "^(/|(/[^/\\<>?:\"|*]+)+)$",
            "maxLength": 255
        },
        "forceLive": {
            "type": "boolean"
        },
        "object": {
            "type": "string"
        },
        "objectType": {
            "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"
            ]
        }
    }
}

Responses

Code	Description	Body
200	Contains collections of jobs status (required: deployed or not and maybe marked as deleted) title (optional) processClass (optional) isOrderJob (required) job chains status (required: deployed or not and maybe marked as deleted) title (optional) processClass (optional) orders status (required: deployed or not and maybe marked as deleted) title (optional) initial state (optional) end state (optional) priority (optional) agent cluster status (required: deployed or not and maybe marked as deleted) max. processes (required) process classes status (required: deployed or not and maybe marked as deleted) max. processes (required) locks status (required: deployed or not and maybe marked as deleted) max. non-exclusive (optional) schedules status (required: deployed or not and maybe marked as deleted) title (optional) substitute (optional) valid from (optional) valid to (optional) monitors status (required: deployed or not and maybe marked as deleted)	application/json model \| example { "title": "folder content", "$schema": "http://json-schema.org/draft-04/schema#", "javaType": "com.sos.joc.model.joe.other.Folder", "type": "object", "required": [ "deliveryDate", "path" ], "properties": { "deliveryDate": { "description": "Date time. Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ", "type": "string", "format": "date-time" }, "path": { "description": "absolute path based on live folder of a JobScheduler object.", "type": "string", "pattern": "^(/\|(/[^/\\<>?:\"\|*]+)+)$", "maxLength": 255 }, "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 } } }
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 'folder'	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	'folder' 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": "folder failed!" } } { "deliveryDate": "2016-05-05T21:13:35Z", "surveyDate": "2016-05-05T21:13:33Z", "error": { "code": "JOC-420", "message": "folder 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 }