| 200 |
Each plan can have a compact or detailed response.
It depends on the parameter compact.
- The fields are
- planId
- numOfNoticeBoards
- noticeBoards
- path
- numOfNotices
- numOfExpectingOrders
- numOfAnnouncements
- numOfPostedNotices
- numOfExpectedNotices
- notices (compact==false)
- id
- state (POSTED, EXPECTED, ANNOUNCED)
- expectingOrders
- closed
|
|
application/json
model |
example
{
"title": "Plans",
"$schema": "http://json-schema.org/draft-04/schema#",
"javaType": "com.sos.joc.model.plan.Plans",
"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"
},
"surveyDate": {
"description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty",
"type": "string",
"format": "date-time"
},
"plans": {
"type": "array",
"items": {
"javaType": "com.sos.joc.model.plan.Plan",
"type": "object",
"required": [
"planId",
"closed"
],
"properties": {
"planId": {
"javaType": "com.sos.joc.model.plan.PlanId",
"type": "object",
"required": [
"planSchemaId",
"noticeSpaceKey"
],
"properties": {
"noticeSpaceKey": {
"type": "string",
"pattern": "^[^<>]*$",
"maxLength": 255,
"minLength": 1
},
"planSchemaId": {
"type": "string",
"pattern": "^[^<>]*$",
"maxLength": 255,
"minLength": 1
}
},
"additionalProperties": false
},
"closed": {
"type": "boolean",
"default": false
},
"state": {
"javaType": "com.sos.joc.model.plan.PlanState",
"type": "object",
"required": [
"severity",
"_text"
],
"properties": {
"severity": {
"type": "integer"
},
"_text": {
"javaType": "com.sos.joc.model.plan.PlanStateText",
"type": "string",
"enum": [
"OPEN",
"CLOSED",
"FINISHED",
"DELETED"
]
},
"since": {
"description": "since only for FINISHED state",
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
},
"numOfNoticeBoards": {
"type": "integer",
"minimum": 0
},
"noticeBoards": {
"type": "array",
"items": {
"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"
],
"propertyOrder": [
"TYPE",
"version",
"boardType",
"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"
},
"boardType": {
"javaType": "com.sos.inventory.model.board.BoardType",
"type": "string",
"enum": [
"GLOBAL",
"PLANNABLE"
],
"default": "GLOBAL"
},
"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.7.1",
"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",
"description": "SUSPENDED, OUTSTANDING only for Workflows",
"type": "string",
"enum": [
"IN_SYNC",
"NOT_IN_SYNC",
"NOT_DEPLOYED",
"SUSPENDED",
"OUTSTANDING",
"UNKNOWN"
]
}
}
},
"numOfNotices": {
"type": "integer",
"minimum": 0
},
"numOfAnnouncements": {
"type": "integer",
"minimum": 0
},
"numOfPostedNotices": {
"type": "integer",
"minimum": 0
},
"numOfExpectedNotices": {
"type": "integer",
"minimum": 0
},
"numOfExpectingOrders": {
"type": "integer",
"minimum": 0
},
"notices": {
"type": "array",
"items": {
"javaType": "com.sos.controller.model.board.Notice",
"type": "object",
"required": [
"id",
"key"
],
"properties": {
"id": {
"type": "string",
"pattern": "^[^<>]*$",
"maxLength": 255,
"minLength": 1
},
"key": {
"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,
"minLength": 1
},
"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",
"UNKNOWN"
]
},
"_reason": {
"javaType": "com.sos.joc.model.order.OrderWaitingReason",
"type": "string",
"enum": [
"DELAYED_AFTER_ERROR",
"FORKED",
"EXPECTING_NOTICES",
"WAITING_FOR_LOCK",
"BETWEEN_CYCLES"
]
}
},
"additionalProperties": false
},
"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"
},
"subagentId": {
"type": "string"
},
"cycleState": {
"type": "object",
"javaType": "com.sos.controller.model.order.OrderCycleState",
"description": "set if state == BetweenCycles or processing inside a cycle",
"properties": {
"next": {
"description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty",
"type": "string",
"format": "date-time"
},
"since": {
"description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty",
"type": "string",
"format": "date-time"
},
"index": {
"type": "integer"
}
},
"additionalProperties": false
},
"retryState": {
"type": "object",
"javaType": "com.sos.controller.model.order.OrderRetryState",
"description": "set if state == DelayedAfterError",
"properties": {
"next": {
"description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty",
"type": "string",
"format": "date-time"
},
"attempt": {
"type": "integer",
"minimum": 1
}
},
"additionalProperties": false
},
"sleepState": {
"type": "object",
"javaType": "com.sos.controller.model.order.OrderSleepState",
"description": "set if state == OrderSleeping",
"properties": {
"until": {
"description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty",
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
},
"expectedNotices": {
"description": "if state._reason == EXPECTING_NOTICES",
"type": "array",
"items": {
"type": "object",
"javaType": "com.sos.controller.model.order.ExpectedNotice",
"properties": {
"boardName": {
"alias": "boardPath",
"type": "string"
},
"noticeId": {
"type": "string"
}
},
"additionalProperties": false
}
},
"label": {
"description": "a label is only in the response if the request restricts the orders to one workflow",
"type": "string",
"pattern": "^[^<>]*$",
"maxLength": 255
},
"tags": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"pattern": "^[^<>]*$",
"maxLength": 255
}
},
"position": {
"description": "Actually, each even item is a string, each odd item is an integer",
"type": "array",
"minItems": 1,
"items": {
"anyOf": [{
"type": "integer"
}, {
"type": "string"
}]
}
},
"positionString": {
"type": "string",
"pattern": "^[^<>]*$",
"maxLength": 255
},
"positionIsImplicitEnd": {
"type": "boolean"
},
"endPositions": {
"type": "array",
"items": {
"anyOf": [{
"description": "Actually, each even item is a string, each odd item is an integer",
"type": "array",
"items": {
"anyOf": [{
"type": "integer"
}, {
"type": "string"
}]
}
}, {
"type": "string"
}]
}
},
"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"
],
"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
},
"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"
}
}
},
"hasChildOrders": {
"type": "boolean",
"default": false
},
"canLeave": {
"description": "only relevant for state COMPLETED",
"type": "boolean"
},
"isContinuable": {
"type": "boolean"
},
"isResumable": {
"type": "boolean"
},
"isSuspendible": {
"type": "boolean"
}
},
"additionalProperties": false
}
},
"expectingOrderIds": {
"description": "is empty if expectingOrders is filled",
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"pattern": "^[^<>]*$",
"maxLength": 255,
"minLength": 1
}
},
"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
}
}
},
"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",
"ANNOUNCED"
]
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
}
{ "deliveryDate": "2025-02-03T14:25:10.945+00:00", "surveyDate": "2025-02-03T10:53:47.004+00:00", "plans": [{ "planId": { "planKey": "2025-01-29", "planSchemaId": "DailyPlan" }, "closed": false, "noticeBoards": [{ "path": "/oh/bPlannable1", "versionDate": "2025-02-03T10:50:42.000+00:00", "numOfNotices": 1, "notices": [{ "id": "DailyPlan╱2025-01-29╱—", "key": "", "state": { "severity": 4, "_text": "ANNOUNCED" } }], "TYPE": "Board", "boardType": "PLANNABLE" }] }] }
{
"deliveryDate": "2025-02-03T14:25:10.945+00:00",
"surveyDate": "2025-02-03T10:53:47.004+00:00",
"plans": [{
"planId": {
"planKey": "2025-01-29",
"planSchemaId": "DailyPlan"
},
"closed": false,
"noticeBoards": [{
"path": "/oh/bPlannable1",
"versionDate": "2025-02-03T10:50:42.000+00:00",
"numOfNotices": 1,
"notices": [{
"id": "DailyPlan╱2025-01-29╱—",
"key": "",
"state": {
"severity": 4,
"_text": "ANNOUNCED"
}
}],
"TYPE": "Board",
"boardType": "PLANNABLE"
}]
}]
}
|