JOC API

/workflow/dependencies

POST

Returns workflow dependencies

Parameters in the POST body schema

Name	Type	Description	Example	Default
`controllerId`	required, string	Controller ID	myController
`workflowId`	required, object	Workflow ID specified by its path and optional version	{ "path": "/path/to/workflow", "versionId": "c79caab4-4e72-4818-bae7-902f1037d8b6" }
`path`	required, string	Field in `workflowId` to specify the path of a workflow
`versionId`	optional, string	Field in `workflowId` to specify the version of a workflow
`compact`	optional, boolean	A compact response is returned if this parameter is true		false

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": "workflowFilter",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "javaType": "com.sos.joc.model.workflow.WorkflowFilter",
    "type": "object",
    "required": [
        "controllerId",
        "workflowId"
    ],
    "properties": {
        "controllerId": {
            "type": "string",
            "pattern": "^[^/\\<>?:\"|*]*$",
            "maxLength": 100,
            "minLength": 1
        },
        "workflowId": {
            "javaType": "com.sos.controller.model.workflow.WorkflowId",
            "type": "object",
            "required": [
                "path"
            ],
            "properties": {
                "path": {
                    "type": "string",
                    "pattern": "^[^<>]*$",
                    "maxLength": 255,
                    "minLength": 1
                },
                "versionId": {
                    "type": "string",
                    "pattern": "^[^<>]*$",
                    "maxLength": 255
                }
            },
            "additionalProperties": false
        },
        "compact": {
            "description": "controls if the object's data is compact or detailed",
            "type": "boolean",
            "default": false
        }
    }
}

{ "controllerId": "standalone", "workflowId": { "path": "/JS7Demo/01_HelloWorld/jdHelloWorld" } }

{
    "controllerId": "standalone",
    "workflowId": {
        "path": "/JS7Demo/01_HelloWorld/jdHelloWorld"
    }
}

Responses

