JOC API

/inventory/workflow/references

POST

Gets references

Parameters in the POST body schema

Name	Type	Description	Example	Default
`path`	required, string	Path or name of the workflow
`objectTypes`	optional, array	A workflows can be referenced by fileOrderSources, schedules and in the addOrder instruction of other workflows so that possible object types are "WORKFLOW" "FILEORDERSOURCE" "SCHEDULE"	["FILEORDERSOURCE"]

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": "filter for references",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "javaType": "com.sos.joc.model.inventory.references.RequestFilter",
    "type": "object",
    "required": [
        "path"
    ],
    "properties": {
        "path": {
            "type": "string",
            "pattern": "^[^<>]*$",
            "maxLength": 255,
            "minLength": 1
        },
        "objectTypes": {
            "type": "array",
            "items": {
                "javaType": "com.sos.joc.model.inventory.common.ConfigurationType",
                "type": "string",
                "enum": [
                    "FOLDER",
                    "WORKFLOW",
                    "JOBCLASS",
                    "JOBRESOURCE",
                    "LOCK",
                    "NOTICEBOARD",
                    "FILEORDERSOURCE",
                    "WORKINGDAYSCALENDAR",
                    "NONWORKINGDAYSCALENDAR",
                    "SCHEDULE",
                    "INCLUDESCRIPT",
                    "JOBTEMPLATE",
                    "DEPLOYMENTDESCRIPTOR",
                    "DESCRIPTORFOLDER"
                ]
            }
        }
    },
    "additionalProperties": false
}

Responses

