JOC API

/locks

POST

Returns deployed locks

Parameters in the POST body schema

Name	Type	Description	Example	Default
`controllerId`	required, string	Controller ID	myController
`lockPaths`	optional, array[string]	Filters response by a collection of locks specified by its path. The parameter `folders` is ignored if this parameter is defined.	["/path/myLock"]
`folders`	optional, array[object]	Limits the result to a collection of folders	[{ "folder": "/sos", "recursive": true }]
`compact`	optional, boolean	A compact response is returned if this parameter is true		false
`limit`	optional, integer	Limits the number of holding and waiting orders respectively, -1=unlimited	5000	10000

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": "locks request filter",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "javaType": "com.sos.joc.model.lock.LocksFilter",
    "type": "object",
    "required": [
        "controllerId"
    ],
    "properties": {
        "controllerId": {
            "type": "string",
            "pattern": "^[^/\\<>?:\"|*]*$",
            "maxLength": 100,
            "minLength": 1
        },
        "lockPaths": {
            "type": "array",
            "items": {
                "type": "string",
                "pattern": "^[^<>]*$",
                "maxLength": 255,
                "minLength": 1
            }
        },
        "folders": {
            "type": "array",
            "items": {
                "type": "object",
                "javaType": "com.sos.joc.model.common.Folder",
                "required": [
                    "folder"
                ],
                "properties": {
                    "folder": {
                        "description": "absolute path of an object.",
                        "type": "string",
                        "pattern": "^(/|(/[^/\\\\<>?:\"|*]+)+)$",
                        "maxLength": 255,
                        "minLength": 1
                    },
                    "recursive": {
                        "type": "boolean",
                        "default": true
                    }
                },
                "additionalProperties": false
            }
        },
        "compact": {
            "description": "controls if the object's data is compact or detailed",
            "type": "boolean",
            "default": false
        },
        "limit": {
            "description": "-1=unlimited",
            "type": "integer",
            "default": 10000
        }
    }
}

TODO

TODO

Responses

