JOC API

/joe/deploy

POST

Deploys configuration files to JobScheduler

Parameters in the POST body schema

Name	Type	Description	Example	Default
`jobschedulerId`	required, string	JobScheduler Master ID	scheduler
`path`	required, string	Path of a configuration item, e.g. JobScheduler object.
`objectType`	required, string	Type of a configuration item, e.g. JobScheduler object such as JOB, JOBCHAIN, ORDER, etc.
`objectName`	optional, string	name of a object
`folder`	optional, string
`recursive`	optional, boolean			false
`account`	optional, string
	optional, boolean			false
`auditLog`	optional, object	Object which contains `comment`, `timeSpent` and `ticketLink`.	{ "comment":"It was not really necessary!", "timeSpent":2 }
`comment`	optional, string	Field in `auditLog` to comment this action, e.g. the reason.
`timeSpent`	optional, string	Field in `auditLog` to enter the time spent in minutes.	5
`ticketLink`	optional, string	Field in `auditLog` to enter a link to a corresponding ticket.

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 Deploy",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "javaType": "com.sos.joc.model.joe.common.FilterDeploy",
    "type": "object",
    "required": [
        "jobschedulerId",
        "folder"
    ],
    "properties": {
        "jobschedulerId": {
            "type": "string",
            "pattern": "^[^/\\<>?:\"|*]*$",
            "maxLength": 100
        },
        "folder": {
            "description": "absolute path based on live folder of a JobScheduler object.",
            "type": "string",
            "pattern": "^(/|(/[^/\\<>?:\"|*]+)+)$",
            "maxLength": 255
        },
        "recursive": {
            "type": "boolean"
        },
        "objectName": {
            "type": "string",
            "pattern": "^[^/\\<>?:\"|*]*$",
            "maxLength": 255
        },
        "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"
            ]
        },
        "account": {
            "type": "string",
            "pattern": "^[^<>]*$",
            "maxLength": 255
        },
        "auditLog": {
            "javaType": "com.sos.joc.model.audit.AuditParams",
            "type": "object",
            "properties": {
                "comment": {
                    "type": "string",
                    "pattern": "^[^<>]*$",
                    "maxLength": 255
                },
                "timeSpent": {
                    "type": "integer",
                    "minimum": 0
                },
                "ticketLink": {
                    "type": "string",
                    "pattern": "^[^<>]*$",
                    "maxLength": 255
                }
            }
        }
    }
}

Responses

Code	Description	Body
200		application/json model \| example { "title": "Answer for Deploy", "$schema": "http://json-schema.org/draft-04/schema#", "javaType": "com.sos.joc.model.joe.common.DeployAnswer", "type": "object", "description": "", "required": [ "jobschedulerId", "path" ], "properties": { "jobschedulerId": { "type": "string" }, "folder": { "description": "absolute path based on live folder of a JobScheduler object.", "type": "string", "pattern": "^(/\|(/[^/\\<>?:\"\|]+)+)$", "maxLength": 255 }, "recursive": { "type": "boolean" }, "objectName": { "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" ] }, "report": { "type": "array", "items": { "javaType": "com.sos.joc.model.joe.common.DeployMessage", "type": "object", "required": [ "action", "path", "objectType" ], "properties": { "action": { "javaType": "com.sos.joc.model.joe.common.DeployActionType", "type": "string", "enum": [ "DEPLOYED", "DELETED", "SKIPPED" ] }, "path": { "description": "absolute path based on live folder of a JobScheduler object.", "type": "string", "pattern": "^(/\|(/[^/\\<>?:\"\|]+)+)$", "maxLength": 255 }, "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" ] }, "failReason": { "type": "object", "javaType": "com.sos.joc.model.joe.common.DeployFailReason", "required": [ "_key" ], "properties": { "_key": { "javaType": "com.sos.joc.model.joe.common.DeployFailReasonType", "type": "string", "enum": [ "WRONG_OWNERSHIP", "MISSING_OBJECT_PERMISSIONS", "MISSING_FOLDER_PERMISSIONS", "INCOMPLETE_CONFIGURATION" ] }, "message": { "type": "string" }, "owner": { "description": "useful to substitute in the WRONG_OWNERSHIP message", "type": "string" } } } } } } } }
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 'deploy'	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	'deploy' 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": "deploy failed!" } } { "deliveryDate": "2016-05-05T21:13:35Z", "surveyDate": "2016-05-05T21:13:33Z", "error": { "code": "JOC-420", "message": "deploy 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 }