JOC API

/job_template

POST

Gets released job template

Parameters in the POST body schema

Name	Type	Description	Example	Default
`jobTemplatePath`	required, string	Path of the job template	"/path/myJobTemplate"

Request

Name

Description

Example

Type

Constraints

Default

Headers

X-Access-Token*

Request requires authentication!

550e8400-e29b-11d4-a716-446655440000

string

Body

application/json

model | example

{
    "title": "JobTemplateFilter",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "javaType": "com.sos.joc.model.jobtemplate.JobTemplateFilter",
    "type": "object",
    "required": [
        "jobTemplatePath"
    ],
    "properties": {
        "jobTemplatePath": {
            "type": "string",
            "pattern": "^[^<>]*$",
            "maxLength": 255,
            "minLength": 1
        }
    },
    "additionalProperties": false
}

Responses

Code	Description	Body
200		application/json model \| example { "title": "JobTemplate", "$schema": "http://json-schema.org/draft-04/schema#", "javaType": "com.sos.joc.model.jobtemplate.JobTemplate", "type": "object", "properties": { "deliveryDate": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" }, "jobTemplate": { "javaType": "com.sos.controller.model.jobtemplate.JobTemplate", "type": "object", "extends": { "javaType": "com.sos.inventory.model.jobtemplate.JobTemplate", "type": "object", "javaInterfaces": [ "com.sos.joc.model.common.IConfigurationObject", "com.sos.joc.model.common.IReleaseObject", "com.sos.inventory.model.common.IInventoryObject" ], "required": [ "executable" ], "properties": { "version": { "description": "inventory repository version", "type": "string", "pattern": "[0-9]+\\.[0-9]+\\.[0-9]+", "default": "1.5.0", "maxLength": 10 }, "executable": { "javaType": "com.sos.inventory.model.job.Executable", "oneOf": [{ "javaType": "com.sos.inventory.model.job.ExecutableScript", "type": "object", "extends": { "javaType": "com.sos.inventory.model.job.Executable", "type": "object", "required": [ "TYPE" ], "properties": { "TYPE": { "javaType": "com.sos.inventory.model.job.ExecutableType", "type": "string", "enum": [ "ShellScriptExecutable", "ScriptExecutable", "InternalExecutable" ], "javaEnumNames": [ "ShellScriptExecutable", "ScriptExecutable", "InternalExecutable" ] } }, "additionalProperties": false }, "required": [ "script" ], "propertyOrder": [ "TYPE", "script", "env", "v1Compatible" ], "description": "executable with fixed property 'TYPE':'ShellScriptExecutable'", "properties": { "script": { "type": "string", "minLength": 1 }, "env": { "description": "a map for arbitrary key-value pairs", "javaType": "com.sos.inventory.model.job.Environment", "type": "object", "additionalProperties": { "type": "string" } }, "v1Compatible": { "type": "boolean", "default": false }, "returnCodeMeaning": { "javaType": "com.sos.inventory.model.job.JobReturnCode", "type": "object", "oneOf": [{ "required": [ "success" ] }, { "required": [ "failure" ] }], "properties": { "success": { "type": "array", "minItems": 1, "items": { "type": "integer" } }, "failure": { "type": "array", "minItems": 1, "items": { "type": "integer" } } }, "additionalProperties": false }, "login": { "type": "object", "javaType": "com.sos.inventory.model.job.ExecutableScriptLogin", "required": [ "credentialKey" ], "properties": { "credentialKey": { "type": "string", "minLength": 1 }, "withUserProfile": { "type": "boolean", "default": false } }, "additionalProperties": false } }, "additionalProperties": false }, { "javaType": "com.sos.inventory.model.job.ExecutableJava", "type": "object", "extends": { "javaType": "com.sos.inventory.model.job.Executable", "type": "object", "required": [ "TYPE" ], "properties": { "TYPE": { "javaType": "com.sos.inventory.model.job.ExecutableType", "type": "string", "enum": [ "ShellScriptExecutable", "ScriptExecutable", "InternalExecutable" ], "javaEnumNames": [ "ShellScriptExecutable", "ScriptExecutable", "InternalExecutable" ] } }, "additionalProperties": false }, "required": [ "className" ], "propertyOrder": [ "TYPE", "className" ], "description": "executable with fixed property 'TYPE':'InternalExecutable'", "properties": { "className": { "type": "string", "minLength": 1 }, "jobArguments": { "description": "a map for arbitrary key-value pairs", "javaType": "com.sos.inventory.model.common.Variables", "type": "object", "additionalProperties": true }, "arguments": { "description": "a map for arbitrary key-value pairs", "javaType": "com.sos.inventory.model.job.Environment", "type": "object", "additionalProperties": { "type": "string" } } }, "additionalProperties": false }] }, "admissionTimeScheme": { "javaType": "com.sos.inventory.model.job.AdmissionTimeScheme", "type": "object", "required": [ "periods" ], "properties": { "periods": { "type": "array", "items": { "javaType": "com.sos.inventory.model.job.AdmissionTimePeriod", "type": "object", "properties": { "TYPE": { "javaType": "com.sos.inventory.model.job.AdmissionTimePeriodType", "type": "string", "enum": [ "MonthlyDatePeriod", "MonthlyLastDatePeriod", "MonthlyWeekdayPeriod", "MonthlyLastWeekdayPeriod", "WeekdayPeriod", "DailyPeriod" ] }, "duration": { "type": "number", "format": "utc-millisec", "minimum": 0 } }, "additionalProperties": false } } }, "additionalProperties": false }, "skipIfNoAdmissionForOrderDay": { "type": "boolean", "default": false }, "parallelism": { "type": "integer", "minimum": 1, "default": 1 }, "timeout": { "type": "integer", "minimum": 0 }, "graceTimeout": { "description": "in seconds", "type": "integer", "minimum": 0, "default": 15 }, "failOnErrWritten": { "type": "boolean", "default": false }, "parameters": { "javaType": "com.sos.inventory.model.jobtemplate.Parameters", "type": "object", "additionalProperties": { "javaType": "com.sos.inventory.model.jobtemplate.Parameter", "type": "object", "required": [ "type" ], "properties": { "type": { "javaType": "com.sos.inventory.model.jobtemplate.ParameterType", "type": "string", "enum": [ "String", "Number", "Boolean" ], "javaEnumNames": [ "String", "Number", "Boolean" ] }, "default": { "description": "this value has to have the data type of the 'type' attribute", "anyOf": [{ "type": "string" }, { "type": "number" }, { "type": "boolean" }], "javaType": "java.lang.Object" }, "description": { "type": "string", "pattern": "^(?s)((?!<script( \|>)\|<svg/on).)$" }, "facet": { "description": "a regular expression to check the value of the parameter", "type": "string" }, "list": { "description": "enumeration of possible parameter values", "type": "array", "items": { "type": "string" } }, "message": { "description": "a message if the value doesn't match the facet", "type": "string" } }, "additionalProperties": false } }, "jobResourceNames": { "type": "array", "items": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 } }, "title": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "description": { "type": "string", "pattern": "^(?s)((?!<script( \|>)\|<svg/on).)$" }, "documentationName": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "criticality": { "javaType": "com.sos.inventory.model.job.JobCriticality", "type": "string", "enum": [ "NORMAL", "CRITICAL" ] }, "warnIfShorter": { "type": "string", "pattern": "^([0-2][0-4]:[0-5][0-9]:[0-5][0-9])?([0-9]+s?)?([0-9]+%?)?$" }, "warnIfLonger": { "type": "string", "pattern": "^([0-2][0-4]:[0-5][0-9]:[0-5][0-9])?([0-9]+s?)?([0-9]+%?)?$" }, "notification": { "javaType": "com.sos.inventory.model.job.notification.JobNotification", "type": "object", "properties": { "types": { "type": "array", "items": { "javaType": "com.sos.inventory.model.job.notification.JobNotificationType", "type": "string", "enum": [ "ERROR", "SUCCESS", "WARNING" ] } }, "mail": { "javaType": "com.sos.inventory.model.job.notification.JobNotificationMail", "type": "object", "properties": { "to": { "type": "string", "pattern": "^[^<>]$", "maxLength": 900 }, "cc": { "type": "string", "pattern": "^[^<>]$", "maxLength": 900 }, "bcc": { "type": "string", "pattern": "^[^<>]$", "maxLength": 900 } }, "additionalProperties": false } }, "additionalProperties": false } }, "additionalProperties": false }, "properties": { "name": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "path": { "description": "absolute path of an object.", "type": "string", "pattern": "^(/\|(/[^/\\\\<>?:\"\|]+)+)$", "maxLength": 255, "minLength": 1 }, "hasRequiredArguments": { "type": "boolean", "default": false } }, "additionalProperties": false } }, "additionalProperties": false }
401	Unauthorized!	application/json model \| example { "title": "authentication", "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "required": [ "isAuthenticated" ], "properties": { "user": { "type": "string" }, "accessToken": { "type": "string" }, "message": { "type": "string" }, "role": { "type": "string" }, "isAuthenticated": { "type": "boolean" }, "isPermitted": { "type": "boolean", "default": false }, "sessionTimeout": { "type": "integer", "default": 1800 }, "enableTouch": { "type": "boolean", "default": true } } } { "user": "root", "message": "Oops!", "isAuthenticated": false, "isPermitted": false } { "user": "root", "message": "Oops!", "isAuthenticated": false, "isPermitted": false }
403	Forbidden! The user doesn't have sufficient permissions for 'job_template'	application/json model \| example { "title": "authentication", "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "required": [ "isAuthenticated" ], "properties": { "user": { "type": "string" }, "accessToken": { "type": "string" }, "message": { "type": "string" }, "role": { "type": "string" }, "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 ...", "role": "all", "isAuthenticated": true, "isPermitted": false } { "user": "root", "message": "You don't have sufficient permissions for ...", "role": "all", "isAuthenticated": true, "isPermitted": false }
420	'job_template' 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": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" }, "surveyDate": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" }, "error": { "javaType": "com.sos.joc.model.common.Err", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } { "deliveryDate": "2016-05-05T21:13:35Z", "surveyDate": "2016-05-05T21:13:33Z", "error": { "code": "JOC-420", "message": "job_template failed!" } } { "deliveryDate": "2016-05-05T21:13:35Z", "surveyDate": "2016-05-05T21:13:33Z", "error": { "code": "JOC-420", "message": "job_template failed!" } }
440	Login Timeout! The client's session has expired and must log in again.	application/json model \| example { "title": "authentication", "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "required": [ "isAuthenticated" ], "properties": { "user": { "type": "string" }, "accessToken": { "type": "string" }, "message": { "type": "string" }, "role": { "type": "string" }, "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", "role": "all", "isAuthenticated": false, "isPermitted": false } { "user": "root", "message": "Session has expired. Please log in again", "role": "all", "isAuthenticated": false, "isPermitted": false }