JOC API

/notice/board

POST

Gets a deployed notice board

Parameters in the POST body schema

Name	Type	Description	Example	Default
`controllerId`	required, string	Controller ID	myController
`noticeBoardPath`	required, string	Path of the notice board	"/path/to/myBoard"
`compact`	optional, boolean	A compact response is returned if this parameter is true		false
`limit`	optional, integer	Limits the number of expecting orders, -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": "notice board request filter",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "javaType": "com.sos.joc.model.board.BoardFilter",
    "type": "object",
    "required": [
        "controllerId",
        "noticeBoardPath"
    ],
    "properties": {
        "controllerId": {
            "type": "string",
            "pattern": "^[^/\\<>?:\"|*]*$",
            "maxLength": 100,
            "minLength": 1
        },
        "noticeBoardPath": {
            "type": "string",
            "pattern": "^[^<>]*$",
            "maxLength": 255,
            "minLength": 1
        },
        "compact": {
            "description": "controls if the object's data is compact or detailed",
            "type": "boolean",
            "default": false
        },
        "limit": {
            "description": "-1=unlimited",
            "type": "integer",
            "default": 10000
        }
    }
}

{ "controllerId": "standalone", "noticeBoardPath": "b2" }

{
    "controllerId": "standalone",
    "noticeBoardPath": "b2"
}

Responses

Code	Description	Body
200	TODO	application/json model \| example { "title": "notice board response", "$schema": "http://json-schema.org/draft-04/schema#", "javaType": "com.sos.joc.model.board.Board", "type": "object", "required": [ "deliveryDate", "noticeBoard" ], "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" }, "noticeBoard": { "javaType": "com.sos.controller.model.board.Board", "type": "object", "extends": { "javaType": "com.sos.inventory.model.board.Board", "type": "object", "javaInterfaces": [ "com.sos.joc.model.common.IConfigurationObject", "com.sos.joc.model.common.IDeployObject", "com.sos.inventory.model.common.IInventoryObject" ], "required": [ "postOrderToNoticeId", "expectOrderToNoticeId", "endOfLife" ], "propertyOrder": [ "TYPE", "version", "postOrderToNoticeId", "endOfLife", "expectOrderToNoticeId", "title", "documentationName" ], "description": "deploy object with fixed property 'TYPE':'Board'", "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" }, "postOrderToNoticeId": { "description": "Expression that returns a NoticeId for the PostNotice statement.", "alias": "toNotice", "type": "string" }, "endOfLife": { "description": "Expression that returns for the PostNotice statement the time until when the note should be valid, expressed as number of milliseconds since 1970-01-01, 0 o'clock, UTC. Then JS7 will delete the note.", "type": "string" }, "expectOrderToNoticeId": { "description": "Expression that returns a NoticeId for the ExpectNotice statement.", "alias": "readingOrderToNoticeId", "type": "string" }, "version": { "description": "inventory repository version", "type": "string", "pattern": "[0-9]+\\.[0-9]+\\.[0-9]+", "default": "1.0.0", "maxLength": 10 }, "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" ] } } }, "numOfNotices": { "type": "integer", "minimum": 0 }, "numOfExpectingOrders": { "type": "integer", "minimum": 0 }, "notices": { "type": "array", "items": { "javaType": "com.sos.controller.model.board.Notice", "type": "object", "required": [ "id", "endOfLife" ], "properties": { "id": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255, "minLength": 1 }, "endOfLife": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" }, "expectingOrders": { "type": "array", "items": { "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" } } } } } }, "state": { "javaType": "com.sos.controller.model.board.NoticeState", "type": "object", "required": [ "severity", "_text" ], "properties": { "severity": { "type": "integer" }, "_text": { "javaType": "com.sos.controller.model.board.NoticeStateText", "type": "string", "enum": [ "POSTED", "EXPECTED" ] } }, "additionalProperties": false } }, "additionalProperties": false } } }, "additionalProperties": false } }, "additionalProperties": false } { "deliveryDate": "2021-09-19T14:39:49.126+0000", "surveyDate": "2021-09-19T01:03:48.840+0000", "noticeBoard": { "path": "/oh/b2", "versionDate": "2021-08-13T15:01:33.000+0000", "state": { "severity": 6, "_text": "IN_SYNC" }, "notices": [{ "id": "2021-09-18", "expectingOrders": [{ "orderId": "#2021-09-18#T1979038619-root", "workflowId": { "path": "/oh/w1", "versionId": "2b56fc1a-ed0b-4cee-aff4-70e950750f84" }, "state": { "severity": 8, "_text": "WAITING" }, "position": [ 0 ], "positionString": "0", "scheduledNever": false, "historicOutcome": [] }], "state": { "severity": 8, "_text": "EXPECTED" } }, { "id": "2021-09-19", "endOfLife": "2021-09-19T22:00:00.000+0000", "expectingOrders": [], "state": { "severity": 6, "_text": "POSTED" } }], "TYPE": "Board", "postOrderToNoticeId": "replaceAll($js7OrderId, '^#([0-9]{4}-[0-9]{2}-[0-9]{2})#.$', '$1')", "endOfLife": "$js7EpochMilli + 86400000", "expectOrderToNoticeId": "replaceAll($js7OrderId, '^#([0-9]{4}-[0-9]{2}-[0-9]{2})#.$', '$1')", "title": "myBoard" } } { "deliveryDate": "2021-09-19T14:39:49.126+0000", "surveyDate": "2021-09-19T01:03:48.840+0000", "noticeBoard": { "path": "/oh/b2", "versionDate": "2021-08-13T15:01:33.000+0000", "state": { "severity": 6, "_text": "IN_SYNC" }, "notices": [{ "id": "2021-09-18", "expectingOrders": [{ "orderId": "#2021-09-18#T1979038619-root", "workflowId": { "path": "/oh/w1", "versionId": "2b56fc1a-ed0b-4cee-aff4-70e950750f84" }, "state": { "severity": 8, "_text": "WAITING" }, "position": [ 0 ], "positionString": "0", "scheduledNever": false, "historicOutcome": [] }], "state": { "severity": 8, "_text": "EXPECTED" } }, { "id": "2021-09-19", "endOfLife": "2021-09-19T22:00:00.000+0000", "expectingOrders": [], "state": { "severity": 6, "_text": "POSTED" } }], "TYPE": "Board", "postOrderToNoticeId": "replaceAll($js7OrderId, '^#([0-9]{4}-[0-9]{2}-[0-9]{2})#.$', '$1')", "endOfLife": "$js7EpochMilli + 86400000", "expectOrderToNoticeId": "replaceAll($js7OrderId, '^#([0-9]{4}-[0-9]{2}-[0-9]{2})#.$', '$1')", "title": "myBoard" } }
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 'board'	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	'board' 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": "board failed!" } } { "deliveryDate": "2016-05-05T21:13:35Z", "surveyDate": "2016-05-05T21:13:33Z", "error": { "code": "JOC-420", "message": "board 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 }