Code	Description	Body
200	TODO	application/json model \| example { "title": "workflow dependencies", "$schema": "http://json-schema.org/draft-04/schema#", "javaType": "com.sos.joc.model.workflow.WorkflowDeps", "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" }, "surveyDate": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" }, "workflow": { "javaType": "com.sos.controller.model.workflow.WorkflowDeps", "type": "object", "extends": { "javaType": "com.sos.controller.model.workflow.Workflow", "type": "object", "extends": { "javaType": "com.sos.inventory.model.workflow.Workflow", "type": "object", "javaInterfaces": [ "com.sos.joc.model.common.IConfigurationObject", "com.sos.joc.model.common.IDeployObject", "com.sos.inventory.model.common.IInventoryObject" ], "required": [ "instructions" ], "propertyOrder": [ "TYPE", "version", "versionId", "timeZone", "title", "documentationName", "orderPreparation", "jobResourceNames", "instructions", "jobs" ], "description": "deploy object with fixed property 'TYPE':'Workflow'", "properties": { "TYPE": { "javaType": "com.sos.inventory.model.deploy.DeployType", "type": "string", "enum": [ "Workflow", "JobClass", "Lock", "FileWatch", "JobResource", "Board" ], "javaEnumNames": [ "Workflow", "JobClass", "Lock", "FileWatch", "JobResource", "Board" ], "default": "Workflow" }, "version": { "description": "inventory repository version", "type": "string", "pattern": "[0-9]+\\.[0-9]+\\.[0-9]+", "default": "1.5.0", "maxLength": 10 }, "versionId": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "timeZone": { "type": "string", "default": "Etc/UTC" }, "title": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "documentationName": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "orderPreparation": { "javaType": "com.sos.inventory.model.workflow.Requirements", "type": "object", "alias": "orderRequirements", "properties": { "parameters": { "javaType": "com.sos.inventory.model.workflow.Parameters", "type": "object", "additionalProperties": { "javaType": "com.sos.inventory.model.workflow.Parameter", "type": "object", "required": [ "type" ], "properties": { "type": { "javaType": "com.sos.inventory.model.workflow.ParameterType", "type": "string", "enum": [ "String", "Number", "Boolean", "List" ], "javaEnumNames": [ "String", "Number", "Boolean", "List" ] }, "default": { "description": "this value has to have the data type of the 'type' attribute", "anyOf": [{ "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "array" }], "javaType": "java.lang.Object" }, "final": { "type": "string" }, "listParameters": { "javaType": "com.sos.inventory.model.workflow.ListParameters", "type": "object", "description": "parameters only for parameter type 'List'", "additionalProperties": { "javaType": "com.sos.inventory.model.workflow.ListParameter", "type": "object", "required": [ "type" ], "description": "parameter type only Number, Boolean or String", "properties": { "type": { "javaType": "com.sos.inventory.model.workflow.ListParameterType", "type": "string", "enum": [ "String", "Number", "Boolean" ], "javaEnumNames": [ "String", "Number", "Boolean" ] } }, "additionalProperties": false } }, "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 } }, "allowUndeclared": { "type": "boolean", "default": false } }, "additionalProperties": false }, "jobResourceNames": { "alias": "jobResourcePaths", "type": "array", "items": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 } }, "instructions": { "type": "array", "minItems": 1, "items": { "javaType": "com.sos.inventory.model.instruction.Instruction", "type": "object", "required": [ "TYPE" ], "properties": { "TYPE": { "javaType": "com.sos.inventory.model.instruction.InstructionType", "type": "string", "enum": [ "Execute.Named", "If", "Try", "Fork", "ForkList", "Finish", "Fail", "Retry", "Lock", "Prompt", "PostNotice", "PostNotices", "ExpectNotice", "ExpectNotices", "ConsumeNotices", "ImplicitEnd", "AddOrder", "Cycle" ] }, "position": { "description": "Actually, each even item is a string, each odd item is an integer", "type": "array", "items": { "anyOf": [{ "type": "integer" }, { "type": "string" }] } }, "positionString": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "state": { "javaType": "com.sos.inventory.model.instruction.InstructionState", "type": "object", "required": [ "severity", "_text" ], "properties": { "severity": { "type": "integer" }, "_text": { "javaType": "com.sos.inventory.model.instruction.InstructionStateText", "type": "string", "enum": [ "SKIPPED", "STOPPED", "STOPPED_AND_SKIPPED" ] } }, "additionalProperties": false } }, "additionalProperties": false } }, "jobs": { "javaType": "com.sos.inventory.model.workflow.Jobs", "type": "object", "additionalProperties": { "javaType": "com.sos.inventory.model.job.Job", "type": "object", "javaInterfaces": [ "com.sos.joc.model.common.IConfigurationObject" ], "required": [ "agentName", "executable" ], "description": "returnCodeMeaning is deprecated: moved to ShellScriptExecutable", "properties": { "agentName": { "alias": "agentId,agentPath", "type": "string", "pattern": "^[^<>]$", "maxLength": 255, "minLength": 1 }, "subagentClusterId": { "alias": "subagentSelectionId", "type": "string", "pattern": "^[^<>]$", "maxLength": 255, "minLength": 1 }, "subagentClusterIdExpr": { "alias": "subagentSelectionIdExpr", "type": "string", "pattern": "^[^<>]$", "maxLength": 255, "minLength": 1 }, "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", "SpecificDatePeriod" ] }, "duration": { "type": "number", "format": "utc-millisec", "minimum": 0 } }, "additionalProperties": false } } }, "additionalProperties": false }, "skipIfNoAdmissionForOrderDay": { "alias": "skipIfNoAdmissionStartForOrderDay", "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 }, "parallelism": { "alias": "taskLimit", "type": "integer", "minimum": 1, "default": 1 }, "timeout": { "type": "integer", "minimum": 0 }, "graceTimeout": { "alias": "sigkillDelay", "description": "in seconds", "type": "integer", "minimum": 0, "default": 15 }, "failOnErrWritten": { "type": "boolean", "default": false }, "warnOnErrWritten": { "type": "boolean", "default": false }, "jobClassName": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "jobTemplate": { "type": "object", "javaType": "com.sos.inventory.model.job.JobTemplateRef", "properties": { "name": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255, "minLength": 1 }, "hash": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 } }, "additionalProperties": false }, "defaultArguments": { "description": "a map for arbitrary key-value pairs", "javaType": "com.sos.inventory.model.job.Environment", "type": "object", "additionalProperties": { "type": "string" } }, "jobResourceNames": { "alias": "jobResourcePaths", "type": "array", "items": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 } }, "title": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "documentationName": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "criticality": { "javaType": "com.sos.inventory.model.job.JobCriticality", "type": "string", "enum": [ "NORMAL", "CRITICAL" ] }, "warnIfShorter": { "type": "string", "pattern": "^([0-9]+:[0-5][0-9]:[0-5][0-9]\|[0-9]+s?\|[0-9]+%)$" }, "warnIfLonger": { "type": "string", "pattern": "^([0-9]+:[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 } } }, "additionalProperties": false }, "properties": { "path": { "description": "absolute path of an object.", "type": "string", "pattern": "^(/\|(/[^/\\\\<>?:\"\|]+)+)$", "maxLength": 255, "minLength": 1 }, "isCurrentVersion": { "type": "boolean", "default": true }, "versionDate": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" }, "state": { "javaType": "com.sos.controller.model.common.SyncState", "type": "object", "required": [ "severity", "_text" ], "properties": { "severity": { "type": "integer" }, "_text": { "javaType": "com.sos.controller.model.common.SyncStateText", "description": "SUSPENDED, OUTSTANDING only for Workflows", "type": "string", "enum": [ "IN_SYNC", "NOT_IN_SYNC", "NOT_DEPLOYED", "SUSPENDED", "OUTSTANDING", "UNKNOWN" ] } } }, "suspended": { "description": "true if state._text == SUSPENDED or SUSPENDING", "type": "boolean", "default": false }, "fileOrderSources": { "type": "array", "items": { "javaType": "com.sos.controller.model.fileordersource.FileOrderSource", "type": "object", "extends": { "javaType": "com.sos.inventory.model.fileordersource.FileOrderSource", "type": "object", "javaInterfaces": [ "com.sos.joc.model.common.IConfigurationObject", "com.sos.joc.model.common.IDeployObject", "com.sos.inventory.model.common.IInventoryObject" ], "required": [ "workflowName", "agentName", "directory" ], "propertyOrder": [ "TYPE", "version", "workflowName", "agentName", "directory", "pattern", "timeZone", "delay", "title", "documentationName" ], "description": "deploy object with fixed property 'TYPE':'FileWatch'", "properties": { "TYPE": { "javaType": "com.sos.inventory.model.deploy.DeployType", "type": "string", "enum": [ "Workflow", "JobClass", "Lock", "FileWatch", "JobResource", "Board" ], "javaEnumNames": [ "Workflow", "JobClass", "Lock", "FileWatch", "JobResource", "Board" ], "default": "Workflow" }, "version": { "description": "inventory repository version", "type": "string", "pattern": "[0-9]+\\.[0-9]+\\.[0-9]+", "default": "1.0.0", "maxLength": 10 }, "workflowName": { "alias": "workflowPath", "type": "string", "pattern": "^[^<>]$", "maxLength": 255, "minLength": 1 }, "agentName": { "alias": "agentId,agentPath", "type": "string", "pattern": "^[^<>]$", "maxLength": 255, "minLength": 1 }, "directory": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255, "minLength": 1 }, "pattern": { "type": "string" }, "timeZone": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "delay": { "type": "integer", "format": "utc-millisec", "minimum": 1, "maximum": 9999 }, "title": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "documentationName": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 } }, "additionalProperties": false }, "properties": { "path": { "description": "absolute path of an object.", "type": "string", "pattern": "^(/\|(/[^/\\\\<>?:\"\|]+)+)$", "maxLength": 255, "minLength": 1 }, "versionDate": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" }, "state": { "javaType": "com.sos.controller.model.common.SyncState", "type": "object", "required": [ "severity", "_text" ], "properties": { "severity": { "type": "integer" }, "_text": { "javaType": "com.sos.controller.model.common.SyncStateText", "type": "string", "enum": [ "IN_SYNC", "NOT_IN_SYNC", "UNKNOWN" ] } } } }, "additionalProperties": false } }, "forkListVariables": { "type": "array", "uniqueItems": true, "items": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 } }, "hasExpectedNoticeBoards": { "type": "boolean" }, "hasPostNoticeBoards": { "type": "boolean" }, "hasConsumeNoticeBoards": { "type": "boolean" }, "hasAddOrderDependencies": { "type": "boolean" }, "numOfStoppedInstructions": { "type": "integer", "minimum": 0 }, "numOfSkippedInstructions": { "type": "integer", "minimum": 0 } }, "additionalProperties": false }, "properties": { "consumeNoticeBoards": { "javaType": "com.sos.controller.model.workflow.BoardWorkflows", "type": "object", "additionalProperties": { "type": "array", "items": { "javaType": "com.sos.controller.model.workflow.Workflow", "type": "object", "extends": { "javaType": "com.sos.inventory.model.workflow.Workflow", "type": "object", "javaInterfaces": [ "com.sos.joc.model.common.IConfigurationObject", "com.sos.joc.model.common.IDeployObject", "com.sos.inventory.model.common.IInventoryObject" ], "required": [ "instructions" ], "propertyOrder": [ "TYPE", "version", "versionId", "timeZone", "title", "documentationName", "orderPreparation", "jobResourceNames", "instructions", "jobs" ], "description": "deploy object with fixed property 'TYPE':'Workflow'", "properties": { "TYPE": { "javaType": "com.sos.inventory.model.deploy.DeployType", "type": "string", "enum": [ "Workflow", "JobClass", "Lock", "FileWatch", "JobResource", "Board" ], "javaEnumNames": [ "Workflow", "JobClass", "Lock", "FileWatch", "JobResource", "Board" ], "default": "Workflow" }, "version": { "description": "inventory repository version", "type": "string", "pattern": "[0-9]+\\.[0-9]+\\.[0-9]+", "default": "1.5.0", "maxLength": 10 }, "versionId": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "timeZone": { "type": "string", "default": "Etc/UTC" }, "title": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "documentationName": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "orderPreparation": { "javaType": "com.sos.inventory.model.workflow.Requirements", "type": "object", "alias": "orderRequirements", "properties": { "parameters": { "javaType": "com.sos.inventory.model.workflow.Parameters", "type": "object", "additionalProperties": { "javaType": "com.sos.inventory.model.workflow.Parameter", "type": "object", "required": [ "type" ], "properties": { "type": { "javaType": "com.sos.inventory.model.workflow.ParameterType", "type": "string", "enum": [ "String", "Number", "Boolean", "List" ], "javaEnumNames": [ "String", "Number", "Boolean", "List" ] }, "default": { "description": "this value has to have the data type of the 'type' attribute", "anyOf": [{ "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "array" }], "javaType": "java.lang.Object" }, "final": { "type": "string" }, "listParameters": { "javaType": "com.sos.inventory.model.workflow.ListParameters", "type": "object", "description": "parameters only for parameter type 'List'", "additionalProperties": { "javaType": "com.sos.inventory.model.workflow.ListParameter", "type": "object", "required": [ "type" ], "description": "parameter type only Number, Boolean or String", "properties": { "type": { "javaType": "com.sos.inventory.model.workflow.ListParameterType", "type": "string", "enum": [ "String", "Number", "Boolean" ], "javaEnumNames": [ "String", "Number", "Boolean" ] } }, "additionalProperties": false } }, "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 } }, "allowUndeclared": { "type": "boolean", "default": false } }, "additionalProperties": false }, "jobResourceNames": { "alias": "jobResourcePaths", "type": "array", "items": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 } }, "instructions": { "type": "array", "minItems": 1, "items": { "javaType": "com.sos.inventory.model.instruction.Instruction", "type": "object", "required": [ "TYPE" ], "properties": { "TYPE": { "javaType": "com.sos.inventory.model.instruction.InstructionType", "type": "string", "enum": [ "Execute.Named", "If", "Try", "Fork", "ForkList", "Finish", "Fail", "Retry", "Lock", "Prompt", "PostNotice", "PostNotices", "ExpectNotice", "ExpectNotices", "ConsumeNotices", "ImplicitEnd", "AddOrder", "Cycle" ] }, "position": { "description": "Actually, each even item is a string, each odd item is an integer", "type": "array", "items": { "anyOf": [{ "type": "integer" }, { "type": "string" }] } }, "positionString": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "state": { "javaType": "com.sos.inventory.model.instruction.InstructionState", "type": "object", "required": [ "severity", "_text" ], "properties": { "severity": { "type": "integer" }, "_text": { "javaType": "com.sos.inventory.model.instruction.InstructionStateText", "type": "string", "enum": [ "SKIPPED", "STOPPED", "STOPPED_AND_SKIPPED" ] } }, "additionalProperties": false } }, "additionalProperties": false } }, "jobs": { "javaType": "com.sos.inventory.model.workflow.Jobs", "type": "object", "additionalProperties": { "javaType": "com.sos.inventory.model.job.Job", "type": "object", "javaInterfaces": [ "com.sos.joc.model.common.IConfigurationObject" ], "required": [ "agentName", "executable" ], "description": "returnCodeMeaning is deprecated: moved to ShellScriptExecutable", "properties": { "agentName": { "alias": "agentId,agentPath", "type": "string", "pattern": "^[^<>]$", "maxLength": 255, "minLength": 1 }, "subagentClusterId": { "alias": "subagentSelectionId", "type": "string", "pattern": "^[^<>]$", "maxLength": 255, "minLength": 1 }, "subagentClusterIdExpr": { "alias": "subagentSelectionIdExpr", "type": "string", "pattern": "^[^<>]$", "maxLength": 255, "minLength": 1 }, "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", "SpecificDatePeriod" ] }, "duration": { "type": "number", "format": "utc-millisec", "minimum": 0 } }, "additionalProperties": false } } }, "additionalProperties": false }, "skipIfNoAdmissionForOrderDay": { "alias": "skipIfNoAdmissionStartForOrderDay", "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 }, "parallelism": { "alias": "taskLimit", "type": "integer", "minimum": 1, "default": 1 }, "timeout": { "type": "integer", "minimum": 0 }, "graceTimeout": { "alias": "sigkillDelay", "description": "in seconds", "type": "integer", "minimum": 0, "default": 15 }, "failOnErrWritten": { "type": "boolean", "default": false }, "warnOnErrWritten": { "type": "boolean", "default": false }, "jobClassName": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "jobTemplate": { "type": "object", "javaType": "com.sos.inventory.model.job.JobTemplateRef", "properties": { "name": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255, "minLength": 1 }, "hash": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 } }, "additionalProperties": false }, "defaultArguments": { "description": "a map for arbitrary key-value pairs", "javaType": "com.sos.inventory.model.job.Environment", "type": "object", "additionalProperties": { "type": "string" } }, "jobResourceNames": { "alias": "jobResourcePaths", "type": "array", "items": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 } }, "title": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "documentationName": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "criticality": { "javaType": "com.sos.inventory.model.job.JobCriticality", "type": "string", "enum": [ "NORMAL", "CRITICAL" ] }, "warnIfShorter": { "type": "string", "pattern": "^([0-9]+:[0-5][0-9]:[0-5][0-9]\|[0-9]+s?\|[0-9]+%)$" }, "warnIfLonger": { "type": "string", "pattern": "^([0-9]+:[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 } } }, "additionalProperties": false }, "properties": { "path": { "description": "absolute path of an object.", "type": "string", "pattern": "^(/\|(/[^/\\\\<>?:\"\|]+)+)$", "maxLength": 255, "minLength": 1 }, "isCurrentVersion": { "type": "boolean", "default": true }, "versionDate": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" }, "state": { "javaType": "com.sos.controller.model.common.SyncState", "type": "object", "required": [ "severity", "_text" ], "properties": { "severity": { "type": "integer" }, "_text": { "javaType": "com.sos.controller.model.common.SyncStateText", "description": "SUSPENDED, OUTSTANDING only for Workflows", "type": "string", "enum": [ "IN_SYNC", "NOT_IN_SYNC", "NOT_DEPLOYED", "SUSPENDED", "OUTSTANDING", "UNKNOWN" ] } } }, "suspended": { "description": "true if state._text == SUSPENDED or SUSPENDING", "type": "boolean", "default": false }, "fileOrderSources": { "type": "array", "items": { "javaType": "com.sos.controller.model.fileordersource.FileOrderSource", "type": "object", "extends": { "javaType": "com.sos.inventory.model.fileordersource.FileOrderSource", "type": "object", "javaInterfaces": [ "com.sos.joc.model.common.IConfigurationObject", "com.sos.joc.model.common.IDeployObject", "com.sos.inventory.model.common.IInventoryObject" ], "required": [ "workflowName", "agentName", "directory" ], "propertyOrder": [ "TYPE", "version", "workflowName", "agentName", "directory", "pattern", "timeZone", "delay", "title", "documentationName" ], "description": "deploy object with fixed property 'TYPE':'FileWatch'", "properties": { "TYPE": { "javaType": "com.sos.inventory.model.deploy.DeployType", "type": "string", "enum": [ "Workflow", "JobClass", "Lock", "FileWatch", "JobResource", "Board" ], "javaEnumNames": [ "Workflow", "JobClass", "Lock", "FileWatch", "JobResource", "Board" ], "default": "Workflow" }, "version": { "description": "inventory repository version", "type": "string", "pattern": "[0-9]+\\.[0-9]+\\.[0-9]+", "default": "1.0.0", "maxLength": 10 }, "workflowName": { "alias": "workflowPath", "type": "string", "pattern": "^[^<>]$", "maxLength": 255, "minLength": 1 }, "agentName": { "alias": "agentId,agentPath", "type": "string", "pattern": "^[^<>]$", "maxLength": 255, "minLength": 1 }, "directory": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255, "minLength": 1 }, "pattern": { "type": "string" }, "timeZone": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "delay": { "type": "integer", "format": "utc-millisec", "minimum": 1, "maximum": 9999 }, "title": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "documentationName": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 } }, "additionalProperties": false }, "properties": { "path": { "description": "absolute path of an object.", "type": "string", "pattern": "^(/\|(/[^/\\\\<>?:\"\|]+)+)$", "maxLength": 255, "minLength": 1 }, "versionDate": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" }, "state": { "javaType": "com.sos.controller.model.common.SyncState", "type": "object", "required": [ "severity", "_text" ], "properties": { "severity": { "type": "integer" }, "_text": { "javaType": "com.sos.controller.model.common.SyncStateText", "type": "string", "enum": [ "IN_SYNC", "NOT_IN_SYNC", "UNKNOWN" ] } } } }, "additionalProperties": false } }, "forkListVariables": { "type": "array", "uniqueItems": true, "items": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 } }, "hasExpectedNoticeBoards": { "type": "boolean" }, "hasPostNoticeBoards": { "type": "boolean" }, "hasConsumeNoticeBoards": { "type": "boolean" }, "hasAddOrderDependencies": { "type": "boolean" }, "numOfStoppedInstructions": { "type": "integer", "minimum": 0 }, "numOfSkippedInstructions": { "type": "integer", "minimum": 0 } }, "additionalProperties": false } } }, "expectedNoticeBoards": { "javaType": "com.sos.controller.model.workflow.BoardWorkflows", "type": "object", "additionalProperties": { "type": "array", "items": { "javaType": "com.sos.controller.model.workflow.Workflow", "type": "object", "extends": { "javaType": "com.sos.inventory.model.workflow.Workflow", "type": "object", "javaInterfaces": [ "com.sos.joc.model.common.IConfigurationObject", "com.sos.joc.model.common.IDeployObject", "com.sos.inventory.model.common.IInventoryObject" ], "required": [ "instructions" ], "propertyOrder": [ "TYPE", "version", "versionId", "timeZone", "title", "documentationName", "orderPreparation", "jobResourceNames", "instructions", "jobs" ], "description": "deploy object with fixed property 'TYPE':'Workflow'", "properties": { "TYPE": { "javaType": "com.sos.inventory.model.deploy.DeployType", "type": "string", "enum": [ "Workflow", "JobClass", "Lock", "FileWatch", "JobResource", "Board" ], "javaEnumNames": [ "Workflow", "JobClass", "Lock", "FileWatch", "JobResource", "Board" ], "default": "Workflow" }, "version": { "description": "inventory repository version", "type": "string", "pattern": "[0-9]+\\.[0-9]+\\.[0-9]+", "default": "1.5.0", "maxLength": 10 }, "versionId": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "timeZone": { "type": "string", "default": "Etc/UTC" }, "title": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "documentationName": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "orderPreparation": { "javaType": "com.sos.inventory.model.workflow.Requirements", "type": "object", "alias": "orderRequirements", "properties": { "parameters": { "javaType": "com.sos.inventory.model.workflow.Parameters", "type": "object", "additionalProperties": { "javaType": "com.sos.inventory.model.workflow.Parameter", "type": "object", "required": [ "type" ], "properties": { "type": { "javaType": "com.sos.inventory.model.workflow.ParameterType", "type": "string", "enum": [ "String", "Number", "Boolean", "List" ], "javaEnumNames": [ "String", "Number", "Boolean", "List" ] }, "default": { "description": "this value has to have the data type of the 'type' attribute", "anyOf": [{ "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "array" }], "javaType": "java.lang.Object" }, "final": { "type": "string" }, "listParameters": { "javaType": "com.sos.inventory.model.workflow.ListParameters", "type": "object", "description": "parameters only for parameter type 'List'", "additionalProperties": { "javaType": "com.sos.inventory.model.workflow.ListParameter", "type": "object", "required": [ "type" ], "description": "parameter type only Number, Boolean or String", "properties": { "type": { "javaType": "com.sos.inventory.model.workflow.ListParameterType", "type": "string", "enum": [ "String", "Number", "Boolean" ], "javaEnumNames": [ "String", "Number", "Boolean" ] } }, "additionalProperties": false } }, "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 } }, "allowUndeclared": { "type": "boolean", "default": false } }, "additionalProperties": false }, "jobResourceNames": { "alias": "jobResourcePaths", "type": "array", "items": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 } }, "instructions": { "type": "array", "minItems": 1, "items": { "javaType": "com.sos.inventory.model.instruction.Instruction", "type": "object", "required": [ "TYPE" ], "properties": { "TYPE": { "javaType": "com.sos.inventory.model.instruction.InstructionType", "type": "string", "enum": [ "Execute.Named", "If", "Try", "Fork", "ForkList", "Finish", "Fail", "Retry", "Lock", "Prompt", "PostNotice", "PostNotices", "ExpectNotice", "ExpectNotices", "ConsumeNotices", "ImplicitEnd", "AddOrder", "Cycle" ] }, "position": { "description": "Actually, each even item is a string, each odd item is an integer", "type": "array", "items": { "anyOf": [{ "type": "integer" }, { "type": "string" }] } }, "positionString": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "state": { "javaType": "com.sos.inventory.model.instruction.InstructionState", "type": "object", "required": [ "severity", "_text" ], "properties": { "severity": { "type": "integer" }, "_text": { "javaType": "com.sos.inventory.model.instruction.InstructionStateText", "type": "string", "enum": [ "SKIPPED", "STOPPED", "STOPPED_AND_SKIPPED" ] } }, "additionalProperties": false } }, "additionalProperties": false } }, "jobs": { "javaType": "com.sos.inventory.model.workflow.Jobs", "type": "object", "additionalProperties": { "javaType": "com.sos.inventory.model.job.Job", "type": "object", "javaInterfaces": [ "com.sos.joc.model.common.IConfigurationObject" ], "required": [ "agentName", "executable" ], "description": "returnCodeMeaning is deprecated: moved to ShellScriptExecutable", "properties": { "agentName": { "alias": "agentId,agentPath", "type": "string", "pattern": "^[^<>]$", "maxLength": 255, "minLength": 1 }, "subagentClusterId": { "alias": "subagentSelectionId", "type": "string", "pattern": "^[^<>]$", "maxLength": 255, "minLength": 1 }, "subagentClusterIdExpr": { "alias": "subagentSelectionIdExpr", "type": "string", "pattern": "^[^<>]$", "maxLength": 255, "minLength": 1 }, "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", "SpecificDatePeriod" ] }, "duration": { "type": "number", "format": "utc-millisec", "minimum": 0 } }, "additionalProperties": false } } }, "additionalProperties": false }, "skipIfNoAdmissionForOrderDay": { "alias": "skipIfNoAdmissionStartForOrderDay", "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 }, "parallelism": { "alias": "taskLimit", "type": "integer", "minimum": 1, "default": 1 }, "timeout": { "type": "integer", "minimum": 0 }, "graceTimeout": { "alias": "sigkillDelay", "description": "in seconds", "type": "integer", "minimum": 0, "default": 15 }, "failOnErrWritten": { "type": "boolean", "default": false }, "warnOnErrWritten": { "type": "boolean", "default": false }, "jobClassName": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "jobTemplate": { "type": "object", "javaType": "com.sos.inventory.model.job.JobTemplateRef", "properties": { "name": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255, "minLength": 1 }, "hash": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 } }, "additionalProperties": false }, "defaultArguments": { "description": "a map for arbitrary key-value pairs", "javaType": "com.sos.inventory.model.job.Environment", "type": "object", "additionalProperties": { "type": "string" } }, "jobResourceNames": { "alias": "jobResourcePaths", "type": "array", "items": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 } }, "title": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "documentationName": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "criticality": { "javaType": "com.sos.inventory.model.job.JobCriticality", "type": "string", "enum": [ "NORMAL", "CRITICAL" ] }, "warnIfShorter": { "type": "string", "pattern": "^([0-9]+:[0-5][0-9]:[0-5][0-9]\|[0-9]+s?\|[0-9]+%)$" }, "warnIfLonger": { "type": "string", "pattern": "^([0-9]+:[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 } } }, "additionalProperties": false }, "properties": { "path": { "description": "absolute path of an object.", "type": "string", "pattern": "^(/\|(/[^/\\\\<>?:\"\|]+)+)$", "maxLength": 255, "minLength": 1 }, "isCurrentVersion": { "type": "boolean", "default": true }, "versionDate": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" }, "state": { "javaType": "com.sos.controller.model.common.SyncState", "type": "object", "required": [ "severity", "_text" ], "properties": { "severity": { "type": "integer" }, "_text": { "javaType": "com.sos.controller.model.common.SyncStateText", "description": "SUSPENDED, OUTSTANDING only for Workflows", "type": "string", "enum": [ "IN_SYNC", "NOT_IN_SYNC", "NOT_DEPLOYED", "SUSPENDED", "OUTSTANDING", "UNKNOWN" ] } } }, "suspended": { "description": "true if state._text == SUSPENDED or SUSPENDING", "type": "boolean", "default": false }, "fileOrderSources": { "type": "array", "items": { "javaType": "com.sos.controller.model.fileordersource.FileOrderSource", "type": "object", "extends": { "javaType": "com.sos.inventory.model.fileordersource.FileOrderSource", "type": "object", "javaInterfaces": [ "com.sos.joc.model.common.IConfigurationObject", "com.sos.joc.model.common.IDeployObject", "com.sos.inventory.model.common.IInventoryObject" ], "required": [ "workflowName", "agentName", "directory" ], "propertyOrder": [ "TYPE", "version", "workflowName", "agentName", "directory", "pattern", "timeZone", "delay", "title", "documentationName" ], "description": "deploy object with fixed property 'TYPE':'FileWatch'", "properties": { "TYPE": { "javaType": "com.sos.inventory.model.deploy.DeployType", "type": "string", "enum": [ "Workflow", "JobClass", "Lock", "FileWatch", "JobResource", "Board" ], "javaEnumNames": [ "Workflow", "JobClass", "Lock", "FileWatch", "JobResource", "Board" ], "default": "Workflow" }, "version": { "description": "inventory repository version", "type": "string", "pattern": "[0-9]+\\.[0-9]+\\.[0-9]+", "default": "1.0.0", "maxLength": 10 }, "workflowName": { "alias": "workflowPath", "type": "string", "pattern": "^[^<>]$", "maxLength": 255, "minLength": 1 }, "agentName": { "alias": "agentId,agentPath", "type": "string", "pattern": "^[^<>]$", "maxLength": 255, "minLength": 1 }, "directory": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255, "minLength": 1 }, "pattern": { "type": "string" }, "timeZone": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "delay": { "type": "integer", "format": "utc-millisec", "minimum": 1, "maximum": 9999 }, "title": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "documentationName": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 } }, "additionalProperties": false }, "properties": { "path": { "description": "absolute path of an object.", "type": "string", "pattern": "^(/\|(/[^/\\\\<>?:\"\|]+)+)$", "maxLength": 255, "minLength": 1 }, "versionDate": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" }, "state": { "javaType": "com.sos.controller.model.common.SyncState", "type": "object", "required": [ "severity", "_text" ], "properties": { "severity": { "type": "integer" }, "_text": { "javaType": "com.sos.controller.model.common.SyncStateText", "type": "string", "enum": [ "IN_SYNC", "NOT_IN_SYNC", "UNKNOWN" ] } } } }, "additionalProperties": false } }, "forkListVariables": { "type": "array", "uniqueItems": true, "items": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 } }, "hasExpectedNoticeBoards": { "type": "boolean" }, "hasPostNoticeBoards": { "type": "boolean" }, "hasConsumeNoticeBoards": { "type": "boolean" }, "hasAddOrderDependencies": { "type": "boolean" }, "numOfStoppedInstructions": { "type": "integer", "minimum": 0 }, "numOfSkippedInstructions": { "type": "integer", "minimum": 0 } }, "additionalProperties": false } } }, "postNoticeBoards": { "javaType": "com.sos.controller.model.workflow.BoardWorkflows", "type": "object", "additionalProperties": { "type": "array", "items": { "javaType": "com.sos.controller.model.workflow.Workflow", "type": "object", "extends": { "javaType": "com.sos.inventory.model.workflow.Workflow", "type": "object", "javaInterfaces": [ "com.sos.joc.model.common.IConfigurationObject", "com.sos.joc.model.common.IDeployObject", "com.sos.inventory.model.common.IInventoryObject" ], "required": [ "instructions" ], "propertyOrder": [ "TYPE", "version", "versionId", "timeZone", "title", "documentationName", "orderPreparation", "jobResourceNames", "instructions", "jobs" ], "description": "deploy object with fixed property 'TYPE':'Workflow'", "properties": { "TYPE": { "javaType": "com.sos.inventory.model.deploy.DeployType", "type": "string", "enum": [ "Workflow", "JobClass", "Lock", "FileWatch", "JobResource", "Board" ], "javaEnumNames": [ "Workflow", "JobClass", "Lock", "FileWatch", "JobResource", "Board" ], "default": "Workflow" }, "version": { "description": "inventory repository version", "type": "string", "pattern": "[0-9]+\\.[0-9]+\\.[0-9]+", "default": "1.5.0", "maxLength": 10 }, "versionId": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "timeZone": { "type": "string", "default": "Etc/UTC" }, "title": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "documentationName": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "orderPreparation": { "javaType": "com.sos.inventory.model.workflow.Requirements", "type": "object", "alias": "orderRequirements", "properties": { "parameters": { "javaType": "com.sos.inventory.model.workflow.Parameters", "type": "object", "additionalProperties": { "javaType": "com.sos.inventory.model.workflow.Parameter", "type": "object", "required": [ "type" ], "properties": { "type": { "javaType": "com.sos.inventory.model.workflow.ParameterType", "type": "string", "enum": [ "String", "Number", "Boolean", "List" ], "javaEnumNames": [ "String", "Number", "Boolean", "List" ] }, "default": { "description": "this value has to have the data type of the 'type' attribute", "anyOf": [{ "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "array" }], "javaType": "java.lang.Object" }, "final": { "type": "string" }, "listParameters": { "javaType": "com.sos.inventory.model.workflow.ListParameters", "type": "object", "description": "parameters only for parameter type 'List'", "additionalProperties": { "javaType": "com.sos.inventory.model.workflow.ListParameter", "type": "object", "required": [ "type" ], "description": "parameter type only Number, Boolean or String", "properties": { "type": { "javaType": "com.sos.inventory.model.workflow.ListParameterType", "type": "string", "enum": [ "String", "Number", "Boolean" ], "javaEnumNames": [ "String", "Number", "Boolean" ] } }, "additionalProperties": false } }, "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 } }, "allowUndeclared": { "type": "boolean", "default": false } }, "additionalProperties": false }, "jobResourceNames": { "alias": "jobResourcePaths", "type": "array", "items": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 } }, "instructions": { "type": "array", "minItems": 1, "items": { "javaType": "com.sos.inventory.model.instruction.Instruction", "type": "object", "required": [ "TYPE" ], "properties": { "TYPE": { "javaType": "com.sos.inventory.model.instruction.InstructionType", "type": "string", "enum": [ "Execute.Named", "If", "Try", "Fork", "ForkList", "Finish", "Fail", "Retry", "Lock", "Prompt", "PostNotice", "PostNotices", "ExpectNotice", "ExpectNotices", "ConsumeNotices", "ImplicitEnd", "AddOrder", "Cycle" ] }, "position": { "description": "Actually, each even item is a string, each odd item is an integer", "type": "array", "items": { "anyOf": [{ "type": "integer" }, { "type": "string" }] } }, "positionString": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "state": { "javaType": "com.sos.inventory.model.instruction.InstructionState", "type": "object", "required": [ "severity", "_text" ], "properties": { "severity": { "type": "integer" }, "_text": { "javaType": "com.sos.inventory.model.instruction.InstructionStateText", "type": "string", "enum": [ "SKIPPED", "STOPPED", "STOPPED_AND_SKIPPED" ] } }, "additionalProperties": false } }, "additionalProperties": false } }, "jobs": { "javaType": "com.sos.inventory.model.workflow.Jobs", "type": "object", "additionalProperties": { "javaType": "com.sos.inventory.model.job.Job", "type": "object", "javaInterfaces": [ "com.sos.joc.model.common.IConfigurationObject" ], "required": [ "agentName", "executable" ], "description": "returnCodeMeaning is deprecated: moved to ShellScriptExecutable", "properties": { "agentName": { "alias": "agentId,agentPath", "type": "string", "pattern": "^[^<>]$", "maxLength": 255, "minLength": 1 }, "subagentClusterId": { "alias": "subagentSelectionId", "type": "string", "pattern": "^[^<>]$", "maxLength": 255, "minLength": 1 }, "subagentClusterIdExpr": { "alias": "subagentSelectionIdExpr", "type": "string", "pattern": "^[^<>]$", "maxLength": 255, "minLength": 1 }, "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", "SpecificDatePeriod" ] }, "duration": { "type": "number", "format": "utc-millisec", "minimum": 0 } }, "additionalProperties": false } } }, "additionalProperties": false }, "skipIfNoAdmissionForOrderDay": { "alias": "skipIfNoAdmissionStartForOrderDay", "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 }, "parallelism": { "alias": "taskLimit", "type": "integer", "minimum": 1, "default": 1 }, "timeout": { "type": "integer", "minimum": 0 }, "graceTimeout": { "alias": "sigkillDelay", "description": "in seconds", "type": "integer", "minimum": 0, "default": 15 }, "failOnErrWritten": { "type": "boolean", "default": false }, "warnOnErrWritten": { "type": "boolean", "default": false }, "jobClassName": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "jobTemplate": { "type": "object", "javaType": "com.sos.inventory.model.job.JobTemplateRef", "properties": { "name": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255, "minLength": 1 }, "hash": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 } }, "additionalProperties": false }, "defaultArguments": { "description": "a map for arbitrary key-value pairs", "javaType": "com.sos.inventory.model.job.Environment", "type": "object", "additionalProperties": { "type": "string" } }, "jobResourceNames": { "alias": "jobResourcePaths", "type": "array", "items": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 } }, "title": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "documentationName": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "criticality": { "javaType": "com.sos.inventory.model.job.JobCriticality", "type": "string", "enum": [ "NORMAL", "CRITICAL" ] }, "warnIfShorter": { "type": "string", "pattern": "^([0-9]+:[0-5][0-9]:[0-5][0-9]\|[0-9]+s?\|[0-9]+%)$" }, "warnIfLonger": { "type": "string", "pattern": "^([0-9]+:[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 } } }, "additionalProperties": false }, "properties": { "path": { "description": "absolute path of an object.", "type": "string", "pattern": "^(/\|(/[^/\\\\<>?:\"\|]+)+)$", "maxLength": 255, "minLength": 1 }, "isCurrentVersion": { "type": "boolean", "default": true }, "versionDate": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" }, "state": { "javaType": "com.sos.controller.model.common.SyncState", "type": "object", "required": [ "severity", "_text" ], "properties": { "severity": { "type": "integer" }, "_text": { "javaType": "com.sos.controller.model.common.SyncStateText", "description": "SUSPENDED, OUTSTANDING only for Workflows", "type": "string", "enum": [ "IN_SYNC", "NOT_IN_SYNC", "NOT_DEPLOYED", "SUSPENDED", "OUTSTANDING", "UNKNOWN" ] } } }, "suspended": { "description": "true if state._text == SUSPENDED or SUSPENDING", "type": "boolean", "default": false }, "fileOrderSources": { "type": "array", "items": { "javaType": "com.sos.controller.model.fileordersource.FileOrderSource", "type": "object", "extends": { "javaType": "com.sos.inventory.model.fileordersource.FileOrderSource", "type": "object", "javaInterfaces": [ "com.sos.joc.model.common.IConfigurationObject", "com.sos.joc.model.common.IDeployObject", "com.sos.inventory.model.common.IInventoryObject" ], "required": [ "workflowName", "agentName", "directory" ], "propertyOrder": [ "TYPE", "version", "workflowName", "agentName", "directory", "pattern", "timeZone", "delay", "title", "documentationName" ], "description": "deploy object with fixed property 'TYPE':'FileWatch'", "properties": { "TYPE": { "javaType": "com.sos.inventory.model.deploy.DeployType", "type": "string", "enum": [ "Workflow", "JobClass", "Lock", "FileWatch", "JobResource", "Board" ], "javaEnumNames": [ "Workflow", "JobClass", "Lock", "FileWatch", "JobResource", "Board" ], "default": "Workflow" }, "version": { "description": "inventory repository version", "type": "string", "pattern": "[0-9]+\\.[0-9]+\\.[0-9]+", "default": "1.0.0", "maxLength": 10 }, "workflowName": { "alias": "workflowPath", "type": "string", "pattern": "^[^<>]$", "maxLength": 255, "minLength": 1 }, "agentName": { "alias": "agentId,agentPath", "type": "string", "pattern": "^[^<>]$", "maxLength": 255, "minLength": 1 }, "directory": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255, "minLength": 1 }, "pattern": { "type": "string" }, "timeZone": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "delay": { "type": "integer", "format": "utc-millisec", "minimum": 1, "maximum": 9999 }, "title": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "documentationName": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 } }, "additionalProperties": false }, "properties": { "path": { "description": "absolute path of an object.", "type": "string", "pattern": "^(/\|(/[^/\\\\<>?:\"\|]+)+)$", "maxLength": 255, "minLength": 1 }, "versionDate": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" }, "state": { "javaType": "com.sos.controller.model.common.SyncState", "type": "object", "required": [ "severity", "_text" ], "properties": { "severity": { "type": "integer" }, "_text": { "javaType": "com.sos.controller.model.common.SyncStateText", "type": "string", "enum": [ "IN_SYNC", "NOT_IN_SYNC", "UNKNOWN" ] } } } }, "additionalProperties": false } }, "forkListVariables": { "type": "array", "uniqueItems": true, "items": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 } }, "hasExpectedNoticeBoards": { "type": "boolean" }, "hasPostNoticeBoards": { "type": "boolean" }, "hasConsumeNoticeBoards": { "type": "boolean" }, "hasAddOrderDependencies": { "type": "boolean" }, "numOfStoppedInstructions": { "type": "integer", "minimum": 0 }, "numOfSkippedInstructions": { "type": "integer", "minimum": 0 } }, "additionalProperties": false } } }, "addOrderToWorkflows": { "type": "array", "items": { "javaType": "com.sos.controller.model.workflow.Workflow", "type": "object", "extends": { "javaType": "com.sos.inventory.model.workflow.Workflow", "type": "object", "javaInterfaces": [ "com.sos.joc.model.common.IConfigurationObject", "com.sos.joc.model.common.IDeployObject", "com.sos.inventory.model.common.IInventoryObject" ], "required": [ "instructions" ], "propertyOrder": [ "TYPE", "version", "versionId", "timeZone", "title", "documentationName", "orderPreparation", "jobResourceNames", "instructions", "jobs" ], "description": "deploy object with fixed property 'TYPE':'Workflow'", "properties": { "TYPE": { "javaType": "com.sos.inventory.model.deploy.DeployType", "type": "string", "enum": [ "Workflow", "JobClass", "Lock", "FileWatch", "JobResource", "Board" ], "javaEnumNames": [ "Workflow", "JobClass", "Lock", "FileWatch", "JobResource", "Board" ], "default": "Workflow" }, "version": { "description": "inventory repository version", "type": "string", "pattern": "[0-9]+\\.[0-9]+\\.[0-9]+", "default": "1.5.0", "maxLength": 10 }, "versionId": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "timeZone": { "type": "string", "default": "Etc/UTC" }, "title": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "documentationName": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "orderPreparation": { "javaType": "com.sos.inventory.model.workflow.Requirements", "type": "object", "alias": "orderRequirements", "properties": { "parameters": { "javaType": "com.sos.inventory.model.workflow.Parameters", "type": "object", "additionalProperties": { "javaType": "com.sos.inventory.model.workflow.Parameter", "type": "object", "required": [ "type" ], "properties": { "type": { "javaType": "com.sos.inventory.model.workflow.ParameterType", "type": "string", "enum": [ "String", "Number", "Boolean", "List" ], "javaEnumNames": [ "String", "Number", "Boolean", "List" ] }, "default": { "description": "this value has to have the data type of the 'type' attribute", "anyOf": [{ "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "array" }], "javaType": "java.lang.Object" }, "final": { "type": "string" }, "listParameters": { "javaType": "com.sos.inventory.model.workflow.ListParameters", "type": "object", "description": "parameters only for parameter type 'List'", "additionalProperties": { "javaType": "com.sos.inventory.model.workflow.ListParameter", "type": "object", "required": [ "type" ], "description": "parameter type only Number, Boolean or String", "properties": { "type": { "javaType": "com.sos.inventory.model.workflow.ListParameterType", "type": "string", "enum": [ "String", "Number", "Boolean" ], "javaEnumNames": [ "String", "Number", "Boolean" ] } }, "additionalProperties": false } }, "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 } }, "allowUndeclared": { "type": "boolean", "default": false } }, "additionalProperties": false }, "jobResourceNames": { "alias": "jobResourcePaths", "type": "array", "items": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 } }, "instructions": { "type": "array", "minItems": 1, "items": { "javaType": "com.sos.inventory.model.instruction.Instruction", "type": "object", "required": [ "TYPE" ], "properties": { "TYPE": { "javaType": "com.sos.inventory.model.instruction.InstructionType", "type": "string", "enum": [ "Execute.Named", "If", "Try", "Fork", "ForkList", "Finish", "Fail", "Retry", "Lock", "Prompt", "PostNotice", "PostNotices", "ExpectNotice", "ExpectNotices", "ConsumeNotices", "ImplicitEnd", "AddOrder", "Cycle" ] }, "position": { "description": "Actually, each even item is a string, each odd item is an integer", "type": "array", "items": { "anyOf": [{ "type": "integer" }, { "type": "string" }] } }, "positionString": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "state": { "javaType": "com.sos.inventory.model.instruction.InstructionState", "type": "object", "required": [ "severity", "_text" ], "properties": { "severity": { "type": "integer" }, "_text": { "javaType": "com.sos.inventory.model.instruction.InstructionStateText", "type": "string", "enum": [ "SKIPPED", "STOPPED", "STOPPED_AND_SKIPPED" ] } }, "additionalProperties": false } }, "additionalProperties": false } }, "jobs": { "javaType": "com.sos.inventory.model.workflow.Jobs", "type": "object", "additionalProperties": { "javaType": "com.sos.inventory.model.job.Job", "type": "object", "javaInterfaces": [ "com.sos.joc.model.common.IConfigurationObject" ], "required": [ "agentName", "executable" ], "description": "returnCodeMeaning is deprecated: moved to ShellScriptExecutable", "properties": { "agentName": { "alias": "agentId,agentPath", "type": "string", "pattern": "^[^<>]$", "maxLength": 255, "minLength": 1 }, "subagentClusterId": { "alias": "subagentSelectionId", "type": "string", "pattern": "^[^<>]$", "maxLength": 255, "minLength": 1 }, "subagentClusterIdExpr": { "alias": "subagentSelectionIdExpr", "type": "string", "pattern": "^[^<>]$", "maxLength": 255, "minLength": 1 }, "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", "SpecificDatePeriod" ] }, "duration": { "type": "number", "format": "utc-millisec", "minimum": 0 } }, "additionalProperties": false } } }, "additionalProperties": false }, "skipIfNoAdmissionForOrderDay": { "alias": "skipIfNoAdmissionStartForOrderDay", "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 }, "parallelism": { "alias": "taskLimit", "type": "integer", "minimum": 1, "default": 1 }, "timeout": { "type": "integer", "minimum": 0 }, "graceTimeout": { "alias": "sigkillDelay", "description": "in seconds", "type": "integer", "minimum": 0, "default": 15 }, "failOnErrWritten": { "type": "boolean", "default": false }, "warnOnErrWritten": { "type": "boolean", "default": false }, "jobClassName": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "jobTemplate": { "type": "object", "javaType": "com.sos.inventory.model.job.JobTemplateRef", "properties": { "name": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255, "minLength": 1 }, "hash": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 } }, "additionalProperties": false }, "defaultArguments": { "description": "a map for arbitrary key-value pairs", "javaType": "com.sos.inventory.model.job.Environment", "type": "object", "additionalProperties": { "type": "string" } }, "jobResourceNames": { "alias": "jobResourcePaths", "type": "array", "items": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 } }, "title": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "documentationName": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "criticality": { "javaType": "com.sos.inventory.model.job.JobCriticality", "type": "string", "enum": [ "NORMAL", "CRITICAL" ] }, "warnIfShorter": { "type": "string", "pattern": "^([0-9]+:[0-5][0-9]:[0-5][0-9]\|[0-9]+s?\|[0-9]+%)$" }, "warnIfLonger": { "type": "string", "pattern": "^([0-9]+:[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 } } }, "additionalProperties": false }, "properties": { "path": { "description": "absolute path of an object.", "type": "string", "pattern": "^(/\|(/[^/\\\\<>?:\"\|]+)+)$", "maxLength": 255, "minLength": 1 }, "isCurrentVersion": { "type": "boolean", "default": true }, "versionDate": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" }, "state": { "javaType": "com.sos.controller.model.common.SyncState", "type": "object", "required": [ "severity", "_text" ], "properties": { "severity": { "type": "integer" }, "_text": { "javaType": "com.sos.controller.model.common.SyncStateText", "description": "SUSPENDED, OUTSTANDING only for Workflows", "type": "string", "enum": [ "IN_SYNC", "NOT_IN_SYNC", "NOT_DEPLOYED", "SUSPENDED", "OUTSTANDING", "UNKNOWN" ] } } }, "suspended": { "description": "true if state._text == SUSPENDED or SUSPENDING", "type": "boolean", "default": false }, "fileOrderSources": { "type": "array", "items": { "javaType": "com.sos.controller.model.fileordersource.FileOrderSource", "type": "object", "extends": { "javaType": "com.sos.inventory.model.fileordersource.FileOrderSource", "type": "object", "javaInterfaces": [ "com.sos.joc.model.common.IConfigurationObject", "com.sos.joc.model.common.IDeployObject", "com.sos.inventory.model.common.IInventoryObject" ], "required": [ "workflowName", "agentName", "directory" ], "propertyOrder": [ "TYPE", "version", "workflowName", "agentName", "directory", "pattern", "timeZone", "delay", "title", "documentationName" ], "description": "deploy object with fixed property 'TYPE':'FileWatch'", "properties": { "TYPE": { "javaType": "com.sos.inventory.model.deploy.DeployType", "type": "string", "enum": [ "Workflow", "JobClass", "Lock", "FileWatch", "JobResource", "Board" ], "javaEnumNames": [ "Workflow", "JobClass", "Lock", "FileWatch", "JobResource", "Board" ], "default": "Workflow" }, "version": { "description": "inventory repository version", "type": "string", "pattern": "[0-9]+\\.[0-9]+\\.[0-9]+", "default": "1.0.0", "maxLength": 10 }, "workflowName": { "alias": "workflowPath", "type": "string", "pattern": "^[^<>]$", "maxLength": 255, "minLength": 1 }, "agentName": { "alias": "agentId,agentPath", "type": "string", "pattern": "^[^<>]$", "maxLength": 255, "minLength": 1 }, "directory": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255, "minLength": 1 }, "pattern": { "type": "string" }, "timeZone": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "delay": { "type": "integer", "format": "utc-millisec", "minimum": 1, "maximum": 9999 }, "title": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "documentationName": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 } }, "additionalProperties": false }, "properties": { "path": { "description": "absolute path of an object.", "type": "string", "pattern": "^(/\|(/[^/\\\\<>?:\"\|]+)+)$", "maxLength": 255, "minLength": 1 }, "versionDate": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" }, "state": { "javaType": "com.sos.controller.model.common.SyncState", "type": "object", "required": [ "severity", "_text" ], "properties": { "severity": { "type": "integer" }, "_text": { "javaType": "com.sos.controller.model.common.SyncStateText", "type": "string", "enum": [ "IN_SYNC", "NOT_IN_SYNC", "UNKNOWN" ] } } } }, "additionalProperties": false } }, "forkListVariables": { "type": "array", "uniqueItems": true, "items": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 } }, "hasExpectedNoticeBoards": { "type": "boolean" }, "hasPostNoticeBoards": { "type": "boolean" }, "hasConsumeNoticeBoards": { "type": "boolean" }, "hasAddOrderDependencies": { "type": "boolean" }, "numOfStoppedInstructions": { "type": "integer", "minimum": 0 }, "numOfSkippedInstructions": { "type": "integer", "minimum": 0 } }, "additionalProperties": false } }, "addOrderFromWorkflows": { "type": "array", "items": { "javaType": "com.sos.controller.model.workflow.Workflow", "type": "object", "extends": { "javaType": "com.sos.inventory.model.workflow.Workflow", "type": "object", "javaInterfaces": [ "com.sos.joc.model.common.IConfigurationObject", "com.sos.joc.model.common.IDeployObject", "com.sos.inventory.model.common.IInventoryObject" ], "required": [ "instructions" ], "propertyOrder": [ "TYPE", "version", "versionId", "timeZone", "title", "documentationName", "orderPreparation", "jobResourceNames", "instructions", "jobs" ], "description": "deploy object with fixed property 'TYPE':'Workflow'", "properties": { "TYPE": { "javaType": "com.sos.inventory.model.deploy.DeployType", "type": "string", "enum": [ "Workflow", "JobClass", "Lock", "FileWatch", "JobResource", "Board" ], "javaEnumNames": [ "Workflow", "JobClass", "Lock", "FileWatch", "JobResource", "Board" ], "default": "Workflow" }, "version": { "description": "inventory repository version", "type": "string", "pattern": "[0-9]+\\.[0-9]+\\.[0-9]+", "default": "1.5.0", "maxLength": 10 }, "versionId": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "timeZone": { "type": "string", "default": "Etc/UTC" }, "title": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "documentationName": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "orderPreparation": { "javaType": "com.sos.inventory.model.workflow.Requirements", "type": "object", "alias": "orderRequirements", "properties": { "parameters": { "javaType": "com.sos.inventory.model.workflow.Parameters", "type": "object", "additionalProperties": { "javaType": "com.sos.inventory.model.workflow.Parameter", "type": "object", "required": [ "type" ], "properties": { "type": { "javaType": "com.sos.inventory.model.workflow.ParameterType", "type": "string", "enum": [ "String", "Number", "Boolean", "List" ], "javaEnumNames": [ "String", "Number", "Boolean", "List" ] }, "default": { "description": "this value has to have the data type of the 'type' attribute", "anyOf": [{ "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "array" }], "javaType": "java.lang.Object" }, "final": { "type": "string" }, "listParameters": { "javaType": "com.sos.inventory.model.workflow.ListParameters", "type": "object", "description": "parameters only for parameter type 'List'", "additionalProperties": { "javaType": "com.sos.inventory.model.workflow.ListParameter", "type": "object", "required": [ "type" ], "description": "parameter type only Number, Boolean or String", "properties": { "type": { "javaType": "com.sos.inventory.model.workflow.ListParameterType", "type": "string", "enum": [ "String", "Number", "Boolean" ], "javaEnumNames": [ "String", "Number", "Boolean" ] } }, "additionalProperties": false } }, "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 } }, "allowUndeclared": { "type": "boolean", "default": false } }, "additionalProperties": false }, "jobResourceNames": { "alias": "jobResourcePaths", "type": "array", "items": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 } }, "instructions": { "type": "array", "minItems": 1, "items": { "javaType": "com.sos.inventory.model.instruction.Instruction", "type": "object", "required": [ "TYPE" ], "properties": { "TYPE": { "javaType": "com.sos.inventory.model.instruction.InstructionType", "type": "string", "enum": [ "Execute.Named", "If", "Try", "Fork", "ForkList", "Finish", "Fail", "Retry", "Lock", "Prompt", "PostNotice", "PostNotices", "ExpectNotice", "ExpectNotices", "ConsumeNotices", "ImplicitEnd", "AddOrder", "Cycle" ] }, "position": { "description": "Actually, each even item is a string, each odd item is an integer", "type": "array", "items": { "anyOf": [{ "type": "integer" }, { "type": "string" }] } }, "positionString": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "state": { "javaType": "com.sos.inventory.model.instruction.InstructionState", "type": "object", "required": [ "severity", "_text" ], "properties": { "severity": { "type": "integer" }, "_text": { "javaType": "com.sos.inventory.model.instruction.InstructionStateText", "type": "string", "enum": [ "SKIPPED", "STOPPED", "STOPPED_AND_SKIPPED" ] } }, "additionalProperties": false } }, "additionalProperties": false } }, "jobs": { "javaType": "com.sos.inventory.model.workflow.Jobs", "type": "object", "additionalProperties": { "javaType": "com.sos.inventory.model.job.Job", "type": "object", "javaInterfaces": [ "com.sos.joc.model.common.IConfigurationObject" ], "required": [ "agentName", "executable" ], "description": "returnCodeMeaning is deprecated: moved to ShellScriptExecutable", "properties": { "agentName": { "alias": "agentId,agentPath", "type": "string", "pattern": "^[^<>]$", "maxLength": 255, "minLength": 1 }, "subagentClusterId": { "alias": "subagentSelectionId", "type": "string", "pattern": "^[^<>]$", "maxLength": 255, "minLength": 1 }, "subagentClusterIdExpr": { "alias": "subagentSelectionIdExpr", "type": "string", "pattern": "^[^<>]$", "maxLength": 255, "minLength": 1 }, "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", "SpecificDatePeriod" ] }, "duration": { "type": "number", "format": "utc-millisec", "minimum": 0 } }, "additionalProperties": false } } }, "additionalProperties": false }, "skipIfNoAdmissionForOrderDay": { "alias": "skipIfNoAdmissionStartForOrderDay", "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 }, "parallelism": { "alias": "taskLimit", "type": "integer", "minimum": 1, "default": 1 }, "timeout": { "type": "integer", "minimum": 0 }, "graceTimeout": { "alias": "sigkillDelay", "description": "in seconds", "type": "integer", "minimum": 0, "default": 15 }, "failOnErrWritten": { "type": "boolean", "default": false }, "warnOnErrWritten": { "type": "boolean", "default": false }, "jobClassName": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "jobTemplate": { "type": "object", "javaType": "com.sos.inventory.model.job.JobTemplateRef", "properties": { "name": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255, "minLength": 1 }, "hash": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 } }, "additionalProperties": false }, "defaultArguments": { "description": "a map for arbitrary key-value pairs", "javaType": "com.sos.inventory.model.job.Environment", "type": "object", "additionalProperties": { "type": "string" } }, "jobResourceNames": { "alias": "jobResourcePaths", "type": "array", "items": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 } }, "title": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "documentationName": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "criticality": { "javaType": "com.sos.inventory.model.job.JobCriticality", "type": "string", "enum": [ "NORMAL", "CRITICAL" ] }, "warnIfShorter": { "type": "string", "pattern": "^([0-9]+:[0-5][0-9]:[0-5][0-9]\|[0-9]+s?\|[0-9]+%)$" }, "warnIfLonger": { "type": "string", "pattern": "^([0-9]+:[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 } } }, "additionalProperties": false }, "properties": { "path": { "description": "absolute path of an object.", "type": "string", "pattern": "^(/\|(/[^/\\\\<>?:\"\|]+)+)$", "maxLength": 255, "minLength": 1 }, "isCurrentVersion": { "type": "boolean", "default": true }, "versionDate": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" }, "state": { "javaType": "com.sos.controller.model.common.SyncState", "type": "object", "required": [ "severity", "_text" ], "properties": { "severity": { "type": "integer" }, "_text": { "javaType": "com.sos.controller.model.common.SyncStateText", "description": "SUSPENDED, OUTSTANDING only for Workflows", "type": "string", "enum": [ "IN_SYNC", "NOT_IN_SYNC", "NOT_DEPLOYED", "SUSPENDED", "OUTSTANDING", "UNKNOWN" ] } } }, "suspended": { "description": "true if state._text == SUSPENDED or SUSPENDING", "type": "boolean", "default": false }, "fileOrderSources": { "type": "array", "items": { "javaType": "com.sos.controller.model.fileordersource.FileOrderSource", "type": "object", "extends": { "javaType": "com.sos.inventory.model.fileordersource.FileOrderSource", "type": "object", "javaInterfaces": [ "com.sos.joc.model.common.IConfigurationObject", "com.sos.joc.model.common.IDeployObject", "com.sos.inventory.model.common.IInventoryObject" ], "required": [ "workflowName", "agentName", "directory" ], "propertyOrder": [ "TYPE", "version", "workflowName", "agentName", "directory", "pattern", "timeZone", "delay", "title", "documentationName" ], "description": "deploy object with fixed property 'TYPE':'FileWatch'", "properties": { "TYPE": { "javaType": "com.sos.inventory.model.deploy.DeployType", "type": "string", "enum": [ "Workflow", "JobClass", "Lock", "FileWatch", "JobResource", "Board" ], "javaEnumNames": [ "Workflow", "JobClass", "Lock", "FileWatch", "JobResource", "Board" ], "default": "Workflow" }, "version": { "description": "inventory repository version", "type": "string", "pattern": "[0-9]+\\.[0-9]+\\.[0-9]+", "default": "1.0.0", "maxLength": 10 }, "workflowName": { "alias": "workflowPath", "type": "string", "pattern": "^[^<>]$", "maxLength": 255, "minLength": 1 }, "agentName": { "alias": "agentId,agentPath", "type": "string", "pattern": "^[^<>]$", "maxLength": 255, "minLength": 1 }, "directory": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255, "minLength": 1 }, "pattern": { "type": "string" }, "timeZone": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "delay": { "type": "integer", "format": "utc-millisec", "minimum": 1, "maximum": 9999 }, "title": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "documentationName": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 } }, "additionalProperties": false }, "properties": { "path": { "description": "absolute path of an object.", "type": "string", "pattern": "^(/\|(/[^/\\\\<>?:\"\|]+)+)$", "maxLength": 255, "minLength": 1 }, "versionDate": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" }, "state": { "javaType": "com.sos.controller.model.common.SyncState", "type": "object", "required": [ "severity", "_text" ], "properties": { "severity": { "type": "integer" }, "_text": { "javaType": "com.sos.controller.model.common.SyncStateText", "type": "string", "enum": [ "IN_SYNC", "NOT_IN_SYNC", "UNKNOWN" ] } } } }, "additionalProperties": false } }, "forkListVariables": { "type": "array", "uniqueItems": true, "items": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 } }, "hasExpectedNoticeBoards": { "type": "boolean" }, "hasPostNoticeBoards": { "type": "boolean" }, "hasConsumeNoticeBoards": { "type": "boolean" }, "hasAddOrderDependencies": { "type": "boolean" }, "numOfStoppedInstructions": { "type": "integer", "minimum": 0 }, "numOfSkippedInstructions": { "type": "integer", "minimum": 0 } }, "additionalProperties": false } } }, "additionalProperties": false } }, "additionalProperties": false } { "deliveryDate": "2021-08-17T14:27:16.963+0000", "surveyDate": "2021-08-17T14:27:43.623+0000", "workflow": { "expectedNoticeBoards": { "b2": [{ "path": "/oh/w2", "isCurrentVersion": true, "versionDate": "2021-08-17T14:22:42.000+0000", "state": { "severity": 6, "_text": "IN_SYNC" }, "hasExpectedNoticeBoards": false, "TYPE": "Workflow", "version": "1.0.0", "versionId": "7f366d4a-d3cd-4fb5-b65e-b4bdd01b1092", "orderPreparation": { "parameters": { "exitcode": { "type": "Number", "default": "0" } }, "allowUndeclared": false }, "instructions": [{ "TYPE": "Execute.Named", "jobName": "job1", "label": "job1", "position": [ 0 ], "positionString": "0" }, { "TYPE": "Execute.Named", "jobName": "job2", "label": "job2", "defaultArguments": { "bool": "true", "number": "42", "string": "'hallo'" }, "position": [ 1 ], "positionString": "1" }, { "TYPE": "PostNotice", "noticeBoardName": "b2", "position": [ 2 ], "positionString": "2" }, { "TYPE": "ImplicitEnd", "position": [ 3 ], "positionString": "3" }], "title": "postNotice", "jobs": { "job1": { "agentName": "standaloneAgent", "executable": { "TYPE": "ShellScriptExecutable", "script": "ls -l\nexit 1", "v1Compatible": false }, "parallelism": 1, "graceTimeout": 15, "failOnErrWritten": false }, "job2": { "agentName": "standaloneAgent", "executable": { "TYPE": "ShellScriptExecutable", "script": "ls -l\nexit 1", "v1Compatible": false }, "parallelism": 1, "graceTimeout": 15, "failOnErrWritten": false } } }] }, "TYPE": "Workflow", "version": "1.0.0", "versionId": "94bdb3dc-1f97-4f5b-9393-02d601ecee2d", "orderPreparation": { "parameters": { "exitcode": { "type": "Number", "default": "0" }, "myFinal": { "final": "'hello'" }, "reqVar": { "type": "String", "default": "\"world\"" } }, "allowUndeclared": false }, "instructions": [{ "TYPE": "ExpectNotice", "noticeBoardName": "b2", "position": [ 0 ], "positionString": "0" }, { "TYPE": "Execute.Named", "jobName": "job1", "label": "job1", "defaultArguments": { "bool": "true", "number": "42", "string": "'hallo'" }, "position": [ 1 ], "positionString": "1" }, { "TYPE": "Execute.Named", "jobName": "job2", "label": "job2", "position": [ 2 ], "positionString": "2" }, { "TYPE": "ImplicitEnd", "position": [ 3 ], "positionString": "3" }], "jobs": { "job1": { "agentName": "standaloneAgent", "executable": { "TYPE": "ShellScriptExecutable", "script": "#!/bin/bash\n#for ((i=1; i<=100; i++)); do\n# echo \"log output for line $i\"\n# sleep 1\n#done\nx=1\nwhile [ $x -le 100 ]\ndo\n echo \"Welcome $x times\"\n sleep 1\n x=$(( $x + 1 ))\ndone", "v1Compatible": false }, "parallelism": 1, "timeout": 200, "graceTimeout": 10, "failOnErrWritten": false, "documentationName": "test-doc" }, "job2": { "agentName": "standalone-agent", "executable": { "TYPE": "ShellScriptExecutable", "script": "ls -l", "v1Compatible": false }, "parallelism": 1, "graceTimeout": 15, "failOnErrWritten": false } }, "path": "/oh/w1", "isCurrentVersion": true, "versionDate": "2021-08-17T14:27:44.000+0000", "state": { "severity": 6, "_text": "IN_SYNC" } } } { "deliveryDate": "2021-08-17T14:27:16.963+0000", "surveyDate": "2021-08-17T14:27:43.623+0000", "workflow": { "expectedNoticeBoards": { "b2": [{ "path": "/oh/w2", "isCurrentVersion": true, "versionDate": "2021-08-17T14:22:42.000+0000", "state": { "severity": 6, "_text": "IN_SYNC" }, "hasExpectedNoticeBoards": false, "TYPE": "Workflow", "version": "1.0.0", "versionId": "7f366d4a-d3cd-4fb5-b65e-b4bdd01b1092", "orderPreparation": { "parameters": { "exitcode": { "type": "Number", "default": "0" } }, "allowUndeclared": false }, "instructions": [{ "TYPE": "Execute.Named", "jobName": "job1", "label": "job1", "position": [ 0 ], "positionString": "0" }, { "TYPE": "Execute.Named", "jobName": "job2", "label": "job2", "defaultArguments": { "bool": "true", "number": "42", "string": "'hallo'" }, "position": [ 1 ], "positionString": "1" }, { "TYPE": "PostNotice", "noticeBoardName": "b2", "position": [ 2 ], "positionString": "2" }, { "TYPE": "ImplicitEnd", "position": [ 3 ], "positionString": "3" }], "title": "postNotice", "jobs": { "job1": { "agentName": "standaloneAgent", "executable": { "TYPE": "ShellScriptExecutable", "script": "ls -l\nexit 1", "v1Compatible": false }, "parallelism": 1, "graceTimeout": 15, "failOnErrWritten": false }, "job2": { "agentName": "standaloneAgent", "executable": { "TYPE": "ShellScriptExecutable", "script": "ls -l\nexit 1", "v1Compatible": false }, "parallelism": 1, "graceTimeout": 15, "failOnErrWritten": false } } }] }, "TYPE": "Workflow", "version": "1.0.0", "versionId": "94bdb3dc-1f97-4f5b-9393-02d601ecee2d", "orderPreparation": { "parameters": { "exitcode": { "type": "Number", "default": "0" }, "myFinal": { "final": "'hello'" }, "reqVar": { "type": "String", "default": "\"world\"" } }, "allowUndeclared": false }, "instructions": [{ "TYPE": "ExpectNotice", "noticeBoardName": "b2", "position": [ 0 ], "positionString": "0" }, { "TYPE": "Execute.Named", "jobName": "job1", "label": "job1", "defaultArguments": { "bool": "true", "number": "42", "string": "'hallo'" }, "position": [ 1 ], "positionString": "1" }, { "TYPE": "Execute.Named", "jobName": "job2", "label": "job2", "position": [ 2 ], "positionString": "2" }, { "TYPE": "ImplicitEnd", "position": [ 3 ], "positionString": "3" }], "jobs": { "job1": { "agentName": "standaloneAgent", "executable": { "TYPE": "ShellScriptExecutable", "script": "#!/bin/bash\n#for ((i=1; i<=100; i++)); do\n# echo \"log output for line $i\"\n# sleep 1\n#done\nx=1\nwhile [ $x -le 100 ]\ndo\n echo \"Welcome $x times\"\n sleep 1\n x=$(( $x + 1 ))\ndone", "v1Compatible": false }, "parallelism": 1, "timeout": 200, "graceTimeout": 10, "failOnErrWritten": false, "documentationName": "test-doc" }, "job2": { "agentName": "standalone-agent", "executable": { "TYPE": "ShellScriptExecutable", "script": "ls -l", "v1Compatible": false }, "parallelism": 1, "graceTimeout": 15, "failOnErrWritten": false } }, "path": "/oh/w1", "isCurrentVersion": true, "versionDate": "2021-08-17T14:27:44.000+0000", "state": { "severity": 6, "_text": "IN_SYNC" } } }
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 'dependencies'	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	'dependencies' 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": "dependencies failed!" } } { "deliveryDate": "2016-05-05T21:13:35Z", "surveyDate": "2016-05-05T21:13:33Z", "error": { "code": "JOC-420", "message": "dependencies 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 }