Code	Description	Body
200		application/json model \| example { "title": "references", "$schema": "http://json-schema.org/draft-04/schema#", "javaType": "com.sos.joc.model.inventory.references.ResponseItems", "type": "object", "required": [ "deliveryDate" ], "properties": { "deliveryDate": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" }, "workflows": { "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 }, "withSubagentClusterIdExpr": { "type": "boolean", "default": false }, "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", "extends": { "javaType": "com.sos.inventory.model.job.JobReturnCodeWarning", "type": "object", "properties": { "warning": { "oneOf": [{ "type": "array", "minItems": 1, "items": { "type": "integer" } }, { "type": "string", "pattern": "^-?[0-9]+(\\.\\.-?[0-9]+)?(, -?[0-9]+(\\.\\.-?[0-9]+)?)$" }] } }, "additionalProperties": false }, "anyOf": [{ "required": [ "success" ] }, { "required": [ "failure" ] }, { "required": [ "warning" ] }], "properties": { "success": { "oneOf": [{ "type": "array", "minItems": 1, "items": { "type": "integer" } }, { "type": "string", "pattern": "^-?[0-9]+(\\.\\.-?[0-9]+)?(, -?[0-9]+(\\.\\.-?[0-9]+)?)$" }] }, "failure": { "oneOf": [{ "type": "array", "minItems": 1, "items": { "type": "integer" } }, { "type": "string", "pattern": "^-?[0-9]+(\\.\\.-?[0-9]+)?(, -?[0-9]+(\\.\\.-?[0-9]+)?)$" }] } }, "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 }, "returnCodeMeaning": { "javaType": "com.sos.inventory.model.job.JobReturnCodeWarning", "type": "object", "properties": { "warning": { "oneOf": [{ "type": "array", "minItems": 1, "items": { "type": "integer" } }, { "type": "string", "pattern": "^-?[0-9]+(\\.\\.-?[0-9]+)?(, -?[0-9]+(\\.\\.-?[0-9]+)?)$" }] } }, "additionalProperties": false }, "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", "extends": { "javaType": "com.sos.inventory.model.job.JobReturnCodeWarning", "type": "object", "properties": { "warning": { "oneOf": [{ "type": "array", "minItems": 1, "items": { "type": "integer" } }, { "type": "string", "pattern": "^-?[0-9]+(\\.\\.-?[0-9]+)?(, -?[0-9]+(\\.\\.-?[0-9]+)?)$" }] } }, "additionalProperties": false }, "anyOf": [{ "required": [ "success" ] }, { "required": [ "failure" ] }, { "required": [ "warning" ] }], "properties": { "success": { "oneOf": [{ "type": "array", "minItems": 1, "items": { "type": "integer" } }, { "type": "string", "pattern": "^-?[0-9]+(\\.\\.-?[0-9]+)?(, -?[0-9]+(\\.\\.-?[0-9]+)?)$" }] }, "failure": { "oneOf": [{ "type": "array", "minItems": 1, "items": { "type": "integer" } }, { "type": "string", "pattern": "^-?[0-9]+(\\.\\.-?[0-9]+)?(, -?[0-9]+(\\.\\.-?[0-9]+)?)$" }] } }, "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 } }, "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 } }, "schedules": { "type": "array", "items": { "javaType": "com.sos.inventory.model.schedule.Schedule", "type": "object", "description": "The order template for scheduling orders to Controller. workflowName is deprecated", "javaInterfaces": [ "com.sos.joc.model.common.IConfigurationObject", "com.sos.joc.model.common.IReleaseObject", "com.sos.inventory.model.common.IInventoryObject" ], "anyOf": [{ "required": [ "workflowName", "calendars" ] }, { "required": [ "workflowNames", "calendars" ] }], "properties": { "version": { "description": "inventory repository version", "type": "string", "pattern": "[0-9]+\\.[0-9]+\\.[0-9]+", "default": "1.5.0", "maxLength": 10 }, "path": { "description": "absolute path of an object.", "type": "string", "pattern": "^(/\|(/[^/\\<>?:\"\|]+)+)$", "maxLength": 255, "minLength": 1 }, "workflowName": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "workflowNames": { "type": "array", "minItems": 1, "items": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 } }, "title": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "documentationName": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "submitOrderToControllerWhenPlanned": { "type": "boolean", "default": false }, "planOrderAutomatically": { "type": "boolean", "default": false }, "calendars": { "type": "array", "minItems": 1, "items": { "javaType": "com.sos.inventory.model.calendar.AssignedCalendars", "type": "object", "required": [ "calendarName", "periods" ], "properties": { "calendarName": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "calendarPath": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "timeZone": { "type": "string", "default": "Etc/UTC" }, "includes": { "javaType": "com.sos.inventory.model.calendar.Frequencies", "type": "object", "anyOf": [{ "required": [ "dates" ] }, { "required": [ "weekdays" ] }, { "required": [ "monthdays" ] }, { "required": [ "ultimos" ] }, { "required": [ "months" ] }, { "required": [ "holidays" ] }, { "required": [ "repetitions" ] }], "properties": { "dates": { "type": "array", "minItems": 1, "items": { "description": "ISO date YYYY-MM-DD", "type": "string", "format": "date" } }, "weekdays": { "type": "array", "minItems": 1, "items": { "javaType": "com.sos.inventory.model.calendar.WeekDays", "type": "object", "required": [ "days" ], "properties": { "from": { "description": "ISO date YYYY-MM-DD", "type": "string", "format": "date" }, "to": { "description": "ISO date YYYY-MM-DD", "type": "string", "format": "date" }, "days": { "type": "array", "minItems": 1, "items": { "description": "digit from 0-6, 0=Sunday, 1=Monday, ..., 6=Saturday", "type": "integer", "minimum": 0, "maximum": 6 } } } } }, "monthdays": { "type": "array", "minItems": 1, "items": { "javaType": "com.sos.inventory.model.calendar.MonthDays", "type": "object", "anyOf": [{ "required": [ "days" ] }, { "required": [ "weeklyDays" ] }], "properties": { "from": { "description": "ISO date YYYY-MM-DD", "type": "string", "format": "date" }, "to": { "description": "ISO date YYYY-MM-DD", "type": "string", "format": "date" }, "days": { "type": "array", "minItems": 1, "items": { "description": "digit from 1-31", "type": "integer", "minimum": 1, "maximum": 31 } }, "weeklyDays": { "type": "array", "minItems": 1, "items": { "javaType": "com.sos.inventory.model.calendar.WeeklyDay", "type": "object", "required": [ "day", "weekOfMonth" ], "properties": { "day": { "description": "digit from 0-6, 0=Sunday, 1=Monday, ..., 6=Saturday", "type": "integer", "minimum": 0, "maximum": 6 }, "weekOfMonth": { "type": "integer", "minimum": 1, "maximum": 5 } } } } } } }, "ultimos": { "type": "array", "minItems": 1, "items": { "javaType": "com.sos.inventory.model.calendar.MonthDays", "type": "object", "anyOf": [{ "required": [ "days" ] }, { "required": [ "weeklyDays" ] }], "properties": { "from": { "description": "ISO date YYYY-MM-DD", "type": "string", "format": "date" }, "to": { "description": "ISO date YYYY-MM-DD", "type": "string", "format": "date" }, "days": { "type": "array", "minItems": 1, "items": { "description": "digit from 1-31", "type": "integer", "minimum": 1, "maximum": 31 } }, "weeklyDays": { "type": "array", "minItems": 1, "items": { "javaType": "com.sos.inventory.model.calendar.WeeklyDay", "type": "object", "required": [ "day", "weekOfMonth" ], "properties": { "day": { "description": "digit from 0-6, 0=Sunday, 1=Monday, ..., 6=Saturday", "type": "integer", "minimum": 0, "maximum": 6 }, "weekOfMonth": { "type": "integer", "minimum": 1, "maximum": 5 } } } } } } }, "months": { "type": "array", "minItems": 1, "items": { "javaType": "com.sos.inventory.model.calendar.Months", "type": "object", "anyOf": [{ "required": [ "months", "weekdays" ] }, { "required": [ "months", "monthdays" ] }, { "required": [ "months", "ultimos" ] }], "properties": { "months": { "type": "array", "minItems": 1, "items": { "type": "integer", "minimum": 1, "maximum": 12 } }, "from": { "description": "ISO date YYYY-MM-DD", "type": "string", "format": "date" }, "to": { "description": "ISO date YYYY-MM-DD", "type": "string", "format": "date" }, "weekdays": { "type": "array", "minItems": 1, "items": { "javaType": "com.sos.inventory.model.calendar.WeekDays", "type": "object", "required": [ "days" ], "properties": { "from": { "description": "ISO date YYYY-MM-DD", "type": "string", "format": "date" }, "to": { "description": "ISO date YYYY-MM-DD", "type": "string", "format": "date" }, "days": { "type": "array", "minItems": 1, "items": { "description": "digit from 0-6, 0=Sunday, 1=Monday, ..., 6=Saturday", "type": "integer", "minimum": 0, "maximum": 6 } } } } }, "monthdays": { "type": "array", "minItems": 1, "items": { "javaType": "com.sos.inventory.model.calendar.MonthDays", "type": "object", "anyOf": [{ "required": [ "days" ] }, { "required": [ "weeklyDays" ] }], "properties": { "from": { "description": "ISO date YYYY-MM-DD", "type": "string", "format": "date" }, "to": { "description": "ISO date YYYY-MM-DD", "type": "string", "format": "date" }, "days": { "type": "array", "minItems": 1, "items": { "description": "digit from 1-31", "type": "integer", "minimum": 1, "maximum": 31 } }, "weeklyDays": { "type": "array", "minItems": 1, "items": { "javaType": "com.sos.inventory.model.calendar.WeeklyDay", "type": "object", "required": [ "day", "weekOfMonth" ], "properties": { "day": { "description": "digit from 0-6, 0=Sunday, 1=Monday, ..., 6=Saturday", "type": "integer", "minimum": 0, "maximum": 6 }, "weekOfMonth": { "type": "integer", "minimum": 1, "maximum": 5 } } } } } } }, "ultimos": { "type": "array", "minItems": 1, "items": { "javaType": "com.sos.inventory.model.calendar.MonthDays", "type": "object", "anyOf": [{ "required": [ "days" ] }, { "required": [ "weeklyDays" ] }], "properties": { "from": { "description": "ISO date YYYY-MM-DD", "type": "string", "format": "date" }, "to": { "description": "ISO date YYYY-MM-DD", "type": "string", "format": "date" }, "days": { "type": "array", "minItems": 1, "items": { "description": "digit from 1-31", "type": "integer", "minimum": 1, "maximum": 31 } }, "weeklyDays": { "type": "array", "minItems": 1, "items": { "javaType": "com.sos.inventory.model.calendar.WeeklyDay", "type": "object", "required": [ "day", "weekOfMonth" ], "properties": { "day": { "description": "digit from 0-6, 0=Sunday, 1=Monday, ..., 6=Saturday", "type": "integer", "minimum": 0, "maximum": 6 }, "weekOfMonth": { "type": "integer", "minimum": 1, "maximum": 5 } } } } } } } } } }, "holidays": { "type": "array", "minItems": 1, "items": { "javaType": "com.sos.inventory.model.calendar.Holidays", "type": "object", "required": [ "dates" ], "properties": { "nationalCalendar": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "dates": { "type": "array", "minItems": 1, "items": { "description": "ISO date YYYY-MM-DD", "type": "string", "format": "date" } } } } }, "repetitions": { "type": "array", "minItems": 1, "items": { "javaType": "com.sos.inventory.model.calendar.Repetition", "type": "object", "required": [ "repetition", "step" ], "properties": { "from": { "description": "ISO date YYYY-MM-DD", "type": "string", "format": "date" }, "to": { "description": "ISO date YYYY-MM-DD", "type": "string", "format": "date" }, "repetition": { "javaType": "com.sos.inventory.model.calendar.RepetitionText", "type": "string", "enum": [ "DAILY", "WEEKLY", "MONTHLY", "YEARLY" ] }, "step": { "type": "integer", "minimum": 1, "default": 1 } } } } } }, "excludes": { "javaType": "com.sos.inventory.model.calendar.Frequencies", "type": "object", "anyOf": [{ "required": [ "dates" ] }, { "required": [ "weekdays" ] }, { "required": [ "monthdays" ] }, { "required": [ "ultimos" ] }, { "required": [ "months" ] }, { "required": [ "holidays" ] }, { "required": [ "repetitions" ] }], "properties": { "dates": { "type": "array", "minItems": 1, "items": { "description": "ISO date YYYY-MM-DD", "type": "string", "format": "date" } }, "weekdays": { "type": "array", "minItems": 1, "items": { "javaType": "com.sos.inventory.model.calendar.WeekDays", "type": "object", "required": [ "days" ], "properties": { "from": { "description": "ISO date YYYY-MM-DD", "type": "string", "format": "date" }, "to": { "description": "ISO date YYYY-MM-DD", "type": "string", "format": "date" }, "days": { "type": "array", "minItems": 1, "items": { "description": "digit from 0-6, 0=Sunday, 1=Monday, ..., 6=Saturday", "type": "integer", "minimum": 0, "maximum": 6 } } } } }, "monthdays": { "type": "array", "minItems": 1, "items": { "javaType": "com.sos.inventory.model.calendar.MonthDays", "type": "object", "anyOf": [{ "required": [ "days" ] }, { "required": [ "weeklyDays" ] }], "properties": { "from": { "description": "ISO date YYYY-MM-DD", "type": "string", "format": "date" }, "to": { "description": "ISO date YYYY-MM-DD", "type": "string", "format": "date" }, "days": { "type": "array", "minItems": 1, "items": { "description": "digit from 1-31", "type": "integer", "minimum": 1, "maximum": 31 } }, "weeklyDays": { "type": "array", "minItems": 1, "items": { "javaType": "com.sos.inventory.model.calendar.WeeklyDay", "type": "object", "required": [ "day", "weekOfMonth" ], "properties": { "day": { "description": "digit from 0-6, 0=Sunday, 1=Monday, ..., 6=Saturday", "type": "integer", "minimum": 0, "maximum": 6 }, "weekOfMonth": { "type": "integer", "minimum": 1, "maximum": 5 } } } } } } }, "ultimos": { "type": "array", "minItems": 1, "items": { "javaType": "com.sos.inventory.model.calendar.MonthDays", "type": "object", "anyOf": [{ "required": [ "days" ] }, { "required": [ "weeklyDays" ] }], "properties": { "from": { "description": "ISO date YYYY-MM-DD", "type": "string", "format": "date" }, "to": { "description": "ISO date YYYY-MM-DD", "type": "string", "format": "date" }, "days": { "type": "array", "minItems": 1, "items": { "description": "digit from 1-31", "type": "integer", "minimum": 1, "maximum": 31 } }, "weeklyDays": { "type": "array", "minItems": 1, "items": { "javaType": "com.sos.inventory.model.calendar.WeeklyDay", "type": "object", "required": [ "day", "weekOfMonth" ], "properties": { "day": { "description": "digit from 0-6, 0=Sunday, 1=Monday, ..., 6=Saturday", "type": "integer", "minimum": 0, "maximum": 6 }, "weekOfMonth": { "type": "integer", "minimum": 1, "maximum": 5 } } } } } } }, "months": { "type": "array", "minItems": 1, "items": { "javaType": "com.sos.inventory.model.calendar.Months", "type": "object", "anyOf": [{ "required": [ "months", "weekdays" ] }, { "required": [ "months", "monthdays" ] }, { "required": [ "months", "ultimos" ] }], "properties": { "months": { "type": "array", "minItems": 1, "items": { "type": "integer", "minimum": 1, "maximum": 12 } }, "from": { "description": "ISO date YYYY-MM-DD", "type": "string", "format": "date" }, "to": { "description": "ISO date YYYY-MM-DD", "type": "string", "format": "date" }, "weekdays": { "type": "array", "minItems": 1, "items": { "javaType": "com.sos.inventory.model.calendar.WeekDays", "type": "object", "required": [ "days" ], "properties": { "from": { "description": "ISO date YYYY-MM-DD", "type": "string", "format": "date" }, "to": { "description": "ISO date YYYY-MM-DD", "type": "string", "format": "date" }, "days": { "type": "array", "minItems": 1, "items": { "description": "digit from 0-6, 0=Sunday, 1=Monday, ..., 6=Saturday", "type": "integer", "minimum": 0, "maximum": 6 } } } } }, "monthdays": { "type": "array", "minItems": 1, "items": { "javaType": "com.sos.inventory.model.calendar.MonthDays", "type": "object", "anyOf": [{ "required": [ "days" ] }, { "required": [ "weeklyDays" ] }], "properties": { "from": { "description": "ISO date YYYY-MM-DD", "type": "string", "format": "date" }, "to": { "description": "ISO date YYYY-MM-DD", "type": "string", "format": "date" }, "days": { "type": "array", "minItems": 1, "items": { "description": "digit from 1-31", "type": "integer", "minimum": 1, "maximum": 31 } }, "weeklyDays": { "type": "array", "minItems": 1, "items": { "javaType": "com.sos.inventory.model.calendar.WeeklyDay", "type": "object", "required": [ "day", "weekOfMonth" ], "properties": { "day": { "description": "digit from 0-6, 0=Sunday, 1=Monday, ..., 6=Saturday", "type": "integer", "minimum": 0, "maximum": 6 }, "weekOfMonth": { "type": "integer", "minimum": 1, "maximum": 5 } } } } } } }, "ultimos": { "type": "array", "minItems": 1, "items": { "javaType": "com.sos.inventory.model.calendar.MonthDays", "type": "object", "anyOf": [{ "required": [ "days" ] }, { "required": [ "weeklyDays" ] }], "properties": { "from": { "description": "ISO date YYYY-MM-DD", "type": "string", "format": "date" }, "to": { "description": "ISO date YYYY-MM-DD", "type": "string", "format": "date" }, "days": { "type": "array", "minItems": 1, "items": { "description": "digit from 1-31", "type": "integer", "minimum": 1, "maximum": 31 } }, "weeklyDays": { "type": "array", "minItems": 1, "items": { "javaType": "com.sos.inventory.model.calendar.WeeklyDay", "type": "object", "required": [ "day", "weekOfMonth" ], "properties": { "day": { "description": "digit from 0-6, 0=Sunday, 1=Monday, ..., 6=Saturday", "type": "integer", "minimum": 0, "maximum": 6 }, "weekOfMonth": { "type": "integer", "minimum": 1, "maximum": 5 } } } } } } } } } }, "holidays": { "type": "array", "minItems": 1, "items": { "javaType": "com.sos.inventory.model.calendar.Holidays", "type": "object", "required": [ "dates" ], "properties": { "nationalCalendar": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "dates": { "type": "array", "minItems": 1, "items": { "description": "ISO date YYYY-MM-DD", "type": "string", "format": "date" } } } } }, "repetitions": { "type": "array", "minItems": 1, "items": { "javaType": "com.sos.inventory.model.calendar.Repetition", "type": "object", "required": [ "repetition", "step" ], "properties": { "from": { "description": "ISO date YYYY-MM-DD", "type": "string", "format": "date" }, "to": { "description": "ISO date YYYY-MM-DD", "type": "string", "format": "date" }, "repetition": { "javaType": "com.sos.inventory.model.calendar.RepetitionText", "type": "string", "enum": [ "DAILY", "WEEKLY", "MONTHLY", "YEARLY" ] }, "step": { "type": "integer", "minimum": 1, "default": 1 } } } } } }, "periods": { "type": "array", "minItems": 1, "items": { "javaType": "com.sos.inventory.model.calendar.Period", "type": "object", "properties": { "singleStart": { "type": "string", "pattern": "^([0-1][0-9]\|2[0-4])(:[0-5][0-9]){1,2}$" }, "begin": { "type": "string", "pattern": "^([0-1][0-9]\|2[0-4])(:[0-5][0-9]){1,2}$" }, "end": { "type": "string", "pattern": "^([0-1][0-9]\|2[0-4])(:[0-5][0-9]){1,2}$" }, "repeat": { "type": "string", "pattern": "^([0-1][0-9]\|2[0-4])(:[0-5][0-9]){1,2}$" }, "whenHoliday": { "javaType": "com.sos.inventory.model.calendar.WhenHolidayType", "description": "default: SUPPRESS", "type": "string", "enum": [ "SUPPRESS", "IGNORE", "PREVIOUSNONWORKINGDAY", "NEXTNONWORKINGDAY" ] } } } } } } }, "nonWorkingDayCalendars": { "type": "array", "items": { "javaType": "com.sos.inventory.model.calendar.AssignedNonWorkingDayCalendars", "type": "object", "required": [ "calendarName" ], "properties": { "calendarName": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "calendarPath": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 } } } }, "orderParameterisations": { "alias": "variableSets", "type": "array", "items": { "javaType": "com.sos.inventory.model.schedule.OrderParameterisation", "type": "object", "description": "Parameterisation with variable set for a schedule and optional start and end position", "properties": { "orderName": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "variables": { "description": "a map for arbitrary key-value pairs", "javaType": "com.sos.inventory.model.common.Variables", "type": "object", "additionalProperties": true }, "positions": { "javaType": "com.sos.inventory.model.schedule.OrderPositions", "type": "object", "description": "start and end position", "properties": { "startPosition": { "anyOf": [{ "description": "Actually, each even item is a string, each odd item is an integer", "type": "array", "minItems": 1, "items": { "anyOf": [{ "type": "integer" }, { "type": "string" }] } }, { "type": "string", "pattern": "^[^<>]$", "maxLength": 255, "minLength": 1 }] }, "endPositions": { "type": "array", "items": { "anyOf": [{ "description": "Actually, each even item is a string, each odd item is an integer", "type": "array", "minItems": 1, "items": { "anyOf": [{ "type": "integer" }, { "type": "string" }] } }, { "type": "string", "pattern": "^[^<>]*$", "maxLength": 255, "minLength": 1 }] } } }, "additionalProperties": false } } } } } } } }, "additionalProperties": false } TODO TODO
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 'references'	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	'references' 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": "references failed!" } } { "deliveryDate": "2016-05-05T21:13:35Z", "surveyDate": "2016-05-05T21:13:33Z", "error": { "code": "JOC-420", "message": "references 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 }