JOC API

/configuration/save

POST

Stores a configuration on the server (database)

Parameters in the POST body schema

Name	Type	Description	Example
`jobschedulerId`	required, string	JobScheduler Master ID	scheduler
`account`	required, string
`configurationType`	required, string	Possible values are "CUSTOMIZATION", "IGNORELIST", "PROFILE", "SETTING"
`objectType`	optional, string required if `configurationType`=="CUSTOMIZATION"	Possible values are JobScheduler objects such as "JOB", "JOBCHAIN", etc. and "DAILYPLAN"
`name`	optional, string required if `configurationType`=="CUSTOMIZATION"
`shared`	optional, boolean
`configurationItem`	required, string
`id`	required, integer	contains the id of a customization, a new customization has the id 0

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": "save and response configuration",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "javaType": "com.sos.joc.model.configuration.Configuration",
    "type": "object",
    "required": [
        "id"
    ],
    "properties": {
        "jobschedulerId": {
            "type": "string",
            "pattern": "^[^/\\<>?:\"|*]*$",
            "maxLength": 100
        },
        "id": {
            "type": "number",
            "format": "utc-millisec",
            "minimum": 0
        },
        "account": {
            "type": "string",
            "pattern": "^[^<>]*$",
            "maxLength": 255
        },
        "configurationType": {
            "javaType": "com.sos.joc.model.configuration.ConfigurationType",
            "type": "string",
            "enum": [
                "CUSTOMIZATION",
                "IGNORELIST",
                "PROFILE",
                "SETTING"
            ]
        },
        "objectType": {
            "javaType": "com.sos.joc.model.configuration.ConfigurationObjectType",
            "type": "string",
            "enum": [
                "JOB",
                "JOBCHAIN",
                "ORDER",
                "PROCESSCLASS",
                "AGENTCLUSTER",
                "LOCK",
                "SCHEDULE",
                "FOLDER",
                "JOBSCHEDULER",
                "DAILYPLAN",
                "TASK_HISTORY",
                "ORDER_HISTORY",
                "JOBSTREAM_HISTORY",
                "YADE",
                "YADE_HISTORY",
                "EVENT",
                "AUDITLOG"
            ]
        },
        "name": {
            "type": "string",
            "pattern": "^[^<>]*$",
            "maxLength": 255
        },
        "shared": {
            "type": "boolean",
            "default": false
        },
        "configurationItem": {
            "type": "string",
            "pattern": "^[^<>]*$"
        }
    }
}

Responses

Code	Description	Body
200	Response contains the `id` of the customization. It seems to be unnecessary but if a new customization is saved (with `id=0` in the request) then you get the new id.	application/json model \| example { "title": "feedback after save, delete configuration", "$schema": "http://json-schema.org/draft-04/schema#", "javaType": "com.sos.joc.model.configuration.ConfigurationOk", "type": "object", "required": [ "deliveryDate", "id" ], "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" }, "id": { "type": "number", "format": "utc-millisec", "minimum": 0 } } } { "deliveryDate": "2016-05-05T21:13:35Z", "id": 4711 } { "deliveryDate": "2016-05-05T21:13:35Z", "id": 4711 }
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 'save'	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	'save' 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": "save failed!" } } { "deliveryDate": "2016-05-05T21:13:35Z", "surveyDate": "2016-05-05T21:13:33Z", "error": { "code": "JOC-420", "message": "save 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 }