JOC API

/lock/configuration

POST

Returns the configuration in XML and HTML besides the file timestamp.

Parameters in the POST body schema

include documentation/lock/lockRequired.md

Name Type Description Example Default

jobschedulerId required, string JobScheduler Master ID scheduler

Name	Type	Description	Example	Default
`jobschedulerId`	required, string	JobScheduler Master ID	scheduler
`mime`	optional, string, enum[XML,HTML]	The configuration have a XML representation where the HTML content is a highlighting version of the XML for the browser where CSS is required. span.bracket {color:black;} span.attribute_name {color:black;} span.attribute_val {color:blue;} span.namespace_name {color:black;} span.namespace_val {color:green;font-style:italic} span.element_name {color:purple;} span.cdata {color:blue;font-family:Arial,Helvetica,Sans-Serif;} pre.cdata {color:grey;}		XML

mime

optional, string,
enum[XML,HTML]

The configuration have a XML representation where the HTML content is a highlighting version of the XML for the browser where CSS is required.

span.bracket                    {color:black;}
span.attribute_name             {color:black;}
span.attribute_val              {color:blue;}
span.namespace_name             {color:black;}
span.namespace_val              {color:green;font-style:italic}
span.element_name               {color:purple;}
span.cdata                      {color:blue;font-family:Arial,Helvetica,Sans-Serif;}
pre.cdata                       {color:grey;}

XML

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": "lockConfigurationFilter",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "javaType": "com.sos.joc.model.lock.LockConfigurationFilter",
    "type": "object",
    "required": [
        "jobschedulerId",
        "lock"
    ],
    "properties": {
        "jobschedulerId": {
            "type": "string",
            "pattern": "^[^/\\<>?:\"|*]*$",
            "maxLength": 100
        },
        "lock": {
            "description": "absolute path based on live folder of a JobScheduler object.",
            "type": "string",
            "pattern": "^(/|(/[^/\\<>?:\"|*]+)+)$",
            "maxLength": 255
        },
        "mime": {
            "description": "The configuration can have a HTML representation where the HTML gets a highlighting via CSS classes.",
            "javaType": "com.sos.joc.model.common.ConfigurationMime",
            "type": "string",
            "enum": [
                "HTML",
                "XML"
            ],
            "default": "XML"
        }
    }
}

{ "lock": "/sos/dailyschedule/JID" }

{
    "lock": "/sos/dailyschedule/JID"
}

Responses

Code	Description	Body
200	Returns the lock configuration in XML or HTML format	application/json model \| example { "title": "configuration", "$schema": "http://json-schema.org/draft-04/schema#", "javaType": "com.sos.joc.model.common.Configuration200", "type": "object", "required": [ "deliveryDate", "configuration" ], "properties": { "deliveryDate": { "description": "Date time. Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ", "type": "string", "format": "date-time" }, "configuration": { "javaType": "com.sos.joc.model.common.Configuration", "type": "object", "required": [ "surveyDate", "path", "configurationDate", "content" ], "properties": { "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" }, "path": { "description": "absolute path based on live folder of a JobScheduler object.", "type": "string", "pattern": "^(/\|(/[^/\\<>?:\"\|*]+)+)$", "maxLength": 255 }, "type": { "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" ] }, "configurationDate": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" }, "content": { "javaType": "com.sos.joc.model.common.ConfigurationContent", "type": "object", "description": "A parameter can specify if the content is xml or html. Either 'xml' or 'html' is required", "oneOf": [{ "required": [ "xml" ] }, { "required": [ "html" ] }], "properties": { "xml": { "type": "string" }, "html": { "type": "string" } } } } } } } { "deliveryDate": "2016-05-05T21:13:45Z", "configuration": { "surveyDate": "2016-05-05T21:13:45Z", "path": "/sos/dailyschedule/JID", "configurationDate": "2015-12-11T10:06:39Z", "content": { "xml": "<lock/>", "html": "<span class=\"bracket\" style=\"padding-left:20px;\"><</span><span class=\"element_name\">lock</span><span class=\"bracket\">/></span>" } } } { "deliveryDate": "2016-05-05T21:13:45Z", "configuration": { "surveyDate": "2016-05-05T21:13:45Z", "path": "/sos/dailyschedule/JID", "configurationDate": "2015-12-11T10:06:39Z", "content": { "xml": "<lock/>", "html": "<span class=\"bracket\" style=\"padding-left:20px;\"><</span><span class=\"element_name\">lock</span><span class=\"bracket\">/></span>" } } }
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 'configuration'	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	'configuration' 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": "configuration failed!" } } { "deliveryDate": "2016-05-05T21:13:35Z", "surveyDate": "2016-05-05T21:13:33Z", "error": { "code": "JOC-420", "message": "configuration 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 }