200 |
TODO |
|
application/json
model |
example
{
"title": "history collection of orders",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "one item per started order",
"javaType": "com.sos.joc.model.order.OrderHistory",
"type": "object",
"required": [
"deliveryDate",
"history"
],
"properties": {
"deliveryDate": {
"description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty",
"type": "string",
"format": "date-time"
},
"history": {
"type": "array",
"items": {
"javaType": "com.sos.joc.model.order.OrderHistoryItem",
"type": "object",
"required": [
"surveyDate",
"orderId",
"workflow",
"startTime",
"plannedTime",
"position",
"sequence",
"state",
"orderState",
"historyId"
],
"properties": {
"surveyDate": {
"description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty",
"type": "string",
"format": "date-time"
},
"controllerId": {
"type": "string"
},
"orderId": {
"type": "string"
},
"tags": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"pattern": "^[^<>]*$",
"maxLength": 255,
"minLength": 1
}
},
"workflow": {
"description": "absolute path of an object.",
"type": "string",
"pattern": "^(/|(/[^/\\\\<>?:\"|*]+)+)$",
"maxLength": 255,
"minLength": 1
},
"startTime": {
"description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty",
"type": "string",
"format": "date-time"
},
"plannedTime": {
"description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty",
"type": "string",
"format": "date-time"
},
"endTime": {
"description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty",
"type": "string",
"format": "date-time"
},
"position": {
"type": "string"
},
"sequence": {
"type": "integer",
"minimum": 0
},
"state": {
"javaType": "com.sos.joc.model.common.HistoryState",
"type": "object",
"required": [
"severity",
"_text"
],
"properties": {
"severity": {
"description": "0=successful, 1=incomplete, 2=failed with a green/yellow/red representation",
"type": "integer"
},
"_text": {
"javaType": "com.sos.joc.model.common.HistoryStateText",
"type": "string",
"enum": [
"SUCCESSFUL",
"INCOMPLETE",
"FAILED"
]
}
}
},
"orderState": {
"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
},
"historyId": {
"type": "number",
"format": "utc-millisec",
"minimum": 0
},
"children": {
"type": "array",
"items": {
"description": "orderHistoryItem-schema.json"
}
},
"arguments": {
"description": "a map for arbitrary key-value pairs",
"javaType": "com.sos.inventory.model.common.Variables",
"type": "object",
"additionalProperties": true
}
}
}
},
"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
}
{ "deliveryDate": "2021-04-16T22:05:28.245+0000", "history": [{ "surveyDate": "2021-04-16T20:12:47.000+0000", "controllerId": "controller", "orderId": "#2021-04-16#P0000000004-schedule24", "workflow": "/Demo/MutualExclusion/demo1-pdlSharedLockSerial_002", "startTime": "2021-04-16T20:12:02.000+0000", "plannedTime": "2021-04-16T20:12:02.000+0000", "endTime": "2021-04-16T20:12:46.000+0000", "sequence": 0, "state": { "severity": 6, "_text": "SUCCESSFUL" }, "orderState": { "severity": 6, "_text": "FINISHED" }, "historyId": 29, "children": [] }, { "surveyDate": "2021-04-15T20:12:23.000+0000", "controllerId": "controller", "orderId": "#2021-04-15#P0000000003-demoPdwForm", "workflow": "/Demo/ParallelExecution/demo-pdwFork", "startTime": "2021-04-15T20:12:00.000+0000", "plannedTime": "2021-04-15T20:12:00.000+0000", "endTime": "2021-04-15T20:12:22.000+0000", "sequence": 0, "state": { "severity": 6, "_text": "SUCCESSFUL" }, "orderState": { "severity": 6, "_text": "FINISHED" }, "historyId": 26, "children": [] }, { "surveyDate": "2021-04-14T20:22:42.000+0000", "controllerId": "controller", "orderId": "#2021-04-14#P0000000001-pdfExclusive", "workflow": "/Demo/MutualExclusion/demo1-pdlExclusiveLockSerial_002", "startTime": "2021-04-14T20:22:00.000+0000", "plannedTime": "2021-04-14T20:22:00.000+0000", "endTime": "2021-04-14T20:22:41.000+0000", "sequence": 0, "state": { "severity": 6, "_text": "SUCCESSFUL" }, "orderState": { "severity": 6, "_text": "FINISHED" }, "historyId": 23, "children": [] }, { "surveyDate": "2021-04-14T18:00:50.000+0000", "controllerId": "controller", "orderId": "#2021-04-14#T8423216948-root", "workflow": "/Demo/ParallelExecution/demo-pwdForkNested", "startTime": "2021-04-14T18:00:17.000+0000", "plannedTime": "2021-04-14T18:00:17.000+0000", "endTime": "2021-04-14T18:00:49.000+0000", "sequence": 0, "state": { "severity": 6, "_text": "SUCCESSFUL" }, "orderState": { "severity": 6, "_text": "FINISHED" }, "historyId": 2, "children": [] }, { "surveyDate": "2021-04-14T18:00:48.000+0000", "controllerId": "controller", "orderId": "#2021-04-14#T8423212514-root", "workflow": "/Demo/ParallelExecution/demo-pwdForkNested", "startTime": "2021-04-14T18:00:14.000+0000", "plannedTime": "2021-04-14T18:00:14.000+0000", "endTime": "2021-04-14T18:00:47.000+0000", "sequence": 0, "state": { "severity": 6, "_text": "SUCCESSFUL" }, "orderState": { "severity": 6, "_text": "FINISHED" }, "historyId": 1, "children": [] }] }
{
"deliveryDate": "2021-04-16T22:05:28.245+0000",
"history": [{
"surveyDate": "2021-04-16T20:12:47.000+0000",
"controllerId": "controller",
"orderId": "#2021-04-16#P0000000004-schedule24",
"workflow": "/Demo/MutualExclusion/demo1-pdlSharedLockSerial_002",
"startTime": "2021-04-16T20:12:02.000+0000",
"plannedTime": "2021-04-16T20:12:02.000+0000",
"endTime": "2021-04-16T20:12:46.000+0000",
"sequence": 0,
"state": {
"severity": 6,
"_text": "SUCCESSFUL"
},
"orderState": {
"severity": 6,
"_text": "FINISHED"
},
"historyId": 29,
"children": []
}, {
"surveyDate": "2021-04-15T20:12:23.000+0000",
"controllerId": "controller",
"orderId": "#2021-04-15#P0000000003-demoPdwForm",
"workflow": "/Demo/ParallelExecution/demo-pdwFork",
"startTime": "2021-04-15T20:12:00.000+0000",
"plannedTime": "2021-04-15T20:12:00.000+0000",
"endTime": "2021-04-15T20:12:22.000+0000",
"sequence": 0,
"state": {
"severity": 6,
"_text": "SUCCESSFUL"
},
"orderState": {
"severity": 6,
"_text": "FINISHED"
},
"historyId": 26,
"children": []
}, {
"surveyDate": "2021-04-14T20:22:42.000+0000",
"controllerId": "controller",
"orderId": "#2021-04-14#P0000000001-pdfExclusive",
"workflow": "/Demo/MutualExclusion/demo1-pdlExclusiveLockSerial_002",
"startTime": "2021-04-14T20:22:00.000+0000",
"plannedTime": "2021-04-14T20:22:00.000+0000",
"endTime": "2021-04-14T20:22:41.000+0000",
"sequence": 0,
"state": {
"severity": 6,
"_text": "SUCCESSFUL"
},
"orderState": {
"severity": 6,
"_text": "FINISHED"
},
"historyId": 23,
"children": []
}, {
"surveyDate": "2021-04-14T18:00:50.000+0000",
"controllerId": "controller",
"orderId": "#2021-04-14#T8423216948-root",
"workflow": "/Demo/ParallelExecution/demo-pwdForkNested",
"startTime": "2021-04-14T18:00:17.000+0000",
"plannedTime": "2021-04-14T18:00:17.000+0000",
"endTime": "2021-04-14T18:00:49.000+0000",
"sequence": 0,
"state": {
"severity": 6,
"_text": "SUCCESSFUL"
},
"orderState": {
"severity": 6,
"_text": "FINISHED"
},
"historyId": 2,
"children": []
}, {
"surveyDate": "2021-04-14T18:00:48.000+0000",
"controllerId": "controller",
"orderId": "#2021-04-14#T8423212514-root",
"workflow": "/Demo/ParallelExecution/demo-pwdForkNested",
"startTime": "2021-04-14T18:00:14.000+0000",
"plannedTime": "2021-04-14T18:00:14.000+0000",
"endTime": "2021-04-14T18:00:47.000+0000",
"sequence": 0,
"state": {
"severity": 6,
"_text": "SUCCESSFUL"
},
"orderState": {
"severity": 6,
"_text": "FINISHED"
},
"historyId": 1,
"children": []
}]
}
|
433 |
4-eyes principle: Forbidden! The user needs approval process for 'history' |
|
application/json
model |
example
{
"title": "FourEyesResponse",
"$schema": "http://json-schema.org/draft-04/schema#",
"javaType": "com.sos.joc.model.security.foureyes.FourEyesResponse",
"type": "object",
"extends": {
"javaType": "com.sos.joc.model.security.foureyes.ApprovalBase",
"type": "object",
"properties": {
"requestor": {
"type": "string",
"pattern": "^[^<>]*$",
"maxLength": 255,
"minLength": 1
},
"requestUrl": {
"type": "string",
"pattern": "^[^<>]*$",
"maxLength": 255,
"minLength": 1
},
"requestBody": {
"type": "object",
"javaType": "com.sos.joc.model.security.foureyes.RequestBody",
"additionalProperties": true
},
"category": {
"javaType": "com.sos.joc.model.audit.CategoryType",
"type": "string",
"enum": [
"INVENTORY",
"CONTROLLER",
"DAILYPLAN",
"OTHERS",
"DEPLOYMENT",
"DOCUMENTATIONS",
"CERTIFICATES",
"IDENTITY",
"SETTINGS",
"MONITORING",
"UNKNOWN"
]
}
},
"additionalProperties": false
},
"properties": {
"deliveryDate": {
"description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty",
"type": "string",
"format": "date-time"
},
"message": {
"type": "string",
"pattern": "^[^<>]*$",
"maxLength": 255,
"minLength": 1
},
"approvers": {
"type": "array",
"items": {
"javaType": "com.sos.joc.model.security.foureyes.Approver",
"type": "object",
"required": [
"accountName",
"firstName",
"lastName"
],
"properties": {
"accountName": {
"type": "string",
"pattern": "^[^<>]*$",
"maxLength": 255,
"minLength": 1
},
"firstName": {
"type": "string",
"pattern": "^[^<>]*$",
"maxLength": 30,
"minLength": 1
},
"lastName": {
"type": "string",
"pattern": "^[^<>]*$",
"maxLength": 30,
"minLength": 1
},
"email": {
"type": "string",
"pattern": "^[^<>]*$",
"maxLength": 255
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
}
{ "deliveryDate": "2025-05-12T21:13:35Z", "accountName": "user1", "request": "./orders/add", "requestBody": { "controllerId": "standalone", "orders": [{ "workflowPath": "myWorkflow", "scheduledFor": "now" }] }, "category": "CONTROLLER", "objectType": "WORKFLOW" "objectName": "myWorkflow", "numOfObjects": 1, "action": "add orders" }
{
"deliveryDate": "2025-05-12T21:13:35Z",
"accountName": "user1",
"request": "./orders/add",
"requestBody": {
"controllerId": "standalone",
"orders": [{
"workflowPath": "myWorkflow",
"scheduledFor": "now"
}]
},
"category": "CONTROLLER",
"objectType": "WORKFLOW"
"objectName": "myWorkflow",
"numOfObjects": 1,
"action": "add orders"
}
|