Code	Description	Body
200	Each lock can have a compact or detailed response. It depends on the parameter `compact`. Required fields are lock path versionDate state limit acquiredLockCount ordersHoldingLocksCount ordersWaitingForLocksCount The compact view has further optional fields title documentationName The detailed view has the following optional fields in addition to the compact view workflows Each workflow has the fields path versionId ordersHoldingLocks lock type (EXCLUSIVE, SHARED) count orders ordersWaitingForLocks lock type (EXCLUSIVE, SHARED) count orders	application/json model \| example { "title": "locks response", "$schema": "http://json-schema.org/draft-04/schema#", "javaType": "com.sos.joc.model.lock.Locks", "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" }, "locks": { "type": "array", "items": { "javaType": "com.sos.joc.model.lock.common.LockEntry", "type": "object", "required": [ "lock", "acquiredLockCount", "ordersHoldingLocksCount", "ordersWaitingForLocksCount" ], "properties": { "lock": { "javaType": "com.sos.controller.model.lock.Lock", "type": "object", "extends": { "javaType": "com.sos.inventory.model.lock.Lock", "type": "object", "javaInterfaces": [ "com.sos.joc.model.common.IConfigurationObject", "com.sos.joc.model.common.IDeployObject", "com.sos.inventory.model.common.IInventoryObject" ], "required": [ "limit" ], "propertyOrder": [ "TYPE", "version", "limit" ], "description": "deploy object with fixed property 'TYPE':'Lock'", "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 }, "limit": { "type": "integer", "minimum": 0, "default": 1 }, "documentationName": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "title": { "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 }, "acquiredLockCount": { "type": "integer", "minimum": 0 }, "ordersHoldingLocksCount": { "type": "integer", "minimum": 0 }, "ordersWaitingForLocksCount": { "type": "integer", "minimum": 0 }, "workflows": { "type": "array", "items": { "javaType": "com.sos.joc.model.lock.common.LockWorkflow", "type": "object", "required": [ "path", "versionId" ], "properties": { "path": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "versionId": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "ordersHoldingLocks": { "type": "array", "items": { "javaType": "com.sos.joc.model.lock.common.LockOrder", "type": "object", "required": [ "lock", "order" ], "properties": { "lock": { "javaType": "com.sos.joc.model.lock.common.WorkflowLock", "type": "object", "required": [ "id", "type" ], "properties": { "id": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "type": { "javaType": "com.sos.joc.model.lock.common.WorkflowLockType", "type": "string", "enum": [ "EXCLUSIVE", "SHARED", "UNKNOWN" ] }, "count": { "type": "integer", "minimum": 0 } }, "additionalProperties": false }, "order": { "javaType": "com.sos.joc.model.order.OrderV", "type": "object", "required": [ "orderId", "workflowId", "state" ], "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" }, "orderId": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "arguments": { "description": "a map for arbitrary key-value pairs", "javaType": "com.sos.inventory.model.common.Variables", "type": "object", "additionalProperties": true }, "workflowId": { "javaType": "com.sos.controller.model.workflow.WorkflowId", "type": "object", "required": [ "path" ], "properties": { "path": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "versionId": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 } }, "additionalProperties": false }, "state": { "javaType": "com.sos.joc.model.order.OrderState", "type": "object", "required": [ "severity", "_text" ], "properties": { "severity": { "type": "integer" }, "_text": { "javaType": "com.sos.joc.model.order.OrderStateText", "type": "string", "enum": [ "PLANNED", "PENDING", "SCHEDULED", "RUNNING", "INPROGRESS", "PROMPTING", "SUSPENDED", "FAILED", "WAITING", "BLOCKED", "CANCELLED", "FINISHED", "BROKEN", "CALLING", "UNKNOWN" ] }, "_reason": { "javaType": "com.sos.joc.model.order.OrderWaitingReason", "type": "string", "enum": [ "DELAYED_AFTER_ERROR", "FORKED", "EXPECTING_NOTICE", "WAITING_FOR_LOCK" ] } } }, "marked": { "javaType": "com.sos.joc.model.order.OrderMark", "type": "object", "required": [ "severity", "_text" ], "properties": { "severity": { "type": "integer" }, "_text": { "javaType": "com.sos.joc.model.order.OrderMarkText", "type": "string", "enum": [ "CANCELLING", "RESUMING", "SUSPENDING" ] } } }, "attachedState": { "javaType": "com.sos.controller.model.order.OrderAttachedState", "type": "object", "properties": { "TYPE": { "description": "Attaching, Attached, ...", "type": "string" }, "agentName": { "type": "string" } }, "additionalProperties": false }, "agentId": { "type": "string" }, "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 }, "scheduledFor": { "type": "number", "format": "utc-millisec", "minimum": 0 }, "scheduledNever": { "description": "deprecated -> is State.PENDING", "type": "boolean", "default": false }, "question": { "description": "only relevant for state PROMPTING", "type": "string" }, "lastOutcome": { "javaType": "com.sos.controller.model.common.Outcome", "type": "object", "required": [ "TYPE" ], "properties": { "TYPE": { "description": "Succeeded, Failed, Disrupted, Cancelled, Killed, TimedOut", "type": "string" }, "namedValues": { "description": "a map for arbitrary key-value pairs", "javaType": "com.sos.inventory.model.common.Variables", "type": "object", "additionalProperties": true }, "outcome": { "description": "outcome-schema.json" } }, "additionalProperties": false }, "historicOutcome": { "description": "only for compact parameter is false", "type": "array", "items": { "type": "object", "javaType": "com.sos.controller.model.workflow.HistoricOutcome", "properties": { "position": { "description": "Actually, each even item is a string, each odd item is an integer", "type": "array", "items": { "anyOf": [{ "type": "integer" }, { "type": "string" }] } }, "outcome": { "javaType": "com.sos.controller.model.common.Outcome", "type": "object", "required": [ "TYPE" ], "properties": { "TYPE": { "description": "Succeeded, Failed, Disrupted, Cancelled, Killed, TimedOut", "type": "string" }, "namedValues": { "description": "a map for arbitrary key-value pairs", "javaType": "com.sos.inventory.model.common.Variables", "type": "object", "additionalProperties": true }, "outcome": { "description": "outcome-schema.json" } }, "additionalProperties": false } }, "additionalProperties": false } }, "requirements": { "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" ], "description": "parameters only for parameter type 'List'", "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", "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 } } }, "additionalProperties": false } }, "allowUndeclared": { "type": "boolean", "default": false } }, "additionalProperties": false }, "cyclicOrder": { "type": "object", "javaType": "com.sos.joc.model.dailyplan.CyclicOrderInfos", "properties": { "count": { "type": "integer", "minimum": 0 }, "firstOrderId": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "lastOrderId": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "firstStart": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" }, "lastStart": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" } } } } } }, "additionalProperties": false } }, "ordersWaitingForLocks": { "type": "array", "items": { "javaType": "com.sos.joc.model.lock.common.LockOrder", "type": "object", "required": [ "lock", "order" ], "properties": { "lock": { "javaType": "com.sos.joc.model.lock.common.WorkflowLock", "type": "object", "required": [ "id", "type" ], "properties": { "id": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "type": { "javaType": "com.sos.joc.model.lock.common.WorkflowLockType", "type": "string", "enum": [ "EXCLUSIVE", "SHARED", "UNKNOWN" ] }, "count": { "type": "integer", "minimum": 0 } }, "additionalProperties": false }, "order": { "javaType": "com.sos.joc.model.order.OrderV", "type": "object", "required": [ "orderId", "workflowId", "state" ], "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" }, "orderId": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "arguments": { "description": "a map for arbitrary key-value pairs", "javaType": "com.sos.inventory.model.common.Variables", "type": "object", "additionalProperties": true }, "workflowId": { "javaType": "com.sos.controller.model.workflow.WorkflowId", "type": "object", "required": [ "path" ], "properties": { "path": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "versionId": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 } }, "additionalProperties": false }, "state": { "javaType": "com.sos.joc.model.order.OrderState", "type": "object", "required": [ "severity", "_text" ], "properties": { "severity": { "type": "integer" }, "_text": { "javaType": "com.sos.joc.model.order.OrderStateText", "type": "string", "enum": [ "PLANNED", "PENDING", "SCHEDULED", "RUNNING", "INPROGRESS", "PROMPTING", "SUSPENDED", "FAILED", "WAITING", "BLOCKED", "CANCELLED", "FINISHED", "BROKEN", "CALLING", "UNKNOWN" ] }, "_reason": { "javaType": "com.sos.joc.model.order.OrderWaitingReason", "type": "string", "enum": [ "DELAYED_AFTER_ERROR", "FORKED", "EXPECTING_NOTICE", "WAITING_FOR_LOCK" ] } } }, "marked": { "javaType": "com.sos.joc.model.order.OrderMark", "type": "object", "required": [ "severity", "_text" ], "properties": { "severity": { "type": "integer" }, "_text": { "javaType": "com.sos.joc.model.order.OrderMarkText", "type": "string", "enum": [ "CANCELLING", "RESUMING", "SUSPENDING" ] } } }, "attachedState": { "javaType": "com.sos.controller.model.order.OrderAttachedState", "type": "object", "properties": { "TYPE": { "description": "Attaching, Attached, ...", "type": "string" }, "agentName": { "type": "string" } }, "additionalProperties": false }, "agentId": { "type": "string" }, "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 }, "scheduledFor": { "type": "number", "format": "utc-millisec", "minimum": 0 }, "scheduledNever": { "description": "deprecated -> is State.PENDING", "type": "boolean", "default": false }, "question": { "description": "only relevant for state PROMPTING", "type": "string" }, "lastOutcome": { "javaType": "com.sos.controller.model.common.Outcome", "type": "object", "required": [ "TYPE" ], "properties": { "TYPE": { "description": "Succeeded, Failed, Disrupted, Cancelled, Killed, TimedOut", "type": "string" }, "namedValues": { "description": "a map for arbitrary key-value pairs", "javaType": "com.sos.inventory.model.common.Variables", "type": "object", "additionalProperties": true }, "outcome": { "description": "outcome-schema.json" } }, "additionalProperties": false }, "historicOutcome": { "description": "only for compact parameter is false", "type": "array", "items": { "type": "object", "javaType": "com.sos.controller.model.workflow.HistoricOutcome", "properties": { "position": { "description": "Actually, each even item is a string, each odd item is an integer", "type": "array", "items": { "anyOf": [{ "type": "integer" }, { "type": "string" }] } }, "outcome": { "javaType": "com.sos.controller.model.common.Outcome", "type": "object", "required": [ "TYPE" ], "properties": { "TYPE": { "description": "Succeeded, Failed, Disrupted, Cancelled, Killed, TimedOut", "type": "string" }, "namedValues": { "description": "a map for arbitrary key-value pairs", "javaType": "com.sos.inventory.model.common.Variables", "type": "object", "additionalProperties": true }, "outcome": { "description": "outcome-schema.json" } }, "additionalProperties": false } }, "additionalProperties": false } }, "requirements": { "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" ], "description": "parameters only for parameter type 'List'", "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", "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 } } }, "additionalProperties": false } }, "allowUndeclared": { "type": "boolean", "default": false } }, "additionalProperties": false }, "cyclicOrder": { "type": "object", "javaType": "com.sos.joc.model.dailyplan.CyclicOrderInfos", "properties": { "count": { "type": "integer", "minimum": 0 }, "firstOrderId": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "lastOrderId": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "firstStart": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" }, "lastStart": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" } } } } } }, "additionalProperties": false } } }, "additionalProperties": false } }, "workflowTagsPerWorkflow": { "description": "a map of workflowName -> tags-array", "javaType": "com.sos.joc.model.common.WorkflowTags", "type": "object", "additionalProperties": { "type": "array", "uniqueItems": true, "items": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 } } } }, "additionalProperties": false } } }, "additionalProperties": false } { "deliveryDate": "2021-02-03T15:51:58.274+0000", "locks": [{ "lock": { "TYPE": "Lock", "id": "my_lock_1", "limit": 1, "path": "/my_lock_1", "title": "my_lock_1 title" }, "acquiredLockCount": 0, "ordersHoldingLocksCount": 0, "ordersWaitingForLocksCount": 0, "workflows": [] }, { "lock": { "TYPE": "Lock", "id": "my_lock_2", "limit": 10, "path": "/my_lock_2", "title": "" }, "acquiredLockCount": 10, "ordersHoldingLocksCount": 1, "ordersWaitingForLocksCount": 1, "workflows": [{ "path": "/my_workflow", "versionId": "6c877a23-eca6-443f-a8c1-4f925aa6999f", "ordersHoldingLocks": [{ "lock": { "id": "my_lock_2", "type": "SHARED", "count": 10 }, "order": { "orderId": "#2021-02-03#T367510249-x", "workflowId": { "path": "/my_workflow", "versionId": "6c877a23-eca6-443f-a8c1-4f925aa6999f" }, "state": { "severity": 0, "_text": "RUNNING" }, "attachedState": { "TYPE": "Attached" }, "agentId": "agent", "position": [ 0, "lock", 0 ], "historicOutcome": [] } }], "ordersWaitingForLocks": [{ "lock": { "id": "my_lock_2", "type": "UNKNOWN" }, "order": { "orderId": "#2021-02-03#T367514933-xx", "workflowId": { "path": "/my_workflow", "versionId": "6c877a23-eca6-443f-a8c1-4f925aa6999f" }, "state": { "severity": 8, "_text": "WAITING" }, "position": [ 0 ], "historicOutcome": [] } }] }] }] } { "deliveryDate": "2021-02-03T15:51:58.274+0000", "locks": [{ "lock": { "TYPE": "Lock", "id": "my_lock_1", "limit": 1, "path": "/my_lock_1", "title": "my_lock_1 title" }, "acquiredLockCount": 0, "ordersHoldingLocksCount": 0, "ordersWaitingForLocksCount": 0, "workflows": [] }, { "lock": { "TYPE": "Lock", "id": "my_lock_2", "limit": 10, "path": "/my_lock_2", "title": "" }, "acquiredLockCount": 10, "ordersHoldingLocksCount": 1, "ordersWaitingForLocksCount": 1, "workflows": [{ "path": "/my_workflow", "versionId": "6c877a23-eca6-443f-a8c1-4f925aa6999f", "ordersHoldingLocks": [{ "lock": { "id": "my_lock_2", "type": "SHARED", "count": 10 }, "order": { "orderId": "#2021-02-03#T367510249-x", "workflowId": { "path": "/my_workflow", "versionId": "6c877a23-eca6-443f-a8c1-4f925aa6999f" }, "state": { "severity": 0, "_text": "RUNNING" }, "attachedState": { "TYPE": "Attached" }, "agentId": "agent", "position": [ 0, "lock", 0 ], "historicOutcome": [] } }], "ordersWaitingForLocks": [{ "lock": { "id": "my_lock_2", "type": "UNKNOWN" }, "order": { "orderId": "#2021-02-03#T367514933-xx", "workflowId": { "path": "/my_workflow", "versionId": "6c877a23-eca6-443f-a8c1-4f925aa6999f" }, "state": { "severity": 8, "_text": "WAITING" }, "position": [ 0 ], "historicOutcome": [] } }] }] }] }
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 'locks'	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	'locks' 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": "locks failed!" } } { "deliveryDate": "2016-05-05T21:13:35Z", "surveyDate": "2016-05-05T21:13:33Z", "error": { "code": "JOC-420", "message": "locks 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 }