diff --git a/docs-kits/kits/OSim Kit/OSim-Product-Documentation-EN.pdf b/docs-kits/kits/OSim Kit/OSim-Product-Documentation-EN.pdf new file mode 100755 index 00000000000..191ddc49805 Binary files /dev/null and b/docs-kits/kits/OSim Kit/OSim-Product-Documentation-EN.pdf differ diff --git a/docs-kits/kits/OSim Kit/Software Development View/01-osim-api.info.mdx b/docs-kits/kits/OSim Kit/Software Development View/01-osim-api.info.mdx index 0e0641e9c62..8749caa52b1 100644 --- a/docs-kits/kits/OSim Kit/Software Development View/01-osim-api.info.mdx +++ b/docs-kits/kits/OSim Kit/Software Development View/01-osim-api.info.mdx @@ -1,7 +1,7 @@ --- id: osim-api title: "OSim API" -description: "Osim API for requesting and receiving simulation results as well as for interactions related to scenario management." +description: "OSim API for requesting and receiving simulation results" sidebar_label: Introduction sidebar_position: 0 hide_title: true @@ -13,10 +13,13 @@ import Tabs from "@theme/Tabs"; import TabItem from "@theme/TabItem"; import Export from "@theme/ApiDemoPanel/Export"; - - Version: 2.0.0 - +Version: 3.0.0 # OSim API -OSim API for requesting and receiving simulation results as well as for interactions related to scenario management. + + +OSim API for requesting and receiving simulation results + + + \ No newline at end of file diff --git a/docs-kits/kits/OSim Kit/Software Development View/02-page_software-development-view.md b/docs-kits/kits/OSim Kit/Software Development View/02-page_software-development-view.md index 4a8342f4b95..024639da235 100644 --- a/docs-kits/kits/OSim Kit/Software Development View/02-page_software-development-view.md +++ b/docs-kits/kits/OSim Kit/Software Development View/02-page_software-development-view.md @@ -16,47 +16,59 @@ The following example shows the payload used for exchange of simulation results ```json { - "owner": { "id": "BPNL00000007OTZ3" }, - "dataQuality": 1, - "description": "Daily standard simulation", - "comment": "successful simulation", - "expirationTimestamp": "2023-03-24T09:15:24.000Z", - "runId": "0fece48b-c8d1-4180-1a9caca6d67e", - "shipments": [ - { - "handlingUnits": [ - { - "name": "Palette", - "volume": 1, - "weight": 189, - "batches": [ - { - "unitOfMeasurement": "KG", - "materialName": "KK1000GR-Gehäuse-Rot", - "quantity": 50, - "materialNumber": "KK1000GR", - "batchOrderId": "Order-0001", - "batchId": "Batch_1", - "hazardousGoods": false, - "batchExpirationTimestamp": "2023-08-22T16:00:00.000Z", - "batchNumber": "45" - } - ], - "handlingUnitId": "HUT_1", - "amount": 1 - } - ], - "shipmentId": "DE51515151", - "recipientTimestampPlanned": "2023-04-19T09:00:00.000Z", - "destination": { "id": "BPNL00000007OTZ3" }, - "recipient": { "id": "BPNL00000007OTZ4" }, - "logistics": { "id": "BPNL00000007OS0H" }, - "preceding": {}, - "splittingAllowed": true, - "destinationTimestamp": "2023-03-19T09:00:00.000Z" - } - ], - "timestamp": "2023-03-09T14:13:42.806Z" + "materialFlowSimulationResult": { + "owner": { + "bpnsProperty": "BPNS0123456789ZZ" + }, + "dataQuality": 0, + "description": "Please simulate asap", + "comment": "successful simulation ", + "expirationTimestamp": "2023-03-24T09:15:24.000Z", + "runId": "0fece48b-c8d1-4180-1a9caca6d67e", + "shipments": [ + { + "handlingUnits": [ + { + "name": "Palette", + "volume": 1, + "weight": 189, + "batches": [ + { + "unitOfMeasurement": "KG", + "materialName": "KK1000GR-Gehäuse-Rot", + "quantity": 0, + "materialNumber": "KK1000GR", + "materialHazardousGoods": false, + "batchSerialNumber": "Batch_1", + "batchOrderId": "Order-0001", + "batchExpirationTimestamp": "2023-08-22T16:00:00.000Z", + "batchNumber": "45" + } + ], + "handlingUnitId": "HUT_1", + "amount": 1 + } + ], + "shipmentId": "DE51515151", + "recipientTimestampPlanned": "2023-04-19T09:00:00.000Z", + "destination": { + "bpnsProperty": "BPNS0123456789ZZ" + }, + "recipient": { + "bpnsProperty": "BPNS0123456789ZZ" + }, + "logistics": { + "bpnsProperty": "BPNS0123456789ZZ" + }, + "preceding": { + "bpnsProperty": "BPNS0123456789ZZ" + }, + "splittingAllowed": true, + "destinationTimestamp": "2023-03-19T09:00:00.000Z" + } + ], + "timestamp": "2023-03-09T14:13:42.806Z" + } } ``` @@ -70,10 +82,12 @@ The following example shows the payload used for exchange of scenario data betwe "scenarioSimResults": { "resultOwnId": "916b5688-8bd8-4d7e-83b9-e0d40939274e", "resultOwnSimRunInitial": { - "owner": {}, + "owner": { + "bpnsProperty": "BPNS0123456789ZZ" + }, "dataQuality": 0, "description": "Please simulate asap", - "comment": "successful simulation", + "comment": "successful simulation ", "expirationTimestamp": "2023-03-24T09:15:24.000Z", "runId": "0fece48b-c8d1-4180-1a9caca6d67e", "shipments": [ @@ -81,17 +95,17 @@ The following example shows the payload used for exchange of scenario data betwe "handlingUnits": [ { "name": "Palette", - "volume": 1.0, - "weight": 189.0, + "volume": 1, + "weight": 189, "batches": [ { "unitOfMeasurement": "KG", "materialName": "KK1000GR-Gehäuse-Rot", - "quantity": 50.0, + "quantity": 0, "materialNumber": "KK1000GR", "materialHazardousGoods": false, + "batchSerialNumber": "Batch_1", "batchOrderId": "Order-0001", - "batchId": "Batch_1", "batchExpirationTimestamp": "2023-08-22T16:00:00.000Z", "batchNumber": "45" } @@ -102,10 +116,18 @@ The following example shows the payload used for exchange of scenario data betwe ], "shipmentId": "DE51515151", "recipientTimestampPlanned": "2023-04-19T09:00:00.000Z", - "destination": {}, - "recipient": {}, - "logistics": {}, - "preceding": {}, + "destination": { + "bpnsProperty": "BPNS0123456789ZZ" + }, + "recipient": { + "bpnsProperty": "BPNS0123456789ZZ" + }, + "logistics": { + "bpnsProperty": "BPNS0123456789ZZ" + }, + "preceding": { + "bpnsProperty": "BPNS0123456789ZZ" + }, "splittingAllowed": true, "destinationTimestamp": "2023-03-19T09:00:00.000Z" } @@ -113,10 +135,12 @@ The following example shows the payload used for exchange of scenario data betwe "timestamp": "2023-03-09T14:13:42.806Z" }, "resultOwnSimRunUpdated": { - "owner": {}, + "owner": { + "bpnsProperty": "BPNS0123456789ZZ" + }, "dataQuality": 0, "description": "Please simulate asap", - "comment": "successful simulation", + "comment": "successful simulation ", "expirationTimestamp": "2023-03-24T09:15:24.000Z", "runId": "0fece48b-c8d1-4180-1a9caca6d67e", "shipments": [ @@ -124,17 +148,17 @@ The following example shows the payload used for exchange of scenario data betwe "handlingUnits": [ { "name": "Palette", - "volume": 1.0, - "weight": 189.0, + "volume": 1, + "weight": 189, "batches": [ { "unitOfMeasurement": "KG", "materialName": "KK1000GR-Gehäuse-Rot", - "quantity": 50.0, + "quantity": 0, "materialNumber": "KK1000GR", "materialHazardousGoods": false, + "batchSerialNumber": "Batch_1", "batchOrderId": "Order-0001", - "batchId": "Batch_1", "batchExpirationTimestamp": "2023-08-22T16:00:00.000Z", "batchNumber": "45" } @@ -145,10 +169,18 @@ The following example shows the payload used for exchange of scenario data betwe ], "shipmentId": "DE51515151", "recipientTimestampPlanned": "2023-04-19T09:00:00.000Z", - "destination": {}, - "recipient": {}, - "logistics": {}, - "preceding": {}, + "destination": { + "bpnsProperty": "BPNS0123456789ZZ" + }, + "recipient": { + "bpnsProperty": "BPNS0123456789ZZ" + }, + "logistics": { + "bpnsProperty": "BPNS0123456789ZZ" + }, + "preceding": { + "bpnsProperty": "BPNS0123456789ZZ" + }, "splittingAllowed": true, "destinationTimestamp": "2023-03-19T09:00:00.000Z" } @@ -156,24 +188,27 @@ The following example shows the payload used for exchange of scenario data betwe "timestamp": "2023-03-09T14:13:42.806Z" } }, - "scenarioParameter": { - "unitOfMeasurement": "KG", - "parameterScenario": "8d464b8b-6977-4952-8a22-0489067ca081", - "parameterComment": "updated Delivery Date", - "materialName": "KK1000GR-Gehäuse-Rot", - "parameterQuantityUpdated": 1.0, - "parameterId": "847c71e5-614a-468b-a3a0-674bf2af3004", - "materialNumber": "KK1000GR", - "parameterDeliveryDateUpdated": "2023-10-10T09:00:00.000Z", - "parameterDeliveryDateInitial": "2023-10-09T10:00:00.000Z", - "parameterOrderId": "OID-011123456", - "parameterQuantityInitial": 1.0 - }, + "scenarioParameter": [ + { + "unitOfMeasurement": "KG", + "parameterComment": "updated Delivery Date", + "materialName": "KK1000GR-Gehäuse-Rot", + "parameterQuantityUpdated": 1, + "parameterId": "847c71e5-614a-468b-a3a0-674bf2af3004", + "materialNumber": "KK1000GR", + "parameterDeliveryDateUpdated": "2023-10-10T09:00:00.000Z", + "parameterDeliveryDateInitial": "2023-10-09T10:00:00.000Z", + "parameterOrderId": "OID-011123546", + "parameterQuantityInitial": 1 + } + ], "scenarioHeader": { "scenarioOwnerRole": "Customer", "scenarioCreationTimestamp": "2023-10-04T09:10:00.000Z", "scenarioExpirationTimestamp": "2023-10-07T09:10:00.000Z", - "scenarioOwner": "BPNL0000007OTZ3", + "scenarioOwner": { + "bpnsProperty": "BPNS0123456789ZZ" + }, "scenarioDescription": "Changes in Delivery Date", "scenarioId": "8d464b8b-6977-4952-8a22-0489067ca081", "scenarioTitle": "Delivery Modification" diff --git a/docs-kits/kits/OSim Kit/Software Development View/03-request-latest-simulation-result.api.mdx b/docs-kits/kits/OSim Kit/Software Development View/03-request-latest-simulation-result.api.mdx index 5b864ed924a..54bb3c43705 100644 --- a/docs-kits/kits/OSim Kit/Software Development View/03-request-latest-simulation-result.api.mdx +++ b/docs-kits/kits/OSim Kit/Software Development View/03-request-latest-simulation-result.api.mdx @@ -5,7 +5,7 @@ description: "Request latest simulation result by referring the latest simulatio sidebar_label: "requestLatestSimulationResult" hide_title: true hide_table_of_contents: true -api: {"tags":["requestLatestSimulationResult"],"operationId":"requestLatestSimulationResult","description":"Request latest simulation result by referring the latest simulation run id available in own OSim Manager","parameters":[{"name":"requestId","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"},"example":"8d628899-3e6f-4666-91c3-74ee7ab88b2b"},{"name":"bpns","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"},"example":"BPNS00000007OTZ3"},{"name":"simulationRunId","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"},"example":"50737df3-4237-4652-b092-1ef8649f6ca6"}],"responses":{"200":{"description":"OK","content":{"text":{"schema":{"type":"string","example":"The request has succeeded. The requestLatestSimulationResult has been successfully processed in the backend system."}}}},"400":{"description":"Bad request","content":{"text":{"schema":{"type":"string","example":"The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing)."}}}},"401":{"description":"Unauthorized","content":{"text":{"schema":{"type":"string","example":"Although the HTTP standard specifies \"unauthorized\", semantically this response means \"unauthenticated\". That is, the client must authenticate itself to get the requested response."}}}},"402":{"description":"Unknown BPNS","content":{"text":{"schema":{"type":"string","example":"The BPNS which is given as parameter is not registered in the data provider database as a direct partner."}}}},"403":{"description":"Forbidden","content":{"text":{"schema":{"type":"string","example":"The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource."}}}},"404":{"description":"No simulation results are released","content":{"text":{"schema":{"type":"string","example":"Data provider doesn’t have any released simulation results"}}}},"405":{"description":"Method not allowed","content":{"text":{"schema":{"type":"string","example":"The method used to request the data was not GET"}}}},"406":{"description":"No newer simulation available","content":{"text":{"schema":{"type":"string","example":"The simulationRunId which is given as parameter is identical to the currently released simulation run in the data provider database"}}}},"407":{"description":"No shipments planned","content":{"text":{"schema":{"type":"string","example":"No shipments are currently planned for the requestor"}}}},"500":{"description":"Internal server error","content":{"text":{"schema":{"type":"string","example":"The server has encountered a situation it does not know how to handle."}}}},"501":{"description":"Service unavailable","content":{"text":{"schema":{"type":"string","example":"The server is not ready to handle the request."}}}}},"servers":[{"url":"https://{server-url}"}],"method":"get","path":"/api/requestLatestSimulationResult/bpns/{bpns}/requestId/{requestId}/simulationRunId/{simulationRunId}","info":{"title":"OSim API","description":"Osim API for requesting and receiving simulation results as well as for interactions related to scenario management.","version":"2.0.0"},"postman":{"name":"request Latest Simulation Result","description":{"content":"Request latest simulation result by referring the latest simulation run id available in own OSim Manager","type":"text/plain"},"url":{"path":["api","requestLatestSimulationResult","bpns",":bpns","requestId",":requestId","simulationRunId",":simulationRunId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"requestId"},{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"bpns"},{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"simulationRunId"}]},"header":[{"key":"Accept","value":"text"}],"method":"GET"}} +api: {"operationId":"requestLatestSimulationResult","tags":["requestLatestSimulationResult"],"description":"Request latest simulation result by referring the latest simulation run id available in own OSim Manager","parameters":[{"name":"requestId","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"},"example":"8d628899-3e6f-4666-91c3-74ee7ab88b2b"},{"name":"bpns","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"},"example":"BPNS00000007OTZ3"},{"name":"simulationRunId","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"},"example":"50737df3-4237-4652-b092-1ef8649f6ca6"}],"responses":{"200":{"description":"OK","content":{"text":{"schema":{"type":"string","example":"The request has succeeded. The requestLatestSimulationResult has been successfully processed in the backend system."}}}},"400":{"description":"Bad request","content":{"text":{"schema":{"type":"string","example":"The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing)."}}}},"401":{"description":"Unauthorized","content":{"text":{"schema":{"type":"string","example":"Although the HTTP standard specifies \"unauthorized\", semantically this response means \"unauthenticated\". That is, the client must authenticate itself to get the requested response."}}}},"402":{"description":"Unknown BPNS","content":{"text":{"schema":{"type":"string","example":"The BPNS which is given as parameter is not registered in the data provider database as a direct partner."}}}},"403":{"description":"Forbidden","content":{"text":{"schema":{"type":"string","example":"The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource."}}}},"404":{"description":"No simulation results are released","content":{"text":{"schema":{"type":"string","example":"Data provider doesn’t have any released simulation results"}}}},"405":{"description":"Method not allowed","content":{"text":{"schema":{"type":"string","example":"The method used to request the data was not GET"}}}},"406":{"description":"No newer simulation available","content":{"text":{"schema":{"type":"string","example":"The simulationRunId which is given as parameter is identical to the currently released simulation run in the data provider database"}}}},"407":{"description":"No shipments planned","content":{"text":{"schema":{"type":"string","example":"No shipments are currently planned for the requestor"}}}},"500":{"description":"Internal server error","content":{"text":{"schema":{"type":"string","example":"The server has encountered a situation it does not know how to handle."}}}},"501":{"description":"Service unavailable","content":{"text":{"schema":{"type":"string","example":"The server is not ready to handle the request."}}}}},"servers":[{"url":"https://{server-url}"}],"method":"get","path":"/api/requestLatestSimulationResult/bpns/{bpns}/requestId/{requestId}/simulationRunId/{simulationRunId}","info":{"title":"OSim API","description":"OSim API for requesting and receiving simulation results","version":"3.0.0"},"postman":{"name":"request Latest Simulation Result","description":{"content":"Request latest simulation result by referring the latest simulation run id available in own OSim Manager","type":"text/plain"},"url":{"path":["api","requestLatestSimulationResult","bpns",":bpns","requestId",":requestId","simulationRunId",":simulationRunId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"requestId"},{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"bpns"},{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"simulationRunId"}]},"header":[{"key":"Accept","value":"text"}],"method":"GET"}} sidebar_class_name: "get api-method" info_path: docs-kits/kits/OSim Kit/Software Development View//osim-api custom_edit_url: null diff --git a/docs-kits/kits/OSim Kit/Software Development View/04-receive-latest-simulation-result.api.mdx b/docs-kits/kits/OSim Kit/Software Development View/04-receive-latest-simulation-result.api.mdx index c2c20ba6240..2b005630c28 100644 --- a/docs-kits/kits/OSim Kit/Software Development View/04-receive-latest-simulation-result.api.mdx +++ b/docs-kits/kits/OSim Kit/Software Development View/04-receive-latest-simulation-result.api.mdx @@ -5,7 +5,7 @@ description: "Receive latest simulation result which can be stored in own OSim M sidebar_label: "receiveLatestSimulationResult" hide_title: true hide_table_of_contents: true -api: {"tags":["receiveLatestSimulationResult"],"description":"Receive latest simulation result which can be stored in own OSim Manager instance","operationId":"receiveLatestSimulationResult","parameters":[{"name":"requestId","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"},"example":"8d628899-3e6f-4666-91c3-74ee7ab88b2b"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"owner":{"type":"object","properties":{"id":{"type":"string"}}},"dataQuality":{"type":"integer"},"description":{"type":"string"},"comment":{"type":"string"},"expirationTimestamp":{"type":"string"},"runId":{"type":"string"},"shipments":{"type":"array","items":{"type":"object","properties":{"handlingUnits":{"type":"array","items":{"type":"object","properties":{"volume":{"type":"integer"},"batches":{"type":"array","items":{"type":"object","properties":{"unitOfMeasurement":{"type":"string"},"materialName":{"type":"string"},"quantity":{"type":"integer"},"materialNumber":{"type":"string"},"batchOrderId":{"type":"string"},"batchId":{"type":"string"},"hazardousGoods":{"type":"boolean"},"batchExpirationTimestamp":{"type":"string"},"batchNumber":{"type":"string"}}}},"handlingUnitId":{"type":"string"},"amount":{"type":"integer"},"name":{"type":"string"},"weight":{"type":"integer"}}}},"shipmentId":{"type":"string"},"recipientTimestampPlanned":{"type":"string"},"destination":{"type":"object","properties":{"id":{"type":"string"}}},"recipient":{"type":"object","properties":{"id":{"type":"string"}}},"logistics":{"type":"object","properties":{"id":{"type":"string"}}},"preceding":{"type":"object","properties":{}},"splittingAllowed":{"type":"boolean"},"destinationTimestamp":{"type":"string"}}}},"timestamp":{"type":"string"}}},"examples":{"0":{"value":"{ \n \"owner\": { \"id\": \"BPNS00000007OTZ3\" }, \n \"dataQuality\": 1, \n \"description\": \"Daily standard simulation\", \n \"comment\": \"successful simulation\", \n \"expirationTimestamp\": \"2023-03-24T09:15:24.000Z\", \n \"runId\": \"0fece48b-c8d1-4180-1a9caca6d67e\", \n \"shipments\": [ \n { \n \"handlingUnits\": [ \n { \n \"name\": \"Palette\", \n \"volume\": 1, \n \"weight\": 189, \n \"batches\": [ \n { \n \"unitOfMeasurement\": \"KG\", \n \"materialName\": \"KK1000GR-Gehäuse-Rot\", \n \"quantity\": 50, \n \"materialNumber\": \"KK1000GR\", \n \"batchOrderId\": \"Order-0001\", \n \"batchId\": \"Batch_1\", \n \"hazardousGoods\": false, \n \"batchExpirationTimestamp\": \"2023-08-22T16:00:00.000Z\", \n \"batchNumber\": \"45\" \n } \n ], \n \"handlingUnitId\": \"HUT_1\", \n \"amount\": 1 \n } \n ], \n \"shipmentId\": \"DE51515151\", \n \"recipientTimestampPlanned\": \"2023-04-19T09:00:00.000Z\", \n \"destination\": { \"id\": \"BPNS00000007OTZ3\" }, \n \"recipient\": { \"id\": \"BPNS00000007OTZ4\" }, \n \"logistics\": { \"id\": \"BPNS00000007OS0H\" }, \n \"preceding\": {}, \n \"splittingAllowed\": true, \n \"destinationTimestamp\": \"2023-03-19T09:00:00.000Z\" \n } \n ], \n \"timestamp\": \"2023-03-09T14:13:42.806Z\" \n}"}}}}},"responses":{"200":{"description":"OK","content":{"text":{"schema":{"type":"string","example":"The POST has succeeded. The receiveLatestSimulationResult has been successfully processed in the backend system."}}}},"400":{"description":"Bad request","content":{"text":{"schema":{"type":"string","example":"The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing)."}}}},"401":{"description":"Unauthorized","content":{"text":{"schema":{"type":"string","example":"Although the HTTP standard specifies \"unauthorized\", semantically this response means \"unauthenticated\". That is, the client must authenticate itself to get the requested response."}}}},"402":{"description":"Payload is empty","content":{"text":{"schema":{"type":"string","example":"The payload of the API call is empty."}}}},"403":{"description":"Forbidden","content":{"text":{"schema":{"type":"string","example":"The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource."}}}},"404":{"description":"Payload structure unknown","content":{"text":{"schema":{"type":"string","example":"The payload structure is unknown or correspond not to the defined semantic model"}}}},"405":{"description":"Method not allowed","content":{"text":{"schema":{"type":"string","example":"The method used to receive the data was not POST"}}}},"406":{"description":"Payload content invalid","content":{"text":{"schema":{"type":"string","example":"The content of the payload is invalid. E.g. “owner unknown”"}}}},"500":{"description":"Internal server error","content":{"text":{"schema":{"type":"string","example":"The server has encountered a situation it does not know how to handle."}}}},"501":{"description":"Service unavailable","content":{"text":{"schema":{"type":"string","example":"The server is not ready to handle the request."}}}}},"servers":[{"url":"https://{server-url}"}],"method":"post","path":"/api/receiveLatestSimulationResult/requestId/{requestId}","jsonRequestBodyExample":{"owner":{"id":"string"},"dataQuality":0,"description":"string","comment":"string","expirationTimestamp":"string","runId":"string","shipments":[{"handlingUnits":[{"volume":0,"batches":[{"unitOfMeasurement":"string","materialName":"string","quantity":0,"materialNumber":"string","batchOrderId":"string","batchId":"string","hazardousGoods":true,"batchExpirationTimestamp":"string","batchNumber":"string"}],"handlingUnitId":"string","amount":0,"name":"string","weight":0}],"shipmentId":"string","recipientTimestampPlanned":"string","destination":{"id":"string"},"recipient":{"id":"string"},"logistics":{"id":"string"},"preceding":{},"splittingAllowed":true,"destinationTimestamp":"string"}],"timestamp":"string"},"info":{"title":"OSim API","description":"Osim API for requesting and receiving simulation results as well as for interactions related to scenario management.","version":"2.0.0"},"postman":{"name":"receive Latest Simulation Result","description":{"content":"Receive latest simulation result which can be stored in own OSim Manager instance","type":"text/plain"},"url":{"path":["api","receiveLatestSimulationResult","requestId",":requestId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"requestId"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +api: {"tags":["receiveLatestSimulationResult"],"description":"Receive latest simulation result which can be stored in own OSim Manager instance","operationId":"receiveLatestSimulationResult","parameters":[{"name":"requestId","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"},"example":"8d628899-3e6f-4666-91c3-74ee7ab88b2b"}],"requestBody":{"content":{"application/json":{"schema":{"required":["comment","dataQuality","description","expirationTimestamp","owner","runId","shipments","timestamp"],"type":"object","properties":{"description":{"type":"string","description":"Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc.","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#Text"},"runId":{"type":"string","description":"Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc.","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#Text"},"comment":{"type":"string","description":"Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc.","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#Text"},"expirationTimestamp":{"pattern":"-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T(([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\\.[0-9]+)?|(24:00:00(\\.0+)?))(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?","type":"string","description":"Describes a Property which contains the date and time with an optional timezone.","x-samm-aspect-model-urn":"urn:samm:org.eclipse.esmf.samm:characteristic:2.1.0#Timestamp"},"owner":{"type":"object","description":"Site identifier of the simulation originator","allOf":[{"required":["bpnsProperty"],"type":"object","properties":{"bpnsProperty":{"pattern":"^BPNS[a-zA-Z0-9]{12}$","type":"string","description":"The provided regular expression ensures that the BPNS is composed of prefix 'BPNS', 10 digits and two alphanumeric letters.","x-samm-aspect-model-urn":"urn:samm:io.catenax.shared.business_partner_number:2.0.0#BpnsTrait"}},"description":"Characteristic describing the Scenario Owner","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_scenario_request:2.0.0#ScenarioOwnerCharacteristic"}],"x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#OwnerCharacteristic"},"dataQuality":{"minimum":0,"type":"number","description":"Possible values determining data quality","enum":[0,1,2,3,4,5],"x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#DataQualityOptions"},"shipments":{"type":"array","description":"List of shipments contained in the simulation","items":{"required":["destination","destinationTimestamp","handlingUnits","logistics","preceding","recipient","recipientTimestampPlanned","shipmentId","splittingAllowed"],"type":"object","properties":{"shipmentId":{"type":"string","description":"Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc.","x-samm-aspect-model-urn":"urn:samm:org.eclipse.esmf.samm:characteristic:2.1.0#Text"},"destination":{"type":"object","description":"Address where the shipment is immediately delivered to (by logistician) or provided for pickup (by producer)","allOf":[{"required":["bpnsProperty"],"type":"object","properties":{"bpnsProperty":{"pattern":"^BPNS[a-zA-Z0-9]{12}$","type":"string","description":"The provided regular expression ensures that the BPNS is composed of prefix 'BPNS', 10 digits and two alphanumeric letters.","x-samm-aspect-model-urn":"urn:samm:io.catenax.shared.business_partner_number:2.0.0#BpnsTrait"}},"description":"Characteristic describing the Scenario Owner","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_scenario_request:2.0.0#ScenarioOwnerCharacteristic"}],"x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#DestinationCharacteristic"},"destinationTimestamp":{"pattern":"-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T(([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\\.[0-9]+)?|(24:00:00(\\.0+)?))(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?","type":"string","description":"Describes a Property which contains the date and time with an optional timezone.","x-samm-aspect-model-urn":"urn:samm:org.eclipse.esmf.samm:characteristic:2.1.0#Timestamp"},"recipient":{"type":"object","description":"Location identifier of the final recipient of the shipment","allOf":[{"required":["bpnsProperty"],"type":"object","properties":{"bpnsProperty":{"pattern":"^BPNS[a-zA-Z0-9]{12}$","type":"string","description":"The provided regular expression ensures that the BPNS is composed of prefix 'BPNS', 10 digits and two alphanumeric letters.","x-samm-aspect-model-urn":"urn:samm:io.catenax.shared.business_partner_number:2.0.0#BpnsTrait"}},"description":"Characteristic describing the Scenario Owner","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_scenario_request:2.0.0#ScenarioOwnerCharacteristic"}],"x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#RecipientCharacteristic"},"recipientTimestampPlanned":{"pattern":"-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T(([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\\.[0-9]+)?|(24:00:00(\\.0+)?))(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?","type":"string","description":"Describes a Property which contains the date and time with an optional timezone.","x-samm-aspect-model-urn":"urn:samm:org.eclipse.esmf.samm:characteristic:2.1.0#Timestamp"},"splittingAllowed":{"type":"boolean","description":"Represents a boolean value (i.e. a \"flag\").","x-samm-aspect-model-urn":"urn:samm:org.eclipse.esmf.samm:characteristic:2.1.0#Boolean"},"logistics":{"type":"object","description":"Site identifier of the logistician executing the shipment","allOf":[{"required":["bpnsProperty"],"type":"object","properties":{"bpnsProperty":{"pattern":"^BPNS[a-zA-Z0-9]{12}$","type":"string","description":"The provided regular expression ensures that the BPNS is composed of prefix 'BPNS', 10 digits and two alphanumeric letters.","x-samm-aspect-model-urn":"urn:samm:io.catenax.shared.business_partner_number:2.0.0#BpnsTrait"}},"description":"Characteristic describing the Scenario Owner","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_scenario_request:2.0.0#ScenarioOwnerCharacteristic"}],"x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#LogisticsCharacteristic"},"preceding":{"type":"object","description":"Reference of preceding shipments","allOf":[{"required":["bpnsProperty"],"type":"object","properties":{"bpnsProperty":{"pattern":"^BPNS[a-zA-Z0-9]{12}$","type":"string","description":"The provided regular expression ensures that the BPNS is composed of prefix 'BPNS', 10 digits and two alphanumeric letters.","x-samm-aspect-model-urn":"urn:samm:io.catenax.shared.business_partner_number:2.0.0#BpnsTrait"}},"description":"Characteristic describing the Scenario Owner","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_scenario_request:2.0.0#ScenarioOwnerCharacteristic"}],"x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#PrecedingCharacteristic"},"handlingUnits":{"type":"array","description":"List of handling units included in the shipment","items":{"required":["amount","batches","handlingUnitId","name","volume","weight"],"type":"object","properties":{"handlingUnitId":{"type":"string","description":"Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc.","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#Text"},"name":{"type":"string","description":"Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc.","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#Text"},"volume":{"type":"number","description":"Volumetric value determining the volume of the handling unit","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#VolumeCharacteristic"},"weight":{"type":"number","description":"Amount of weight of the handling unit","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#WeightCharacteristic"},"amount":{"minimum":1,"type":"number","description":"Number describing handling units with identical pieces","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#AmountCharacteristic"},"batches":{"type":"array","description":"List of material batches","items":{"required":["batchExpirationTimestamp","batchNumber","batchOrderId","batchSerialNumber","materialHazardousGoods","materialName","materialNumber","quantity","unitOfMeasurement"],"type":"object","properties":{"batchSerialNumber":{"type":"string","description":"Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc.","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#Text"},"materialNumber":{"type":"string","description":"Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc.","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#Text"},"materialName":{"type":"string","description":"Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc.","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#Text"},"materialHazardousGoods":{"type":"boolean","description":"Represents a boolean value (i.e. a \"flag\").","x-samm-aspect-model-urn":"urn:samm:org.eclipse.esmf.samm:characteristic:2.1.0#Boolean"},"batchExpirationTimestamp":{"pattern":"-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T(([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\\.[0-9]+)?|(24:00:00(\\.0+)?))(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?","type":"string","description":"Describes a Property which contains the date and time with an optional timezone.","x-samm-aspect-model-urn":"urn:samm:org.eclipse.esmf.samm:characteristic:2.1.0#Timestamp"},"quantity":{"type":"number","description":"Number of materials contained within a handling unit","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#QuantityCharacteristic"},"unitOfMeasurement":{"type":"string","description":"Possible options for units of measurement","enum":["KG","Liter","Piece"],"x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#UnitOfMeasurementCharacteristic"},"batchNumber":{"type":"string","description":"Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc.","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#Text"},"batchOrderId":{"type":"string","description":"Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc.","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#Text"}},"description":"Material Batches are part of a handling unit","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#MaterialBatch"},"x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#BatchList"}},"description":"Handling Unit is the smallest shipment unit and cannot be divided into several shipments","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#HandlingUnit"},"x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#HandlingUnitList"}},"description":"Delivery item from a sender to a recipient containing goods","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#Shipment"},"x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#ShipmentList"},"timestamp":{"pattern":"-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T(([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\\.[0-9]+)?|(24:00:00(\\.0+)?))(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?","type":"string","description":"Describes a Property which contains the date and time with an optional timezone.","x-samm-aspect-model-urn":"urn:samm:org.eclipse.esmf.samm:characteristic:2.1.0#Timestamp"}},"description":"Characteristic describing the property for a Material Flow Simulation Result","example":{"materialFlowSimulationResult":{"owner":{"bpnsProperty":"BPNS0123456789ZZ"},"dataQuality":0,"description":"Please simulate asap","comment":"successful simulation ","expirationTimestamp":"2023-03-24T09:15:24.000Z","runId":"0fece48b-c8d1-4180-1a9caca6d67e","shipments":[{"handlingUnits":[{"name":"Palette","volume":1,"weight":189,"batches":[{"unitOfMeasurement":"KG","materialName":"KK1000GR-Gehäuse-Rot","quantity":50,"materialNumber":"KK1000GR","materialHazardousGoods":false,"batchSerialNumber":"Batch_1","batchOrderId":"Order-0001","batchExpirationTimestamp":"2023-08-22T16:00:00.000Z","batchNumber":"45"}],"handlingUnitId":"HUT_1","amount":1}],"shipmentId":"DE51515151","recipientTimestampPlanned":"2023-04-19T09:00:00.000Z","destination":{"bpnsProperty":"BPNS0123456789ZZ"},"recipient":{"bpnsProperty":"BPNS0123456789ZZ"},"logistics":{"bpnsProperty":"BPNS0123456789ZZ"},"preceding":{"bpnsProperty":"BPNS0123456789ZZ"},"splittingAllowed":true,"destinationTimestamp":"2023-03-19T09:00:00.000Z"}],"timestamp":"2023-03-09T14:13:42.806Z"}},"x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_scenario_request:2.0.0#SimResult"}}}},"responses":{"200":{"description":"OK","content":{"text":{"schema":{"type":"string","example":"The POST has succeeded. The receiveLatestSimulationResult has been successfully processed in the backend system."}}}},"400":{"description":"Bad request","content":{"text":{"schema":{"type":"string","example":"The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing)."}}}},"401":{"description":"Unauthorized","content":{"text":{"schema":{"type":"string","example":"Although the HTTP standard specifies \"unauthorized\", semantically this response means \"unauthenticated\". That is, the client must authenticate itself to get the requested response."}}}},"402":{"description":"Payload is empty","content":{"text":{"schema":{"type":"string","example":"The payload of the API call is empty."}}}},"403":{"description":"Forbidden","content":{"text":{"schema":{"type":"string","example":"The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource."}}}},"404":{"description":"Payload structure unknown","content":{"text":{"schema":{"type":"string","example":"The payload structure is unknown or correspond not to the defined semantic model"}}}},"405":{"description":"Method not allowed","content":{"text":{"schema":{"type":"string","example":"The method used to receive the data was not POST"}}}},"406":{"description":"Payload content invalid","content":{"text":{"schema":{"type":"string","example":"The content of the payload is invalid. E.g. “owner unknown”"}}}},"500":{"description":"Internal server error","content":{"text":{"schema":{"type":"string","example":"The server has encountered a situation it does not know how to handle."}}}},"501":{"description":"Service unavailable","content":{"text":{"schema":{"type":"string","example":"The server is not ready to handle the request."}}}}},"servers":[{"url":"https://{server-url}"}],"method":"post","path":"/api/receiveLatestSimulationResult/requestId/{requestId}","jsonRequestBodyExample":{"materialFlowSimulationResult":{"owner":{"bpnsProperty":"BPNS0123456789ZZ"},"dataQuality":0,"description":"Please simulate asap","comment":"successful simulation ","expirationTimestamp":"2023-03-24T09:15:24.000Z","runId":"0fece48b-c8d1-4180-1a9caca6d67e","shipments":[{"handlingUnits":[{"name":"Palette","volume":1,"weight":189,"batches":[{"unitOfMeasurement":"KG","materialName":"KK1000GR-Gehäuse-Rot","quantity":50,"materialNumber":"KK1000GR","materialHazardousGoods":false,"batchSerialNumber":"Batch_1","batchOrderId":"Order-0001","batchExpirationTimestamp":"2023-08-22T16:00:00.000Z","batchNumber":"45"}],"handlingUnitId":"HUT_1","amount":1}],"shipmentId":"DE51515151","recipientTimestampPlanned":"2023-04-19T09:00:00.000Z","destination":{"bpnsProperty":"BPNS0123456789ZZ"},"recipient":{"bpnsProperty":"BPNS0123456789ZZ"},"logistics":{"bpnsProperty":"BPNS0123456789ZZ"},"preceding":{"bpnsProperty":"BPNS0123456789ZZ"},"splittingAllowed":true,"destinationTimestamp":"2023-03-19T09:00:00.000Z"}],"timestamp":"2023-03-09T14:13:42.806Z"}},"info":{"title":"OSim API","description":"OSim API for requesting and receiving simulation results","version":"3.0.0"},"postman":{"name":"receive Latest Simulation Result","description":{"content":"Receive latest simulation result which can be stored in own OSim Manager instance","type":"text/plain"},"url":{"path":["api","receiveLatestSimulationResult","requestId",":requestId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"requestId"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} sidebar_class_name: "post api-method" info_path: docs-kits/kits/OSim Kit/Software Development View//osim-api custom_edit_url: null @@ -26,7 +26,39 @@ import TabItem from "@theme/TabItem"; Receive latest simulation result which can be stored in own OSim Manager instance -
Path Parameters
Request Body
    owner object
    shipments object[]
    handlingUnits object[]
    batches object[]
    destination object
    recipient object
    logistics object
    preceding object
+
Path Parameters
Request Body
    owner object
    + +Characteristic describing the Scenario Owner + +
    shipments object[] required
    + +List of shipments contained in the simulation + +
    destination object
    + +Characteristic describing the Scenario Owner + +
    recipient object
    + +Characteristic describing the Scenario Owner + +
    logistics object
    + +Characteristic describing the Scenario Owner + +
    preceding object
    + +Characteristic describing the Scenario Owner + +
    handlingUnits object[] required
    + +List of handling units included in the shipment + +
    = 1`"} defaultValue={undefined}>
    batches object[] required
    + +List of material batches + +
OK diff --git a/docs-kits/kits/OSim Kit/Software Development View/05-request-scenario-feedback.api.mdx b/docs-kits/kits/OSim Kit/Software Development View/05-request-scenario-feedback.api.mdx index 99ea43510e0..abca7415abc 100644 --- a/docs-kits/kits/OSim Kit/Software Development View/05-request-scenario-feedback.api.mdx +++ b/docs-kits/kits/OSim Kit/Software Development View/05-request-scenario-feedback.api.mdx @@ -5,7 +5,7 @@ description: "The requestScenarioFeedback is a request from a OSim partner for f sidebar_label: "requestScenarioFeedback" hide_title: true hide_table_of_contents: true -api: {"tags":["requestScenarioFeedback"],"operationId":"requestScenarioFeedback","description":"The requestScenarioFeedback is a request from a OSim partner for feedback on the possible fulfillment of the described scenario.","parameters":[{"name":"bpns","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"},"example":"BPNS00000007OTZ3"}],"requestBody":{"content":{"application/json":{"schema":{"required":["materialFlowScenarioRequest"],"type":"object","properties":{"materialFlowScenarioRequest":{"required":["scenarioHeader","scenarioParameter","scenarioSimResults"],"type":"object","properties":{"scenarioSimResults":{"required":["resultOwnId","resultOwnSimRunInitial","resultOwnSimRunUpdated"],"type":"object","properties":{"resultOwnId":{"type":"string"},"resultOwnSimRunInitial":{"required":["comment","dataQuality","description","expirationTimestamp","owner","runId","shipments","timestamp"],"type":"object","properties":{"owner":{"type":"object"},"dataQuality":{"type":"integer"},"description":{"type":"string"},"comment":{"type":"string"},"expirationTimestamp":{"type":"string"},"runId":{"type":"string"},"shipments":{"type":"array","items":{"required":["destination","destinationTimestamp","handlingUnits","logistics","preceding","recipient","recipientTimestampPlanned","shipmentId","splittingAllowed"],"type":"object","properties":{"handlingUnits":{"type":"array","items":{"required":["amount","batches","handlingUnitId","name","volume","weight"],"type":"object","properties":{"name":{"type":"string"},"volume":{"type":"number"},"weight":{"type":"number"},"batches":{"type":"array","items":{"required":["batchExpirationTimestamp","batchId","batchNumber","batchOrderId","materialHazardousGoods","materialName","materialNumber","quantity","unitOfMeasurement"],"type":"object","properties":{"unitOfMeasurement":{"type":"string"},"materialName":{"type":"string"},"quantity":{"type":"number"},"materialNumber":{"type":"string"},"materialHazardousGoods":{"type":"boolean"},"batchOrderId":{"type":"string"},"batchId":{"type":"string"},"batchExpirationTimestamp":{"type":"string"},"batchNumber":{"type":"string"}}}},"handlingUnitId":{"type":"string"},"amount":{"type":"integer"}}}},"shipmentId":{"type":"string"},"recipientTimestampPlanned":{"type":"string"},"destination":{"type":"object"},"recipient":{"type":"object"},"logistics":{"type":"object"},"preceding":{"type":"object"},"splittingAllowed":{"type":"boolean"},"destinationTimestamp":{"type":"string"}}}},"timestamp":{"type":"string"}}},"resultOwnSimRunUpdated":{"required":["comment","dataQuality","description","expirationTimestamp","owner","runId","shipments","timestamp"],"type":"object","properties":{"owner":{"type":"object"},"dataQuality":{"type":"integer"},"description":{"type":"string"},"comment":{"type":"string"},"expirationTimestamp":{"type":"string"},"runId":{"type":"string"},"shipments":{"type":"array","items":{"required":["destination","destinationTimestamp","handlingUnits","logistics","preceding","recipient","recipientTimestampPlanned","shipmentId","splittingAllowed"],"type":"object","properties":{"handlingUnits":{"type":"array","items":{"required":["amount","batches","handlingUnitId","name","volume","weight"],"type":"object","properties":{"name":{"type":"string"},"volume":{"type":"number"},"weight":{"type":"number"},"batches":{"type":"array","items":{"required":["batchExpirationTimestamp","batchId","batchNumber","batchOrderId","materialHazardousGoods","materialName","materialNumber","quantity","unitOfMeasurement"],"type":"object","properties":{"unitOfMeasurement":{"type":"string"},"materialName":{"type":"string"},"quantity":{"type":"number"},"materialNumber":{"type":"string"},"materialHazardousGoods":{"type":"boolean"},"batchOrderId":{"type":"string"},"batchId":{"type":"string"},"batchExpirationTimestamp":{"type":"string"},"batchNumber":{"type":"string"}}}},"handlingUnitId":{"type":"string"},"amount":{"type":"integer"}}}},"shipmentId":{"type":"string"},"recipientTimestampPlanned":{"type":"string"},"destination":{"type":"object"},"recipient":{"type":"object"},"logistics":{"type":"object"},"preceding":{"type":"object"},"splittingAllowed":{"type":"boolean"},"destinationTimestamp":{"type":"string"}}}},"timestamp":{"type":"string"}}}}},"scenarioParameter":{"required":["materialName","materialNumber","parameterComment","parameterDeliveryDateInitial","parameterDeliveryDateUpdated","parameterId","parameterOrderId","parameterQuantityInitial","parameterQuantityUpdated","parameterScenario","unitOfMeasurement"],"type":"object","properties":{"unitOfMeasurement":{"type":"string"},"parameterScenario":{"type":"string"},"parameterComment":{"type":"string"},"materialName":{"type":"string"},"parameterQuantityUpdated":{"type":"number"},"parameterId":{"type":"string"},"materialNumber":{"type":"string"},"parameterDeliveryDateUpdated":{"type":"string"},"parameterDeliveryDateInitial":{"type":"string"},"parameterOrderId":{"type":"string"},"parameterQuantityInitial":{"type":"number"}}},"scenarioHeader":{"required":["scenarioCreationTimestamp","scenarioDescription","scenarioExpirationTimestamp","scenarioId","scenarioOwner","scenarioOwnerRole","scenarioTitle"],"type":"object","properties":{"scenarioOwnerRole":{"type":"string"},"scenarioCreationTimestamp":{"type":"string"},"scenarioExpirationTimestamp":{"type":"string"},"scenarioOwner":{"type":"string"},"scenarioDescription":{"type":"string"},"scenarioId":{"type":"string"},"scenarioTitle":{"type":"string"}}}}}}},"examples":{"0":{"value":"{\n \"materialFlowScenarioRequest\" : {\n \"scenarioSimResults\" : {\n \"resultOwnId\" : \"916b5688-8bd8-4d7e-83b9-e0d40939274e\",\n \"resultOwnSimRunInitial\" : {\n \"owner\" : { },\n \"dataQuality\" : 0,\n \"description\" : \"Please simulate asap\",\n \"comment\" : \"successful simulation \",\n \"expirationTimestamp\" : \"2023-03-24T09:15:24.000Z\",\n \"runId\" : \"0fece48b-c8d1-4180-1a9caca6d67e\",\n \"shipments\" : [ {\n \"handlingUnits\" : [ {\n \"name\" : \"Palette\",\n \"volume\" : 1.0,\n \"weight\" : 189.0,\n \"batches\" : [ {\n \"unitOfMeasurement\" : \"KG\",\n \"materialName\" : \"KK1000GR-Gehäuse-Rot\",\n \"quantity\" : 50.0,\n \"materialNumber\" : \"KK1000GR\",\n \"materialHazardousGoods\" : false,\n \"batchOrderId\" : \"Order-0001\",\n \"batchId\" : \"Batch_1\",\n \"batchExpirationTimestamp\" : \"2023-08-22T16:00:00.000Z\",\n \"batchNumber\" : \"45\"\n } ],\n \"handlingUnitId\" : \"HUT_1\",\n \"amount\" : 1\n } ],\n \"shipmentId\" : \"DE51515151\",\n \"recipientTimestampPlanned\" : \"2023-04-19T09:00:00.000Z\",\n \"destination\" : { },\n \"recipient\" : { },\n \"logistics\" : { },\n \"preceding\" : { },\n \"splittingAllowed\" : true,\n \"destinationTimestamp\" : \"2023-03-19T09:00:00.000Z\"\n } ],\n \"timestamp\" : \"2023-03-09T14:13:42.806Z\"\n },\n \"resultOwnSimRunUpdated\" : {\n \"owner\" : { },\n \"dataQuality\" : 0,\n \"description\" : \"Please simulate asap\",\n \"comment\" : \"successful simulation \",\n \"expirationTimestamp\" : \"2023-03-24T09:15:24.000Z\",\n \"runId\" : \"0fece48b-c8d1-4180-1a9caca6d67e\",\n \"shipments\" : [ {\n \"handlingUnits\" : [ {\n \"name\" : \"Palette\",\n \"volume\" : 1.0,\n \"weight\" : 189.0,\n \"batches\" : [ {\n \"unitOfMeasurement\" : \"KG\",\n \"materialName\" : \"KK1000GR-Gehäuse-Rot\",\n \"quantity\" : 50.0,\n \"materialNumber\" : \"KK1000GR\",\n \"materialHazardousGoods\" : false,\n \"batchOrderId\" : \"Order-0001\",\n \"batchId\" : \"Batch_1\",\n \"batchExpirationTimestamp\" : \"2023-08-22T16:00:00.000Z\",\n \"batchNumber\" : \"45\"\n } ],\n \"handlingUnitId\" : \"HUT_1\",\n \"amount\" : 1\n } ],\n \"shipmentId\" : \"DE51515151\",\n \"recipientTimestampPlanned\" : \"2023-04-19T09:00:00.000Z\",\n \"destination\" : { },\n \"recipient\" : { },\n \"logistics\" : { },\n \"preceding\" : { },\n \"splittingAllowed\" : true,\n \"destinationTimestamp\" : \"2023-03-19T09:00:00.000Z\"\n } ],\n \"timestamp\" : \"2023-03-09T14:13:42.806Z\"\n }\n },\n \"scenarioParameter\" : {\n \"unitOfMeasurement\" : \"KG\",\n \"parameterScenario\" : \"8d464b8b-6977-4952-8a22-0489067ca081\",\n \"parameterComment\" : \"updated Delivery Date\",\n \"materialName\" : \"KK1000GR-Gehäuse-Rot\",\n \"parameterQuantityUpdated\" : 1.0,\n \"parameterId\" : \"847c71e5-614a-468b-a3a0-674bf2af3004\",\n \"materialNumber\" : \"KK1000GR\",\n \"parameterDeliveryDateUpdated\" : \"2023-10-10T09:00:00.000Z\",\n \"parameterDeliveryDateInitial\" : \"2023-10-09T10:00:00.000Z\",\n \"parameterOrderId\" : \"OID-011123456\",\n \"parameterQuantityInitial\" : 1.0\n },\n \"scenarioHeader\" : {\n \"scenarioOwnerRole\" : \"Customer\",\n \"scenarioCreationTimestamp\" : \"2023-10-04T09:10:00.000Z\",\n \"scenarioExpirationTimestamp\" : \"2023-10-07T09:10:00.000Z\",\n \"scenarioOwner\" : \"BPNS0000007OTZ3\",\n \"scenarioDescription\" : \"Changes in Delivery Date\",\n \"scenarioId\" : \"8d464b8b-6977-4952-8a22-0489067ca081\",\n \"scenarioTitle\" : \"Delivery Modification\"\n }\n }\n}"}}}}},"responses":{"200":{"description":"OK","content":{"text":{"schema":{"type":"string","example":"The request has succeeded. The requestScenarioFeedback has been successfully processed in the backend system."}}}},"400":{"description":"Bad request","content":{"text":{"schema":{"type":"string","example":"The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing)."}}}},"401":{"description":"Unauthorized","content":{"text":{"schema":{"type":"string","example":"Although the HTTP standard specifies \"unauthorized\", semantically this response means \"unauthenticated\". That is, the client must authenticate itself to get the requested response."}}}},"402":{"description":"Unknown BPNS","content":{"text":{"schema":{"type":"string","example":"The BPNS which is given as parameter is not registered in the data provider database as a direct partner."}}}},"403":{"description":"Forbidden","content":{"text":{"schema":{"type":"string","example":"The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource."}}}},"405":{"description":"Method not allowed","content":{"text":{"schema":{"type":"string","example":"The method used to request a scenario feedback was not POST"}}}},"500":{"description":"Internal server error","content":{"text":{"schema":{"type":"string","example":"The server has encountered a situation it does not know how to handle."}}}},"501":{"description":"Service unavailable","content":{"text":{"schema":{"type":"string","example":"The server is not ready to handle the request."}}}}},"servers":[{"url":"https://{server-url}"}],"method":"post","path":"/api/requestScenarioFeedback/bpns/{bpns}","jsonRequestBodyExample":{"materialFlowScenarioRequest":{"scenarioSimResults":{"resultOwnId":"string","resultOwnSimRunInitial":{"owner":{},"dataQuality":0,"description":"string","comment":"string","expirationTimestamp":"string","runId":"string","shipments":[{"handlingUnits":[{"name":"string","volume":0,"weight":0,"batches":[{"unitOfMeasurement":"string","materialName":"string","quantity":0,"materialNumber":"string","materialHazardousGoods":true,"batchOrderId":"string","batchId":"string","batchExpirationTimestamp":"string","batchNumber":"string"}],"handlingUnitId":"string","amount":0}],"shipmentId":"string","recipientTimestampPlanned":"string","destination":{},"recipient":{},"logistics":{},"preceding":{},"splittingAllowed":true,"destinationTimestamp":"string"}],"timestamp":"string"},"resultOwnSimRunUpdated":{"owner":{},"dataQuality":0,"description":"string","comment":"string","expirationTimestamp":"string","runId":"string","shipments":[{"handlingUnits":[{"name":"string","volume":0,"weight":0,"batches":[{"unitOfMeasurement":"string","materialName":"string","quantity":0,"materialNumber":"string","materialHazardousGoods":true,"batchOrderId":"string","batchId":"string","batchExpirationTimestamp":"string","batchNumber":"string"}],"handlingUnitId":"string","amount":0}],"shipmentId":"string","recipientTimestampPlanned":"string","destination":{},"recipient":{},"logistics":{},"preceding":{},"splittingAllowed":true,"destinationTimestamp":"string"}],"timestamp":"string"}},"scenarioParameter":{"unitOfMeasurement":"string","parameterScenario":"string","parameterComment":"string","materialName":"string","parameterQuantityUpdated":0,"parameterId":"string","materialNumber":"string","parameterDeliveryDateUpdated":"string","parameterDeliveryDateInitial":"string","parameterOrderId":"string","parameterQuantityInitial":0},"scenarioHeader":{"scenarioOwnerRole":"string","scenarioCreationTimestamp":"string","scenarioExpirationTimestamp":"string","scenarioOwner":"string","scenarioDescription":"string","scenarioId":"string","scenarioTitle":"string"}}},"info":{"title":"OSim API","description":"Osim API for requesting and receiving simulation results as well as for interactions related to scenario management.","version":"2.0.0"},"postman":{"name":"request Scenario Feedback","description":{"content":"The requestScenarioFeedback is a request from a OSim partner for feedback on the possible fulfillment of the described scenario.","type":"text/plain"},"url":{"path":["api","requestScenarioFeedback","bpns",":bpns"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"bpns"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +api: {"operationId":"requestScenarioFeedback","tags":["requestScenarioFeedback"],"description":"The requestScenarioFeedback is a request from a OSim partner for feedback on the possible fulfillment of the described scenario.","parameters":[{"name":"bpns","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"},"example":"BPNS00000007OTZ3"}],"requestBody":{"content":{"application/json":{"schema":{"required":["materialFlowScenarioRequest"],"type":"object","properties":{"materialFlowScenarioRequest":{"required":["scenarioHeader","scenarioSimResults"],"type":"object","properties":{"scenarioHeader":{"required":["scenarioCreationTimestamp","scenarioExpirationTimestamp","scenarioId","scenarioOwner","scenarioOwnerRole","scenarioTitle"],"type":"object","properties":{"scenarioId":{"type":"string","description":"Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc.","x-samm-aspect-model-urn":"urn:samm:org.eclipse.esmf.samm:characteristic:2.1.0#Text"},"scenarioTitle":{"type":"string","description":"Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc.","x-samm-aspect-model-urn":"urn:samm:org.eclipse.esmf.samm:characteristic:2.1.0#Text"},"scenarioCreationTimestamp":{"pattern":"-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T(([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\\.[0-9]+)?|(24:00:00(\\.0+)?))(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?","type":"string","description":"Describes a Property which contains the date and time with an optional timezone.","x-samm-aspect-model-urn":"urn:samm:org.eclipse.esmf.samm:characteristic:2.1.0#Timestamp"},"scenarioExpirationTimestamp":{"pattern":"-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T(([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\\.[0-9]+)?|(24:00:00(\\.0+)?))(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?","type":"string","description":"Describes a Property which contains the date and time with an optional timezone.","x-samm-aspect-model-urn":"urn:samm:org.eclipse.esmf.samm:characteristic:2.1.0#Timestamp"},"scenarioOwner":{"required":["bpnsProperty"],"type":"object","properties":{"bpnsProperty":{"pattern":"^BPNS[a-zA-Z0-9]{12}$","type":"string","description":"The provided regular expression ensures that the BPNS is composed of prefix 'BPNS', 10 digits and two alphanumeric letters.","x-samm-aspect-model-urn":"urn:samm:io.catenax.shared.business_partner_number:2.0.0#BpnsTrait"}},"description":"Characteristic describing the Scenario Owner","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_scenario_request:2.0.0#ScenarioOwnerCharacteristic"},"scenarioOwnerRole":{"type":"string","description":"Characteristic describing possible values for the role of the scenario owner","enum":["Customer","Supplier","LogisticianReceiving","LogisticianSending"],"x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_scenario_request:2.0.0#ScenarioOwnerRoleCharacteristic"},"scenarioDescription":{"type":"string","description":"Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc.","x-samm-aspect-model-urn":"urn:samm:org.eclipse.esmf.samm:characteristic:2.1.0#Text"}},"description":"Characteristic describing the parameter for a scenario header","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_scenario_request:2.0.0#ScenarioHeaderCharacteristic"},"scenarioParameter":{"type":"array","description":"Characteristic describing the scenario parameter","items":{"required":["materialName","materialNumber","parameterComment","parameterDeliveryDateInitial","parameterDeliveryDateUpdated","parameterId","parameterOrderId","parameterQuantityInitial","parameterQuantityUpdated","unitOfMeasurement"],"type":"object","properties":{"parameterId":{"type":"string","description":"Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc.","x-samm-aspect-model-urn":"urn:samm:org.eclipse.esmf.samm:characteristic:2.1.0#Text"},"parameterDeliveryDateInitial":{"pattern":"-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T(([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\\.[0-9]+)?|(24:00:00(\\.0+)?))(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?","type":"string","description":"Describes a Property which contains the date and time with an optional timezone.","x-samm-aspect-model-urn":"urn:samm:org.eclipse.esmf.samm:characteristic:2.1.0#Timestamp"},"parameterDeliveryDateUpdated":{"pattern":"-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T(([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\\.[0-9]+)?|(24:00:00(\\.0+)?))(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?","type":"string","description":"Describes a Property which contains the date and time with an optional timezone.","x-samm-aspect-model-urn":"urn:samm:org.eclipse.esmf.samm:characteristic:2.1.0#Timestamp"},"parameterQuantityInitial":{"type":"number","description":"Describes a property which is a Float","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_scenario_request:2.0.0#QuantityCharacteristic"},"parameterQuantityUpdated":{"type":"number","description":"Describes a property which is a Float","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_scenario_request:2.0.0#QuantityCharacteristic"},"parameterOrderId":{"type":"string","description":"Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc.","x-samm-aspect-model-urn":"urn:samm:org.eclipse.esmf.samm:characteristic:2.1.0#Text"},"parameterComment":{"type":"string","description":"Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc.","x-samm-aspect-model-urn":"urn:samm:org.eclipse.esmf.samm:characteristic:2.1.0#Text"},"materialNumber":{"type":"string","description":"Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc.","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#Text"},"materialName":{"type":"string","description":"Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc.","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#Text"},"unitOfMeasurement":{"type":"string","description":"Possible options for units of measurement","enum":["KG","Liter","Piece"],"x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#UnitOfMeasurementCharacteristic"}},"description":"Parameters which are used to describe a material flow scenario request","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_scenario_request:2.0.0#ScenarioParameter"},"x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_scenario_request:2.0.0#ScenarioParameterCharacteristic"},"scenarioSimResults":{"required":["resultOwnId"],"type":"object","properties":{"resultOwnId":{"type":"string","description":"Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc.","x-samm-aspect-model-urn":"urn:samm:org.eclipse.esmf.samm:characteristic:2.1.0#Text"},"resultOwnSimRunInitial":{"required":["comment","dataQuality","description","expirationTimestamp","owner","runId","shipments","timestamp"],"type":"object","properties":{"description":{"type":"string","description":"Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc.","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#Text"},"runId":{"type":"string","description":"Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc.","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#Text"},"comment":{"type":"string","description":"Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc.","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#Text"},"expirationTimestamp":{"pattern":"-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T(([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\\.[0-9]+)?|(24:00:00(\\.0+)?))(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?","type":"string","description":"Describes a Property which contains the date and time with an optional timezone.","x-samm-aspect-model-urn":"urn:samm:org.eclipse.esmf.samm:characteristic:2.1.0#Timestamp"},"owner":{"type":"object","description":"Site identifier of the simulation originator","allOf":[{"required":["bpnsProperty"],"type":"object","properties":{"bpnsProperty":{"pattern":"^BPNS[a-zA-Z0-9]{12}$","type":"string","description":"The provided regular expression ensures that the BPNS is composed of prefix 'BPNS', 10 digits and two alphanumeric letters.","x-samm-aspect-model-urn":"urn:samm:io.catenax.shared.business_partner_number:2.0.0#BpnsTrait"}},"description":"Characteristic describing the Scenario Owner","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_scenario_request:2.0.0#ScenarioOwnerCharacteristic"}],"x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#OwnerCharacteristic"},"dataQuality":{"minimum":0,"type":"number","description":"Possible values determining data quality","enum":[0,1,2,3,4,5],"x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#DataQualityOptions"},"shipments":{"type":"array","description":"List of shipments contained in the simulation","items":{"required":["destination","destinationTimestamp","handlingUnits","logistics","preceding","recipient","recipientTimestampPlanned","shipmentId","splittingAllowed"],"type":"object","properties":{"shipmentId":{"type":"string","description":"Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc.","x-samm-aspect-model-urn":"urn:samm:org.eclipse.esmf.samm:characteristic:2.1.0#Text"},"destination":{"type":"object","description":"Address where the shipment is immediately delivered to (by logistician) or provided for pickup (by producer)","allOf":[{"required":["bpnsProperty"],"type":"object","properties":{"bpnsProperty":{"pattern":"^BPNS[a-zA-Z0-9]{12}$","type":"string","description":"The provided regular expression ensures that the BPNS is composed of prefix 'BPNS', 10 digits and two alphanumeric letters.","x-samm-aspect-model-urn":"urn:samm:io.catenax.shared.business_partner_number:2.0.0#BpnsTrait"}},"description":"Characteristic describing the Scenario Owner","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_scenario_request:2.0.0#ScenarioOwnerCharacteristic"}],"x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#DestinationCharacteristic"},"destinationTimestamp":{"pattern":"-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T(([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\\.[0-9]+)?|(24:00:00(\\.0+)?))(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?","type":"string","description":"Describes a Property which contains the date and time with an optional timezone.","x-samm-aspect-model-urn":"urn:samm:org.eclipse.esmf.samm:characteristic:2.1.0#Timestamp"},"recipient":{"type":"object","description":"Location identifier of the final recipient of the shipment","allOf":[{"required":["bpnsProperty"],"type":"object","properties":{"bpnsProperty":{"pattern":"^BPNS[a-zA-Z0-9]{12}$","type":"string","description":"The provided regular expression ensures that the BPNS is composed of prefix 'BPNS', 10 digits and two alphanumeric letters.","x-samm-aspect-model-urn":"urn:samm:io.catenax.shared.business_partner_number:2.0.0#BpnsTrait"}},"description":"Characteristic describing the Scenario Owner","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_scenario_request:2.0.0#ScenarioOwnerCharacteristic"}],"x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#RecipientCharacteristic"},"recipientTimestampPlanned":{"pattern":"-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T(([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\\.[0-9]+)?|(24:00:00(\\.0+)?))(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?","type":"string","description":"Describes a Property which contains the date and time with an optional timezone.","x-samm-aspect-model-urn":"urn:samm:org.eclipse.esmf.samm:characteristic:2.1.0#Timestamp"},"splittingAllowed":{"type":"boolean","description":"Represents a boolean value (i.e. a \"flag\").","x-samm-aspect-model-urn":"urn:samm:org.eclipse.esmf.samm:characteristic:2.1.0#Boolean"},"logistics":{"type":"object","description":"Site identifier of the logistician executing the shipment","allOf":[{"required":["bpnsProperty"],"type":"object","properties":{"bpnsProperty":{"pattern":"^BPNS[a-zA-Z0-9]{12}$","type":"string","description":"The provided regular expression ensures that the BPNS is composed of prefix 'BPNS', 10 digits and two alphanumeric letters.","x-samm-aspect-model-urn":"urn:samm:io.catenax.shared.business_partner_number:2.0.0#BpnsTrait"}},"description":"Characteristic describing the Scenario Owner","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_scenario_request:2.0.0#ScenarioOwnerCharacteristic"}],"x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#LogisticsCharacteristic"},"preceding":{"type":"object","description":"Reference of preceding shipments","allOf":[{"required":["bpnsProperty"],"type":"object","properties":{"bpnsProperty":{"pattern":"^BPNS[a-zA-Z0-9]{12}$","type":"string","description":"The provided regular expression ensures that the BPNS is composed of prefix 'BPNS', 10 digits and two alphanumeric letters.","x-samm-aspect-model-urn":"urn:samm:io.catenax.shared.business_partner_number:2.0.0#BpnsTrait"}},"description":"Characteristic describing the Scenario Owner","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_scenario_request:2.0.0#ScenarioOwnerCharacteristic"}],"x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#PrecedingCharacteristic"},"handlingUnits":{"type":"array","description":"List of handling units included in the shipment","items":{"required":["amount","batches","handlingUnitId","name","volume","weight"],"type":"object","properties":{"handlingUnitId":{"type":"string","description":"Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc.","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#Text"},"name":{"type":"string","description":"Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc.","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#Text"},"volume":{"type":"number","description":"Volumetric value determining the volume of the handling unit","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#VolumeCharacteristic"},"weight":{"type":"number","description":"Amount of weight of the handling unit","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#WeightCharacteristic"},"amount":{"minimum":1,"type":"number","description":"Number describing handling units with identical pieces","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#AmountCharacteristic"},"batches":{"type":"array","description":"List of material batches","items":{"required":["batchExpirationTimestamp","batchNumber","batchOrderId","batchSerialNumber","materialHazardousGoods","materialName","materialNumber","quantity","unitOfMeasurement"],"type":"object","properties":{"batchSerialNumber":{"type":"string","description":"Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc.","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#Text"},"materialNumber":{"type":"string","description":"Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc.","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#Text"},"materialName":{"type":"string","description":"Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc.","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#Text"},"materialHazardousGoods":{"type":"boolean","description":"Represents a boolean value (i.e. a \"flag\").","x-samm-aspect-model-urn":"urn:samm:org.eclipse.esmf.samm:characteristic:2.1.0#Boolean"},"batchExpirationTimestamp":{"pattern":"-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T(([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\\.[0-9]+)?|(24:00:00(\\.0+)?))(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?","type":"string","description":"Describes a Property which contains the date and time with an optional timezone.","x-samm-aspect-model-urn":"urn:samm:org.eclipse.esmf.samm:characteristic:2.1.0#Timestamp"},"quantity":{"type":"number","description":"Number of materials contained within a handling unit","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#QuantityCharacteristic"},"unitOfMeasurement":{"type":"string","description":"Possible options for units of measurement","enum":["KG","Liter","Piece"],"x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#UnitOfMeasurementCharacteristic"},"batchNumber":{"type":"string","description":"Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc.","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#Text"},"batchOrderId":{"type":"string","description":"Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc.","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#Text"}},"description":"Material Batches are part of a handling unit","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#MaterialBatch"},"x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#BatchList"}},"description":"Handling Unit is the smallest shipment unit and cannot be divided into several shipments","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#HandlingUnit"},"x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#HandlingUnitList"}},"description":"Delivery item from a sender to a recipient containing goods","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#Shipment"},"x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#ShipmentList"},"timestamp":{"pattern":"-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T(([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\\.[0-9]+)?|(24:00:00(\\.0+)?))(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?","type":"string","description":"Describes a Property which contains the date and time with an optional timezone.","x-samm-aspect-model-urn":"urn:samm:org.eclipse.esmf.samm:characteristic:2.1.0#Timestamp"}},"description":"Characteristic describing the property for a Material Flow Simulation Result","example":{"materialFlowSimulationResult":{"owner":{"bpnsProperty":"BPNS0123456789ZZ"},"dataQuality":0,"description":"Please simulate asap","comment":"successful simulation ","expirationTimestamp":"2023-03-24T09:15:24.000Z","runId":"0fece48b-c8d1-4180-1a9caca6d67e","shipments":[{"handlingUnits":[{"name":"Palette","volume":1,"weight":189,"batches":[{"unitOfMeasurement":"KG","materialName":"KK1000GR-Gehäuse-Rot","quantity":50,"materialNumber":"KK1000GR","materialHazardousGoods":false,"batchSerialNumber":"Batch_1","batchOrderId":"Order-0001","batchExpirationTimestamp":"2023-08-22T16:00:00.000Z","batchNumber":"45"}],"handlingUnitId":"HUT_1","amount":1}],"shipmentId":"DE51515151","recipientTimestampPlanned":"2023-04-19T09:00:00.000Z","destination":{"bpnsProperty":"BPNS0123456789ZZ"},"recipient":{"bpnsProperty":"BPNS0123456789ZZ"},"logistics":{"bpnsProperty":"BPNS0123456789ZZ"},"preceding":{"bpnsProperty":"BPNS0123456789ZZ"},"splittingAllowed":true,"destinationTimestamp":"2023-03-19T09:00:00.000Z"}],"timestamp":"2023-03-09T14:13:42.806Z"}},"x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_scenario_request:2.0.0#SimResult"},"resultOwnSimRunUpdated":{"required":["comment","dataQuality","description","expirationTimestamp","owner","runId","shipments","timestamp"],"type":"object","properties":{"description":{"type":"string","description":"Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc.","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#Text"},"runId":{"type":"string","description":"Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc.","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#Text"},"comment":{"type":"string","description":"Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc.","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#Text"},"expirationTimestamp":{"pattern":"-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T(([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\\.[0-9]+)?|(24:00:00(\\.0+)?))(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?","type":"string","description":"Describes a Property which contains the date and time with an optional timezone.","x-samm-aspect-model-urn":"urn:samm:org.eclipse.esmf.samm:characteristic:2.1.0#Timestamp"},"owner":{"type":"object","description":"Site identifier of the simulation originator","allOf":[{"required":["bpnsProperty"],"type":"object","properties":{"bpnsProperty":{"pattern":"^BPNS[a-zA-Z0-9]{12}$","type":"string","description":"The provided regular expression ensures that the BPNS is composed of prefix 'BPNS', 10 digits and two alphanumeric letters.","x-samm-aspect-model-urn":"urn:samm:io.catenax.shared.business_partner_number:2.0.0#BpnsTrait"}},"description":"Characteristic describing the Scenario Owner","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_scenario_request:2.0.0#ScenarioOwnerCharacteristic"}],"x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#OwnerCharacteristic"},"dataQuality":{"minimum":0,"type":"number","description":"Possible values determining data quality","enum":[0,1,2,3,4,5],"x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#DataQualityOptions"},"shipments":{"type":"array","description":"List of shipments contained in the simulation","items":{"required":["destination","destinationTimestamp","handlingUnits","logistics","preceding","recipient","recipientTimestampPlanned","shipmentId","splittingAllowed"],"type":"object","properties":{"shipmentId":{"type":"string","description":"Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc.","x-samm-aspect-model-urn":"urn:samm:org.eclipse.esmf.samm:characteristic:2.1.0#Text"},"destination":{"type":"object","description":"Address where the shipment is immediately delivered to (by logistician) or provided for pickup (by producer)","allOf":[{"required":["bpnsProperty"],"type":"object","properties":{"bpnsProperty":{"pattern":"^BPNS[a-zA-Z0-9]{12}$","type":"string","description":"The provided regular expression ensures that the BPNS is composed of prefix 'BPNS', 10 digits and two alphanumeric letters.","x-samm-aspect-model-urn":"urn:samm:io.catenax.shared.business_partner_number:2.0.0#BpnsTrait"}},"description":"Characteristic describing the Scenario Owner","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_scenario_request:2.0.0#ScenarioOwnerCharacteristic"}],"x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#DestinationCharacteristic"},"destinationTimestamp":{"pattern":"-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T(([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\\.[0-9]+)?|(24:00:00(\\.0+)?))(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?","type":"string","description":"Describes a Property which contains the date and time with an optional timezone.","x-samm-aspect-model-urn":"urn:samm:org.eclipse.esmf.samm:characteristic:2.1.0#Timestamp"},"recipient":{"type":"object","description":"Location identifier of the final recipient of the shipment","allOf":[{"required":["bpnsProperty"],"type":"object","properties":{"bpnsProperty":{"pattern":"^BPNS[a-zA-Z0-9]{12}$","type":"string","description":"The provided regular expression ensures that the BPNS is composed of prefix 'BPNS', 10 digits and two alphanumeric letters.","x-samm-aspect-model-urn":"urn:samm:io.catenax.shared.business_partner_number:2.0.0#BpnsTrait"}},"description":"Characteristic describing the Scenario Owner","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_scenario_request:2.0.0#ScenarioOwnerCharacteristic"}],"x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#RecipientCharacteristic"},"recipientTimestampPlanned":{"pattern":"-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T(([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\\.[0-9]+)?|(24:00:00(\\.0+)?))(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?","type":"string","description":"Describes a Property which contains the date and time with an optional timezone.","x-samm-aspect-model-urn":"urn:samm:org.eclipse.esmf.samm:characteristic:2.1.0#Timestamp"},"splittingAllowed":{"type":"boolean","description":"Represents a boolean value (i.e. a \"flag\").","x-samm-aspect-model-urn":"urn:samm:org.eclipse.esmf.samm:characteristic:2.1.0#Boolean"},"logistics":{"type":"object","description":"Site identifier of the logistician executing the shipment","allOf":[{"required":["bpnsProperty"],"type":"object","properties":{"bpnsProperty":{"pattern":"^BPNS[a-zA-Z0-9]{12}$","type":"string","description":"The provided regular expression ensures that the BPNS is composed of prefix 'BPNS', 10 digits and two alphanumeric letters.","x-samm-aspect-model-urn":"urn:samm:io.catenax.shared.business_partner_number:2.0.0#BpnsTrait"}},"description":"Characteristic describing the Scenario Owner","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_scenario_request:2.0.0#ScenarioOwnerCharacteristic"}],"x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#LogisticsCharacteristic"},"preceding":{"type":"object","description":"Reference of preceding shipments","allOf":[{"required":["bpnsProperty"],"type":"object","properties":{"bpnsProperty":{"pattern":"^BPNS[a-zA-Z0-9]{12}$","type":"string","description":"The provided regular expression ensures that the BPNS is composed of prefix 'BPNS', 10 digits and two alphanumeric letters.","x-samm-aspect-model-urn":"urn:samm:io.catenax.shared.business_partner_number:2.0.0#BpnsTrait"}},"description":"Characteristic describing the Scenario Owner","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_scenario_request:2.0.0#ScenarioOwnerCharacteristic"}],"x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#PrecedingCharacteristic"},"handlingUnits":{"type":"array","description":"List of handling units included in the shipment","items":{"required":["amount","batches","handlingUnitId","name","volume","weight"],"type":"object","properties":{"handlingUnitId":{"type":"string","description":"Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc.","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#Text"},"name":{"type":"string","description":"Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc.","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#Text"},"volume":{"type":"number","description":"Volumetric value determining the volume of the handling unit","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#VolumeCharacteristic"},"weight":{"type":"number","description":"Amount of weight of the handling unit","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#WeightCharacteristic"},"amount":{"minimum":1,"type":"number","description":"Number describing handling units with identical pieces","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#AmountCharacteristic"},"batches":{"type":"array","description":"List of material batches","items":{"required":["batchExpirationTimestamp","batchNumber","batchOrderId","batchSerialNumber","materialHazardousGoods","materialName","materialNumber","quantity","unitOfMeasurement"],"type":"object","properties":{"batchSerialNumber":{"type":"string","description":"Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc.","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#Text"},"materialNumber":{"type":"string","description":"Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc.","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#Text"},"materialName":{"type":"string","description":"Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc.","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#Text"},"materialHazardousGoods":{"type":"boolean","description":"Represents a boolean value (i.e. a \"flag\").","x-samm-aspect-model-urn":"urn:samm:org.eclipse.esmf.samm:characteristic:2.1.0#Boolean"},"batchExpirationTimestamp":{"pattern":"-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T(([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\\.[0-9]+)?|(24:00:00(\\.0+)?))(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?","type":"string","description":"Describes a Property which contains the date and time with an optional timezone.","x-samm-aspect-model-urn":"urn:samm:org.eclipse.esmf.samm:characteristic:2.1.0#Timestamp"},"quantity":{"type":"number","description":"Number of materials contained within a handling unit","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#QuantityCharacteristic"},"unitOfMeasurement":{"type":"string","description":"Possible options for units of measurement","enum":["KG","Liter","Piece"],"x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#UnitOfMeasurementCharacteristic"},"batchNumber":{"type":"string","description":"Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc.","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#Text"},"batchOrderId":{"type":"string","description":"Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc.","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#Text"}},"description":"Material Batches are part of a handling unit","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#MaterialBatch"},"x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#BatchList"}},"description":"Handling Unit is the smallest shipment unit and cannot be divided into several shipments","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#HandlingUnit"},"x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#HandlingUnitList"}},"description":"Delivery item from a sender to a recipient containing goods","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#Shipment"},"x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#ShipmentList"},"timestamp":{"pattern":"-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T(([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\\.[0-9]+)?|(24:00:00(\\.0+)?))(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?","type":"string","description":"Describes a Property which contains the date and time with an optional timezone.","x-samm-aspect-model-urn":"urn:samm:org.eclipse.esmf.samm:characteristic:2.1.0#Timestamp"}},"description":"Characteristic describing the property for a Material Flow Simulation Result","example":{"materialFlowSimulationResult":{"owner":{"bpnsProperty":"BPNS0123456789ZZ"},"dataQuality":0,"description":"Please simulate asap","comment":"successful simulation ","expirationTimestamp":"2023-03-24T09:15:24.000Z","runId":"0fece48b-c8d1-4180-1a9caca6d67e","shipments":[{"handlingUnits":[{"name":"Palette","volume":1,"weight":189,"batches":[{"unitOfMeasurement":"KG","materialName":"KK1000GR-Gehäuse-Rot","quantity":50,"materialNumber":"KK1000GR","materialHazardousGoods":false,"batchSerialNumber":"Batch_1","batchOrderId":"Order-0001","batchExpirationTimestamp":"2023-08-22T16:00:00.000Z","batchNumber":"45"}],"handlingUnitId":"HUT_1","amount":1}],"shipmentId":"DE51515151","recipientTimestampPlanned":"2023-04-19T09:00:00.000Z","destination":{"bpnsProperty":"BPNS0123456789ZZ"},"recipient":{"bpnsProperty":"BPNS0123456789ZZ"},"logistics":{"bpnsProperty":"BPNS0123456789ZZ"},"preceding":{"bpnsProperty":"BPNS0123456789ZZ"},"splittingAllowed":true,"destinationTimestamp":"2023-03-19T09:00:00.000Z"}],"timestamp":"2023-03-09T14:13:42.806Z"}},"x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_scenario_request:2.0.0#SimResult"}},"description":"Characteristic for simulation results","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_scenario_request:2.0.0#ScenarioSimResultsCharacteristic"}},"description":"Characteristic describing the aspect Material Flow Scenario Request","example":{"materialFlowScenarioRequest":{"scenarioSimResults":{"resultOwnId":"916b5688-8bd8-4d7e-83b9-e0d40939274e","resultOwnSimRunInitial":{"owner":{"bpnsProperty":"BPNS0123456789ZZ"},"dataQuality":0,"description":"Please simulate asap","comment":"successful simulation ","expirationTimestamp":"2023-03-24T09:15:24.000Z","runId":"0fece48b-c8d1-4180-1a9caca6d67e","shipments":[{"handlingUnits":[{"name":"Palette","volume":1,"weight":189,"batches":[{"unitOfMeasurement":"KG","materialName":"KK1000GR-Gehäuse-Rot","quantity":50,"materialNumber":"KK1000GR","materialHazardousGoods":false,"batchSerialNumber":"Batch_1","batchOrderId":"Order-0001","batchExpirationTimestamp":"2023-08-22T16:00:00.000Z","batchNumber":"45"}],"handlingUnitId":"HUT_1","amount":1}],"shipmentId":"DE51515151","recipientTimestampPlanned":"2023-04-19T09:00:00.000Z","destination":{"bpnsProperty":"BPNS0123456789ZZ"},"recipient":{"bpnsProperty":"BPNS0123456789ZZ"},"logistics":{"bpnsProperty":"BPNS0123456789ZZ"},"preceding":{"bpnsProperty":"BPNS0123456789ZZ"},"splittingAllowed":true,"destinationTimestamp":"2023-03-19T09:00:00.000Z"}],"timestamp":"2023-03-09T14:13:42.806Z"},"resultOwnSimRunUpdated":{"owner":{"bpnsProperty":"BPNS0123456789ZZ"},"dataQuality":0,"description":"Please simulate asap","comment":"successful simulation ","expirationTimestamp":"2023-03-24T09:15:24.000Z","runId":"0fece48b-c8d1-4180-1a9caca6d67e","shipments":[{"handlingUnits":[{"name":"Palette","volume":1,"weight":189,"batches":[{"unitOfMeasurement":"KG","materialName":"KK1000GR-Gehäuse-Rot","quantity":50,"materialNumber":"KK1000GR","materialHazardousGoods":false,"batchSerialNumber":"Batch_1","batchOrderId":"Order-0001","batchExpirationTimestamp":"2023-08-22T16:00:00.000Z","batchNumber":"45"}],"handlingUnitId":"HUT_1","amount":1}],"shipmentId":"DE51515151","recipientTimestampPlanned":"2023-04-19T09:00:00.000Z","destination":{"bpnsProperty":"BPNS0123456789ZZ"},"recipient":{"bpnsProperty":"BPNS0123456789ZZ"},"logistics":{"bpnsProperty":"BPNS0123456789ZZ"},"preceding":{"bpnsProperty":"BPNS0123456789ZZ"},"splittingAllowed":true,"destinationTimestamp":"2023-03-19T09:00:00.000Z"}],"timestamp":"2023-03-09T14:13:42.806Z"}},"scenarioParameter":[{"unitOfMeasurement":"KG","parameterComment":"updated Delivery Date","materialName":"KK1000GR-Gehäuse-Rot","parameterQuantityUpdated":1,"parameterId":"847c71e5-614a-468b-a3a0-674bf2af3004","materialNumber":"KK1000GR","parameterDeliveryDateUpdated":"2023-10-10T09:00:00.000Z","parameterDeliveryDateInitial":"2023-10-09T10:00:00.000Z","parameterOrderId":"OID-011123546","parameterQuantityInitial":1}],"scenarioHeader":{"scenarioOwnerRole":"Customer","scenarioCreationTimestamp":"2023-10-04T09:10:00.000Z","scenarioExpirationTimestamp":"2023-10-07T09:10:00.000Z","scenarioOwner":{"bpnsProperty":"BPNS0123456789ZZ"},"scenarioDescription":"Changes in Delivery Date","scenarioId":"8d464b8b-6977-4952-8a22-0489067ca081","scenarioTitle":"Delivery Modification"}}},"x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_scenario_request:2.0.0#MaterialFlowScenarioRequestCharacteristic"}},"description":"Aspect model describing the Material Flow Scenario Request","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_scenario_request:2.0.0#MaterialFlowScenarioRequestAspect"}}}},"responses":{"200":{"description":"OK","content":{"text":{"schema":{"type":"string","example":"The request has succeeded. The requestScenarioFeedback has been successfully processed in the backend system."}}}},"400":{"description":"Bad request","content":{"text":{"schema":{"type":"string","example":"The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing)."}}}},"401":{"description":"Unauthorized","content":{"text":{"schema":{"type":"string","example":"Although the HTTP standard specifies \"unauthorized\", semantically this response means \"unauthenticated\". That is, the client must authenticate itself to get the requested response."}}}},"402":{"description":"Unknown BPNS","content":{"text":{"schema":{"type":"string","example":"The BPNS which is given as parameter is not registered in the data provider database as a direct partner."}}}},"403":{"description":"Forbidden","content":{"text":{"schema":{"type":"string","example":"The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource."}}}},"405":{"description":"Method not allowed","content":{"text":{"schema":{"type":"string","example":"The method used to request a scenario feedback was not POST"}}}},"500":{"description":"Internal server error","content":{"text":{"schema":{"type":"string","example":"The server has encountered a situation it does not know how to handle."}}}},"501":{"description":"Service unavailable","content":{"text":{"schema":{"type":"string","example":"The server is not ready to handle the request."}}}}},"servers":[{"url":"https://{server-url}"}],"method":"post","path":"/api/requestScenarioFeedback/bpns/{bpns}","jsonRequestBodyExample":{"materialFlowScenarioRequest":{"materialFlowScenarioRequest":{"scenarioSimResults":{"resultOwnId":"916b5688-8bd8-4d7e-83b9-e0d40939274e","resultOwnSimRunInitial":{"owner":{"bpnsProperty":"BPNS0123456789ZZ"},"dataQuality":0,"description":"Please simulate asap","comment":"successful simulation ","expirationTimestamp":"2023-03-24T09:15:24.000Z","runId":"0fece48b-c8d1-4180-1a9caca6d67e","shipments":[{"handlingUnits":[{"name":"Palette","volume":1,"weight":189,"batches":[{"unitOfMeasurement":"KG","materialName":"KK1000GR-Gehäuse-Rot","quantity":50,"materialNumber":"KK1000GR","materialHazardousGoods":false,"batchSerialNumber":"Batch_1","batchOrderId":"Order-0001","batchExpirationTimestamp":"2023-08-22T16:00:00.000Z","batchNumber":"45"}],"handlingUnitId":"HUT_1","amount":1}],"shipmentId":"DE51515151","recipientTimestampPlanned":"2023-04-19T09:00:00.000Z","destination":{"bpnsProperty":"BPNS0123456789ZZ"},"recipient":{"bpnsProperty":"BPNS0123456789ZZ"},"logistics":{"bpnsProperty":"BPNS0123456789ZZ"},"preceding":{"bpnsProperty":"BPNS0123456789ZZ"},"splittingAllowed":true,"destinationTimestamp":"2023-03-19T09:00:00.000Z"}],"timestamp":"2023-03-09T14:13:42.806Z"},"resultOwnSimRunUpdated":{"owner":{"bpnsProperty":"BPNS0123456789ZZ"},"dataQuality":0,"description":"Please simulate asap","comment":"successful simulation ","expirationTimestamp":"2023-03-24T09:15:24.000Z","runId":"0fece48b-c8d1-4180-1a9caca6d67e","shipments":[{"handlingUnits":[{"name":"Palette","volume":1,"weight":189,"batches":[{"unitOfMeasurement":"KG","materialName":"KK1000GR-Gehäuse-Rot","quantity":50,"materialNumber":"KK1000GR","materialHazardousGoods":false,"batchSerialNumber":"Batch_1","batchOrderId":"Order-0001","batchExpirationTimestamp":"2023-08-22T16:00:00.000Z","batchNumber":"45"}],"handlingUnitId":"HUT_1","amount":1}],"shipmentId":"DE51515151","recipientTimestampPlanned":"2023-04-19T09:00:00.000Z","destination":{"bpnsProperty":"BPNS0123456789ZZ"},"recipient":{"bpnsProperty":"BPNS0123456789ZZ"},"logistics":{"bpnsProperty":"BPNS0123456789ZZ"},"preceding":{"bpnsProperty":"BPNS0123456789ZZ"},"splittingAllowed":true,"destinationTimestamp":"2023-03-19T09:00:00.000Z"}],"timestamp":"2023-03-09T14:13:42.806Z"}},"scenarioParameter":[{"unitOfMeasurement":"KG","parameterComment":"updated Delivery Date","materialName":"KK1000GR-Gehäuse-Rot","parameterQuantityUpdated":1,"parameterId":"847c71e5-614a-468b-a3a0-674bf2af3004","materialNumber":"KK1000GR","parameterDeliveryDateUpdated":"2023-10-10T09:00:00.000Z","parameterDeliveryDateInitial":"2023-10-09T10:00:00.000Z","parameterOrderId":"OID-011123546","parameterQuantityInitial":1}],"scenarioHeader":{"scenarioOwnerRole":"Customer","scenarioCreationTimestamp":"2023-10-04T09:10:00.000Z","scenarioExpirationTimestamp":"2023-10-07T09:10:00.000Z","scenarioOwner":{"bpnsProperty":"BPNS0123456789ZZ"},"scenarioDescription":"Changes in Delivery Date","scenarioId":"8d464b8b-6977-4952-8a22-0489067ca081","scenarioTitle":"Delivery Modification"}}}},"info":{"title":"OSim API","description":"OSim API for requesting and receiving simulation results","version":"3.0.0"},"postman":{"name":"request Scenario Feedback","description":{"content":"The requestScenarioFeedback is a request from a OSim partner for feedback on the possible fulfillment of the described scenario.","type":"text/plain"},"url":{"path":["api","requestScenarioFeedback","bpns",":bpns"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"bpns"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} sidebar_class_name: "post api-method" info_path: docs-kits/kits/OSim Kit/Software Development View//osim-api custom_edit_url: null @@ -26,7 +26,99 @@ import TabItem from "@theme/TabItem"; The requestScenarioFeedback is a request from a OSim partner for feedback on the possible fulfillment of the described scenario. -
Path Parameters
Request Body
    materialFlowScenarioRequest object required
    scenarioSimResults object required
    resultOwnSimRunInitial object required
    shipments object[] required
    handlingUnits object[] required
    batches object[] required
    resultOwnSimRunUpdated object required
    shipments object[] required
    handlingUnits object[] required
    batches object[] required
    scenarioParameter object required
    scenarioHeader object required
+
Path Parameters
Request Body
    materialFlowScenarioRequest object required
    + +Characteristic describing the aspect Material Flow Scenario Request + +
    scenarioHeader object required
    + +Characteristic describing the parameter for a scenario header + +
    scenarioOwner object required
    + +Characteristic describing the Scenario Owner + +
    scenarioParameter object[]
    + +Characteristic describing the scenario parameter + +
    scenarioSimResults object required
    + +Characteristic for simulation results + +
    resultOwnSimRunInitial object
    + +Characteristic describing the property for a Material Flow Simulation Result + +
    owner object
    + +Characteristic describing the Scenario Owner + +
    shipments object[] required
    + +List of shipments contained in the simulation + +
    destination object
    + +Characteristic describing the Scenario Owner + +
    recipient object
    + +Characteristic describing the Scenario Owner + +
    logistics object
    + +Characteristic describing the Scenario Owner + +
    preceding object
    + +Characteristic describing the Scenario Owner + +
    handlingUnits object[] required
    + +List of handling units included in the shipment + +
    = 1`"} defaultValue={undefined}>
    batches object[] required
    + +List of material batches + +
    resultOwnSimRunUpdated object
    + +Characteristic describing the property for a Material Flow Simulation Result + +
    owner object
    + +Characteristic describing the Scenario Owner + +
    shipments object[] required
    + +List of shipments contained in the simulation + +
    destination object
    + +Characteristic describing the Scenario Owner + +
    recipient object
    + +Characteristic describing the Scenario Owner + +
    logistics object
    + +Characteristic describing the Scenario Owner + +
    preceding object
    + +Characteristic describing the Scenario Owner + +
    handlingUnits object[] required
    + +List of handling units included in the shipment + +
    = 1`"} defaultValue={undefined}>
    batches object[] required
    + +List of material batches + +
OK diff --git a/docs-kits/kits/OSim Kit/Software Development View/06-receive-scenario-feedback.api.mdx b/docs-kits/kits/OSim Kit/Software Development View/06-receive-scenario-feedback.api.mdx index 102bb1861e4..880ebbd4405 100644 --- a/docs-kits/kits/OSim Kit/Software Development View/06-receive-scenario-feedback.api.mdx +++ b/docs-kits/kits/OSim Kit/Software Development View/06-receive-scenario-feedback.api.mdx @@ -5,7 +5,7 @@ description: "The receiveScenarioFeedback enables the requestor to transmit the sidebar_label: "receiveScenarioFeedback" hide_title: true hide_table_of_contents: true -api: {"tags":["receiveScenarioFeedback"],"operationId":"receiveScenarioFeedback","description":"The receiveScenarioFeedback enables the requestor to transmit the result of his scenario-based evaluation to the requestor","parameters":[{"name":"bpns","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"},"example":"BPNS00000007OTZ3"},{"name":"scenarioId","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"},"example":"50737df3-4237-4652-b092-1ef8649f6ca6"},{"name":"feedback","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","enum":["Realizable","NotRealizable"]},"example":"Realizable"}],"responses":{"200":{"description":"OK","content":{"text":{"schema":{"type":"string","example":"The GET request has succeeded. The receiveScenarioFeedback has been successfully processed in the backend system."}}}},"400":{"description":"Bad request","content":{"text":{"schema":{"type":"string","example":"The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing)."}}}},"401":{"description":"Unauthorized","content":{"text":{"schema":{"type":"string","example":"Although the HTTP standard specifies \"unauthorized\", semantically this response means \"unauthenticated\". That is, the client must authenticate itself to get the requested response."}}}},"402":{"description":"Unknown BPNS","content":{"text":{"schema":{"type":"string","example":"The BPNS which is given as parameter is not registered in the data provider database as a direct partner."}}}},"403":{"description":"Forbidden","content":{"text":{"schema":{"type":"string","example":"The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource."}}}},"405":{"description":"Method not allowed","content":{"text":{"schema":{"type":"string","example":"The method used to request a scenario feedback was not GET"}}}},"406":{"description":"Unknown Scenario","content":{"text":{"schema":{"type":"string","example":"The scenarioID which is given as parameter is not registered."}}}},"407":{"description":"Unknown State","content":{"text":{"schema":{"type":"string","example":"The feedbackState value is unknown."}}}},"500":{"description":"Internal server error","content":{"text":{"schema":{"type":"string","example":"The server has encountered a situation it does not know how to handle."}}}},"501":{"description":"Service unavailable","content":{"text":{"schema":{"type":"string","example":"The server is not ready to handle the request."}}}}},"servers":[{"url":"https://{server-url}"}],"method":"get","path":"/api/receiveScenarioFeedback/bpns/{bpns}/scenarioId/{scenarioId}/feedback/{feedback}","info":{"title":"OSim API","description":"Osim API for requesting and receiving simulation results as well as for interactions related to scenario management.","version":"2.0.0"},"postman":{"name":"receive Scenario Feedback","description":{"content":"The receiveScenarioFeedback enables the requestor to transmit the result of his scenario-based evaluation to the requestor","type":"text/plain"},"url":{"path":["api","receiveScenarioFeedback","bpns",":bpns","scenarioId",":scenarioId","feedback",":feedback"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"bpns"},{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"scenarioId"},{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"feedback"}]},"header":[{"key":"Accept","value":"text"}],"method":"GET"}} +api: {"operationId":"receiveScenarioFeedback","tags":["receiveScenarioFeedback"],"description":"The receiveScenarioFeedback enables the requestor to transmit the result of his scenario-based evaluation to the requestor","parameters":[{"name":"bpns","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"},"example":"BPNS00000007OTZ3"},{"name":"scenarioId","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"},"example":"50737df3-4237-4652-b092-1ef8649f6ca6"},{"name":"feedback","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","enum":["Realizable","NotRealizable"]},"example":"Realizable"}],"responses":{"200":{"description":"OK","content":{"text":{"schema":{"type":"string","example":"The GET request has succeeded. The receiveScenarioFeedback has been successfully processed in the backend system."}}}},"400":{"description":"Bad request","content":{"text":{"schema":{"type":"string","example":"The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing)."}}}},"401":{"description":"Unauthorized","content":{"text":{"schema":{"type":"string","example":"Although the HTTP standard specifies \"unauthorized\", semantically this response means \"unauthenticated\". That is, the client must authenticate itself to get the requested response."}}}},"402":{"description":"Unknown BPNS","content":{"text":{"schema":{"type":"string","example":"The BPNS which is given as parameter is not registered in the data provider database as a direct partner."}}}},"403":{"description":"Forbidden","content":{"text":{"schema":{"type":"string","example":"The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource."}}}},"405":{"description":"Method not allowed","content":{"text":{"schema":{"type":"string","example":"The method used to request a scenario feedback was not GET"}}}},"406":{"description":"Unknown Scenario","content":{"text":{"schema":{"type":"string","example":"The scenarioID which is given as parameter is not registered."}}}},"407":{"description":"Unknown State","content":{"text":{"schema":{"type":"string","example":"The feedbackState value is unknown."}}}},"500":{"description":"Internal server error","content":{"text":{"schema":{"type":"string","example":"The server has encountered a situation it does not know how to handle."}}}},"501":{"description":"Service unavailable","content":{"text":{"schema":{"type":"string","example":"The server is not ready to handle the request."}}}}},"servers":[{"url":"https://{server-url}"}],"method":"get","path":"/api/receiveScenarioFeedback/bpns/{bpns}/scenarioId/{scenarioId}/feedback/{feedback}","info":{"title":"OSim API","description":"OSim API for requesting and receiving simulation results","version":"3.0.0"},"postman":{"name":"receive Scenario Feedback","description":{"content":"The receiveScenarioFeedback enables the requestor to transmit the result of his scenario-based evaluation to the requestor","type":"text/plain"},"url":{"path":["api","receiveScenarioFeedback","bpns",":bpns","scenarioId",":scenarioId","feedback",":feedback"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"bpns"},{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"scenarioId"},{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"feedback"}]},"header":[{"key":"Accept","value":"text"}],"method":"GET"}} sidebar_class_name: "get api-method" info_path: docs-kits/kits/OSim Kit/Software Development View//osim-api custom_edit_url: null diff --git a/docs-kits/kits/OSim Kit/Software Development View/07-push-scenario-state.api.mdx b/docs-kits/kits/OSim Kit/Software Development View/07-push-scenario-state.api.mdx index e844d14f913..872564bce85 100644 --- a/docs-kits/kits/OSim Kit/Software Development View/07-push-scenario-state.api.mdx +++ b/docs-kits/kits/OSim Kit/Software Development View/07-push-scenario-state.api.mdx @@ -5,8 +5,8 @@ description: "The pushScenarioState enables distribution of a new scenario statu sidebar_label: "pushScenarioState" hide_title: true hide_table_of_contents: true -api: {"tags":["pushScenarioState"],"operationId":"pushScenarioState","description":"The pushScenarioState enables distribution of a new scenario status and thus a notification of the procedure with the planned scenario","parameters":[{"name":"bpns","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"},"example":"BPNS00000007OTZ3"},{"name":"scenarioId","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"},"example":"50737df3-4237-4652-b092-1ef8649f6ca6"},{"name":"state","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","enum":["InRealization","Processed","Canceled"]},"example":"InRealization"}],"responses":{"200":{"description":"OK","content":{"text":{"schema":{"type":"string","example":"The GET has succeeded. The pushScenarioState has been successfully processed in the backend system."}}}},"400":{"description":"Bad request","content":{"text":{"schema":{"type":"string","example":"The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing)."}}}},"401":{"description":"Unauthorized","content":{"text":{"schema":{"type":"string","example":"Although the HTTP standard specifies \"unauthorized\", semantically this response means \"unauthenticated\". That is, the client must authenticate itself to get the requested response."}}}},"402":{"description":"Unknown BPNS","content":{"text":{"schema":{"type":"string","example":"The BPNS which is given as parameter is not registered in the data provider database as a direct partner."}}}},"403":{"description":"Forbidden","content":{"text":{"schema":{"type":"string","example":"The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource."}}}},"405":{"description":"Method not allowed","content":{"text":{"schema":{"type":"string","example":"The method used to request a scenario feedback was not GET"}}}},"406":{"description":"Unknown Scenario","content":{"text":{"schema":{"type":"string","example":"The scenarioID which is given as parameter is not registered."}}}},"407":{"description":"Unknown State","content":{"text":{"schema":{"type":"string","example":"The scenarioState value is unknown."}}}},"500":{"description":"Internal server error","content":{"text":{"schema":{"type":"string","example":"The server has encountered a situation it does not know how to handle."}}}},"501":{"description":"Service unavailable","content":{"text":{"schema":{"type":"string","example":"The server is not ready to handle the request."}}}}},"servers":[{"url":"https://{server-url}"}],"method":"get","path":"/api/pushScenarioState/bpns/{bpns}/scenarioId/{scenarioId}/state/{state}","info":{"title":"OSim API","description":"Osim API for requesting and receiving simulation results as well as for interactions related to scenario management.","version":"2.0.0"},"postman":{"name":"push Scenario State","description":{"content":"The pushScenarioState enables distribution of a new scenario status and thus a notification of the procedure with the planned scenario","type":"text/plain"},"url":{"path":["api","pushScenarioState","bpns",":bpns","scenarioId",":scenarioId","state",":state"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"bpns"},{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"scenarioId"},{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"state"}]},"header":[{"key":"Accept","value":"text"}],"method":"GET"}} -sidebar_class_name: "get api-method" +api: {"operationId":"pushScenarioState","tags":["pushScenarioState"],"description":"The pushScenarioState enables distribution of a new scenario status and thus a notification of the procedure with the planned scenario","parameters":[{"name":"bpns","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"},"example":"BPNS00000007OTZ3"},{"name":"scenarioId","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"},"example":"50737df3-4237-4652-b092-1ef8649f6ca6"},{"name":"state","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","enum":["InRealization","Processed","Canceled"]},"example":"InRealization"}],"requestBody":{"content":{"text/plain":{"schema":{"type":"string"}}}},"responses":{"200":{"description":"OK","content":{"text":{"schema":{"type":"string","example":"The GET has succeeded. The pushScenarioState has been successfully processed in the backend system."}}}},"400":{"description":"Bad request","content":{"text":{"schema":{"type":"string","example":"The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing)."}}}},"401":{"description":"Unauthorized","content":{"text":{"schema":{"type":"string","example":"Although the HTTP standard specifies \"unauthorized\", semantically this response means \"unauthenticated\". That is, the client must authenticate itself to get the requested response."}}}},"402":{"description":"Unknown BPNS","content":{"text":{"schema":{"type":"string","example":"The BPNS which is given as parameter is not registered in the data provider database as a direct partner."}}}},"403":{"description":"Forbidden","content":{"text":{"schema":{"type":"string","example":"The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource."}}}},"405":{"description":"Method not allowed","content":{"text":{"schema":{"type":"string","example":"The method used to request a scenario feedback was not GET"}}}},"406":{"description":"Unknown Scenario","content":{"text":{"schema":{"type":"string","example":"The scenarioID which is given as parameter is not registered."}}}},"407":{"description":"Unknown State","content":{"text":{"schema":{"type":"string","example":"The scenarioState value is unknown."}}}},"500":{"description":"Internal server error","content":{"text":{"schema":{"type":"string","example":"The server has encountered a situation it does not know how to handle."}}}},"501":{"description":"Service unavailable","content":{"text":{"schema":{"type":"string","example":"The server is not ready to handle the request."}}}}},"servers":[{"url":"https://{server-url}"}],"method":"post","path":"/api/pushScenarioState/bpns/{bpns}/scenarioId/{scenarioId}/state/{state}","info":{"title":"OSim API","description":"OSim API for requesting and receiving simulation results","version":"3.0.0"},"postman":{"name":"push Scenario State","description":{"content":"The pushScenarioState enables distribution of a new scenario status and thus a notification of the procedure with the planned scenario","type":"text/plain"},"url":{"path":["api","pushScenarioState","bpns",":bpns","scenarioId",":scenarioId","state",":state"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"bpns"},{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"scenarioId"},{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"state"}]},"header":[{"key":"Content-Type","value":"text/plain"},{"key":"Accept","value":"text"}],"method":"POST","body":{"mode":"raw","raw":"\"\""}}} +sidebar_class_name: "post api-method" info_path: docs-kits/kits/OSim Kit/Software Development View//osim-api custom_edit_url: null --- @@ -26,7 +26,7 @@ import TabItem from "@theme/TabItem"; The pushScenarioState enables distribution of a new scenario status and thus a notification of the procedure with the planned scenario -
Path Parameters
+
Path Parameters
Request Body
  • string
OK diff --git a/docs-kits/kits/OSim Kit/Software Development View/sidebar.js b/docs-kits/kits/OSim Kit/Software Development View/sidebar.js index 4b9d63c21a8..78d82355043 100644 --- a/docs-kits/kits/OSim Kit/Software Development View/sidebar.js +++ b/docs-kits/kits/OSim Kit/Software Development View/sidebar.js @@ -1,87 +1,87 @@ module.exports = [ - { type: 'doc', id: 'kits/OSim Kit/Software Development View//osim-api' }, + { type: "doc", id: "kits/OSim Kit/Software Development View//osim-api" }, { - type: 'category', - label: 'requestLatestSimulationResult', + type: "category", + label: "requestLatestSimulationResult", link: { - type: 'generated-index', - title: 'requestLatestSimulationResult', - slug: '/category/kits/OSim Kit/Software Development View/request-latest-simulation-result', + type: "generated-index", + title: "requestLatestSimulationResult", + slug: "/category/kits/OSim Kit/Software Development View/request-latest-simulation-result", }, items: [ { - type: 'doc', - id: 'kits/OSim Kit/Software Development View//request-latest-simulation-result', - label: 'requestLatestSimulationResult', - className: 'api-method get', + type: "doc", + id: "kits/OSim Kit/Software Development View//", + label: "Missing summary", + className: "api-method get", }, ], }, { - type: 'category', - label: 'receiveLatestSimulationResult', + type: "category", + label: "receiveLatestSimulationResult", link: { - type: 'generated-index', - title: 'receiveLatestSimulationResult', - slug: '/category/kits/OSim Kit/Software Development View/receive-latest-simulation-result', + type: "generated-index", + title: "receiveLatestSimulationResult", + slug: "/category/kits/OSim Kit/Software Development View/receive-latest-simulation-result", }, items: [ { - type: 'doc', - id: 'kits/OSim Kit/Software Development View//receive-latest-simulation-result', - label: 'receiveLatestSimulationResult', - className: 'api-method post', + type: "doc", + id: "kits/OSim Kit/Software Development View//", + label: "Missing summary", + className: "api-method post", }, ], }, { - type: 'category', - label: 'requestScenarioFeedback', + type: "category", + label: "requestScenarioFeedback", link: { - type: 'generated-index', - title: 'requestScenarioFeedback', - slug: '/category/kits/OSim Kit/Software Development View/request-scenario-feedback', + type: "generated-index", + title: "requestScenarioFeedback", + slug: "/category/kits/OSim Kit/Software Development View/request-scenario-feedback", }, items: [ { - type: 'doc', - id: 'kits/OSim Kit/Software Development View//request-scenario-feedback', - label: 'requestScenarioFeedback', - className: 'api-method post', + type: "doc", + id: "kits/OSim Kit/Software Development View//", + label: "Missing summary", + className: "api-method post", }, ], }, { - type: 'category', - label: 'receiveScenarioFeedback', + type: "category", + label: "receiveScenarioFeedback", link: { - type: 'generated-index', - title: 'receiveScenarioFeedback', - slug: '/category/kits/OSim Kit/Software Development View/receive-scenario-feedback', + type: "generated-index", + title: "receiveScenarioFeedback", + slug: "/category/kits/OSim Kit/Software Development View/receive-scenario-feedback", }, items: [ { - type: 'doc', - id: 'kits/OSim Kit/Software Development View//receive-scenario-feedback', - label: 'receiveScenarioFeedback', - className: 'api-method get', + type: "doc", + id: "kits/OSim Kit/Software Development View//", + label: "Missing summary", + className: "api-method get", }, ], }, { - type: 'category', - label: 'pushScenarioState', + type: "category", + label: "pushScenarioState", link: { - type: 'generated-index', - title: 'pushScenarioState', - slug: '/category/kits/OSim Kit/Software Development View/push-scenario-state', + type: "generated-index", + title: "pushScenarioState", + slug: "/category/kits/OSim Kit/Software Development View/push-scenario-state", }, items: [ { - type: 'doc', - id: 'kits/OSim Kit/Software Development View//push-scenario-state', - label: 'pushScenarioState', - className: 'api-method get', + type: "doc", + id: "kits/OSim Kit/Software Development View//", + label: "Missing summary", + className: "api-method post", }, ], }, diff --git a/docs-kits/kits/OSim Kit/page_adoption-view.md b/docs-kits/kits/OSim Kit/page_adoption-view.md index 333cfe3de2a..666e9065989 100644 --- a/docs-kits/kits/OSim Kit/page_adoption-view.md +++ b/docs-kits/kits/OSim Kit/page_adoption-view.md @@ -1,7 +1,7 @@ --- id: Adoption View OSim Kit title: Adoption View -description: 'OSim Kit' +description: "OSim Kit" sidebar_position: 2 --- @@ -12,6 +12,7 @@ sidebar_position: 2 ## Vision & Mission + **Gain increased supply chain transparency through collaborative simulation across all stakeholders**. **Combine simulations of plants internally with simulations of external logistics over multiple tiers**. @@ -22,7 +23,7 @@ An open architecture for integrating partners of all kinds together with standar **Integrate any supply chain partner**. -Even partners that do not use any simulation tool can contribute to the overall transparency through the well-defined information requirements. +Even partners that do not use any simulation tool can contribute to the overall transparency through the well-defined information requirements. **Integrate any simulation tool**. @@ -69,9 +70,9 @@ See also the following publications for more detailed description of the process The Semantic Model MaterialFlowSimulationResult summarizes simulation results of the individual partners and is used for data exchange along the supply chain. -The *MaterialFlowSimulationResult* object will be sent by OSim partner to another OSim partner on a higher tier level. OSim partner can be a producing company as well as a logistics company. +The _MaterialFlowSimulationResult_ object will be sent by OSim partner to another OSim partner on a higher tier level. OSim partner can be a producing company as well as a logistics company. -Every *MaterialFlowSimulationResult* includes information about delivery readiness of packaged material goods, like material identifier, amount, delivery time and destination. +Every _MaterialFlowSimulationResult_ includes information about delivery readiness of packaged material goods, like material identifier, amount, delivery time and destination. #### Structure of the Materialflow Simulation Result @@ -82,7 +83,7 @@ The MaterialFlowSimulationResult semantic model contains 4 hierarchical entities - HandlingUnit - MaterialBatch -One *MaterialFlowSimulationResult* refers to one or more Shipments. +One _MaterialFlowSimulationResult_ refers to one or more Shipments. **Shipment** describes a delivery approach with information about source, destination and delivery time. One Shipment refers to one or more HandlingUnits. @@ -92,19 +93,19 @@ One *MaterialFlowSimulationResult* refers to one or more Shipments. #### Aspect Model -Github Link to semantic data model: +Github Link to semantic data model: ### Materialflow Scenario Request (MaterialFlowScenarioRequest) -The Semantic Model *MaterialFlowScenarioRequest* includes scenario related information of the individual partners and is used for data exchange along the supply chain in regard to “What-If” scenarios. +The Semantic Model _MaterialFlowScenarioRequest_ includes scenario related information of the individual partners and is used for data exchange along the supply chain in regard to “What-If” scenarios. -The *MaterialFlowScenarioRequest* object will be sent by OSim partner to another OSim partner (possible in both directions: up and down). OSim partner can be a producing company as well as a logistics company. +The _MaterialFlowScenarioRequest_ object will be sent by OSim partner to another OSim partner (possible in both directions: up and down). OSim partner can be a producing company as well as a logistics company. -Every *MaterialFlowScenarioRequest* includes information about the scenario description, scenario parameters (optional) and two simulation results analogues to the MaterialFlowSimulationResult (one with the unchanged and another one with the changed situation, allowing verification of scenario impact through comparison). +Every _MaterialFlowScenarioRequest_ includes information about the scenario description, scenario parameters (optional) and two simulation results analogues to the MaterialFlowSimulationResult (one with the unchanged and another one with the changed situation, allowing verification of scenario impact through comparison). #### Structure of the Materialflow Scenario Request -The *MaterialFlowScenarioRequest* semantic model contains 4 entities: +The _MaterialFlowScenarioRequest_ semantic model contains 4 entities: - Scenario Header - Scenario Parameters (optional) @@ -121,7 +122,7 @@ The *MaterialFlowScenarioRequest* semantic model contains 4 entities: #### Aspect Model -Github Link to semantic data model: +Github Link to semantic data model: ## Logic & Schema @@ -228,12 +229,12 @@ To verify the participants Catena-X membership, the Membership verifiable creden ```json { - "@type": "Constraint", - "odrl:leftOperand": "Membership", - "odrl:operator": { - "@id": "odrl:eq" - }, - "odrl:rightOperand": "active" + "@type": "Constraint", + "odrl:leftOperand": "Membership", + "odrl:operator": { + "@id": "odrl:eq" + }, + "odrl:rightOperand": "active" } ``` @@ -241,16 +242,21 @@ To verify the participants Catena-X membership, the Membership verifiable creden Our relevant standards can be downloaded from the official [Catena-X Standard Library](https://catena-x.net/de/standard-library): -- [CX - 0072 OSim Process and Core Business Logic v1.0.0](https://catena-x.net/fileadmin/user_upload/Standard-Bibliothek/Update_September23/CX-0072-OSimProcessAndCoreBusinessLogic-v1.0.0.pdf) -- [CX - 0073 OSim API v1.0.0](https://catena-x.net/fileadmin/user_upload/Standard-Bibliothek/Update_September23/CX-0073-OSimAPI-v1.0.0.pdf) -- [CX - 0087 OSim Data Model Materialflow Simulation Result v1.0.0](https://catena-x.net/fileadmin/user_upload/Standard-Bibliothek/Update_September23/CX-0087-OSimDataModelMaterialFlowSimulationResult-v1.0.0.pdf) -- [CX - 0133 Online Control and Simulation v1.0.0](https://catena-x.net/de/standard-library) +- [CX - 0133 Online Control and Simulation v2.0.0](https://catenax-ev.github.io/docs/next/standards/CX-0133-OnlineControlandSimulation) + +## Product Documentation + +A deeper understanding of the basic Online Control and Simulation use case can be gained from the following linked document. While in the OSIM-KIT only the standardized partner interface of OSim is considered, the OSim product documentation represents the complete technical specification of the use case. + +- [OSim - Product Documentation_EN](./OSim-Product-Documentation-EN.pdf) ## Notice This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode). - SPDX-License-Identifier: CC-BY-4.0 +- SPDX-FileCopyrightText: 2024,Fraunhofer Institute for Manufacturing Engineering and Automation IPA - SPDX-FileCopyrightText: 2024,Fraunhofer Institute for Factory Operation and Automation IFF +- SPDX-FileCopyrightText: 2024,German Edge Cloud GmbH & Co.KG - SPDX-FileCopyrightText: 2024,Siemens AG - Source URL: [https://github.com/eclipse-tractusx/eclipse-tractusx.github.io](https://github.com/eclipse-tractusx/eclipse-tractusx.github.io) diff --git a/docs-kits/kits/OSim Kit/page_changelog.md b/docs-kits/kits/OSim Kit/page_changelog.md index b41621b8099..70fc703cb37 100644 --- a/docs-kits/kits/OSim Kit/page_changelog.md +++ b/docs-kits/kits/OSim Kit/page_changelog.md @@ -11,6 +11,25 @@ sidebar_position: 1 All notable changes to this Kit will be documented in this file. +## [3.0.0] - 2024-08-01 + +### Added + +- Adoption View: + - Added new Chapter Product documentation with a link to the document. + +### Changed + +- Adoption View: + - Updated the aspect model references to the newest version. +- Development View: + - Updated the API descriptions in accordance with the newest OSim standardization document CX-133 + +### Removed + +- Adoption View: + - References to the obsolete OSim Standards. + ## [2.0.0] – 2024-03-08 ### Added diff --git a/openApi/resiliency/kit_osim_openAPI.yaml b/openApi/resiliency/kit_osim_openAPI.yaml new file mode 100644 index 00000000000..23e34a4b5b7 --- /dev/null +++ b/openApi/resiliency/kit_osim_openAPI.yaml @@ -0,0 +1,980 @@ +openapi: 3.0.1 +info: + title: OSim API + description: OSim API for requesting and receiving simulation results as well as for interactions related to scenario management. + version: 2.0.0 +servers: + - url: https://{server-url} +tags: + - name: requestLatestSimulationResult + description: Request Latest Simulation Result + - name: receiveLatestSimulationResult + description: Receive Latest Simulation Result + - name: requestScenarioFeedback + description: Request Scenario Feedback + - name: receiveScenarioFeedback + description: Receive Scenario Feedback +paths: + /api/requestLatestSimulationResult/bpns/{bpns}/requestId/{requestId}/simulationRunId/{simulationRunId}: + get: + tags: + - requestLatestSimulationResult + operationId: requestLatestSimulationResult + description: Request latest simulation result by referring the latest simulation run id available in own OSim Manager + parameters: + - name: requestId + in: path + required: true + style: simple + explode: false + schema: + type: string + example: 8d628899-3e6f-4666-91c3-74ee7ab88b2b + - name: bpns + in: path + required: true + style: simple + explode: false + schema: + type: string + example: BPNS00000007OTZ3 + - name: simulationRunId + in: path + required: true + style: simple + explode: false + schema: + type: string + example: 50737df3-4237-4652-b092-1ef8649f6ca6 + responses: + '200': + description: OK + content: + text: + schema: + type: string + example: The request has succeeded. The requestLatestSimulationResult has been successfully processed in the backend system. + '400': + description: Bad request + content: + text: + schema: + type: string + example: The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing). + '401': + description: Unauthorized + content: + text: + schema: + type: string + example: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. + '402': + description: Unknown BPNS + content: + text: + schema: + type: string + example: The BPNS which is given as parameter is not registered in the data provider database as a direct partner. + '403': + description: Forbidden + content: + text: + schema: + type: string + example: The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. + '404': + description: No simulation results are released + content: + text: + schema: + type: string + example: Data provider doesn’t have any released simulation results + '405': + description: Method not allowed + content: + text: + schema: + type: string + example: The method used to request the data was not GET + '406': + description: No newer simulation available + content: + text: + schema: + type: string + example: The simulationRunId which is given as parameter is identical to the currently released simulation run in the data provider database + '407': + description: No shipments planned + content: + text: + schema: + type: string + example: No shipments are currently planned for the requestor + '500': + description: Internal server error + content: + text: + schema: + type: string + example: The server has encountered a situation it does not know how to handle. + '501': + description: Service unavailable + content: + text: + schema: + type: string + example: The server is not ready to handle the request. + servers: + - url: https://{server-url} + servers: + - url: https://{server-url} + /api/receiveLatestSimulationResult/requestId/{requestId}: + post: + tags: + - receiveLatestSimulationResult + description: Receive latest simulation result which can be stored in own OSim Manager instance + operationId: receiveLatestSimulationResult + parameters: + - name: requestId + in: path + required: true + style: simple + explode: false + schema: + type: string + example: 8d628899-3e6f-4666-91c3-74ee7ab88b2b + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/requestId_requestId_body' + examples: + '0': + value: |- + { + "owner": { "id": "BPNS00000007OTZ3" }, + "dataQuality": 1, + "description": "Daily standard simulation", + "comment": "successful simulation", + "expirationTimestamp": "2023-03-24T09:15:24.000Z", + "runId": "0fece48b-c8d1-4180-1a9caca6d67e", + "shipments": [ + { + "handlingUnits": [ + { + "name": "Palette", + "volume": 1, + "weight": 189, + "batches": [ + { + "unitOfMeasurement": "KG", + "materialName": "KK1000GR-Gehäuse-Rot", + "quantity": 50, + "materialNumber": "KK1000GR", + "batchOrderId": "Order-0001", + "batchId": "Batch_1", + "hazardousGoods": false, + "batchExpirationTimestamp": "2023-08-22T16:00:00.000Z", + "batchNumber": "45" + } + ], + "handlingUnitId": "HUT_1", + "amount": 1 + } + ], + "shipmentId": "DE51515151", + "recipientTimestampPlanned": "2023-04-19T09:00:00.000Z", + "destination": { "id": "BPNS00000007OTZ3" }, + "recipient": { "id": "BPNS00000007OTZ4" }, + "logistics": { "id": "BPNS00000007OS0H" }, + "preceding": {}, + "splittingAllowed": true, + "destinationTimestamp": "2023-03-19T09:00:00.000Z" + } + ], + "timestamp": "2023-03-09T14:13:42.806Z" + } + responses: + '200': + description: OK + content: + text: + schema: + type: string + example: The POST has succeeded. The receiveLatestSimulationResult has been successfully processed in the backend system. + '400': + description: Bad request + content: + text: + schema: + type: string + example: The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing). + '401': + description: Unauthorized + content: + text: + schema: + type: string + example: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. + '402': + description: Payload is empty + content: + text: + schema: + type: string + example: The payload of the API call is empty. + '403': + description: Forbidden + content: + text: + schema: + type: string + example: The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. + '404': + description: Payload structure unknown + content: + text: + schema: + type: string + example: The payload structure is unknown or correspond not to the defined semantic model + '405': + description: Method not allowed + content: + text: + schema: + type: string + example: The method used to receive the data was not POST + '406': + description: Payload content invalid + content: + text: + schema: + type: string + example: The content of the payload is invalid. E.g. “owner unknown” + '500': + description: Internal server error + content: + text: + schema: + type: string + example: The server has encountered a situation it does not know how to handle. + '501': + description: Service unavailable + content: + text: + schema: + type: string + example: The server is not ready to handle the request. + servers: + - url: https://{server-url} + servers: + - url: https://{server-url} + /api/requestScenarioFeedback/bpns/{bpns}: + post: + tags: + - requestScenarioFeedback + operationId: requestScenarioFeedback + description: The requestScenarioFeedback is a request from a OSim partner for feedback on the possible fulfillment of the described scenario. + parameters: + - name: bpns + in: path + required: true + style: simple + explode: false + schema: + type: string + example: BPNS00000007OTZ3 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/bpns_bpns_body' + examples: + '0': + value: |- + { + "materialFlowScenarioRequest" : { + "scenarioSimResults" : { + "resultOwnId" : "916b5688-8bd8-4d7e-83b9-e0d40939274e", + "resultOwnSimRunInitial" : { + "owner" : { }, + "dataQuality" : 0, + "description" : "Please simulate asap", + "comment" : "successful simulation ", + "expirationTimestamp" : "2023-03-24T09:15:24.000Z", + "runId" : "0fece48b-c8d1-4180-1a9caca6d67e", + "shipments" : [ { + "handlingUnits" : [ { + "name" : "Palette", + "volume" : 1.0, + "weight" : 189.0, + "batches" : [ { + "unitOfMeasurement" : "KG", + "materialName" : "KK1000GR-Gehäuse-Rot", + "quantity" : 50.0, + "materialNumber" : "KK1000GR", + "materialHazardousGoods" : false, + "batchOrderId" : "Order-0001", + "batchId" : "Batch_1", + "batchExpirationTimestamp" : "2023-08-22T16:00:00.000Z", + "batchNumber" : "45" + } ], + "handlingUnitId" : "HUT_1", + "amount" : 1 + } ], + "shipmentId" : "DE51515151", + "recipientTimestampPlanned" : "2023-04-19T09:00:00.000Z", + "destination" : { }, + "recipient" : { }, + "logistics" : { }, + "preceding" : { }, + "splittingAllowed" : true, + "destinationTimestamp" : "2023-03-19T09:00:00.000Z" + } ], + "timestamp" : "2023-03-09T14:13:42.806Z" + }, + "resultOwnSimRunUpdated" : { + "owner" : { }, + "dataQuality" : 0, + "description" : "Please simulate asap", + "comment" : "successful simulation ", + "expirationTimestamp" : "2023-03-24T09:15:24.000Z", + "runId" : "0fece48b-c8d1-4180-1a9caca6d67e", + "shipments" : [ { + "handlingUnits" : [ { + "name" : "Palette", + "volume" : 1.0, + "weight" : 189.0, + "batches" : [ { + "unitOfMeasurement" : "KG", + "materialName" : "KK1000GR-Gehäuse-Rot", + "quantity" : 50.0, + "materialNumber" : "KK1000GR", + "materialHazardousGoods" : false, + "batchOrderId" : "Order-0001", + "batchId" : "Batch_1", + "batchExpirationTimestamp" : "2023-08-22T16:00:00.000Z", + "batchNumber" : "45" + } ], + "handlingUnitId" : "HUT_1", + "amount" : 1 + } ], + "shipmentId" : "DE51515151", + "recipientTimestampPlanned" : "2023-04-19T09:00:00.000Z", + "destination" : { }, + "recipient" : { }, + "logistics" : { }, + "preceding" : { }, + "splittingAllowed" : true, + "destinationTimestamp" : "2023-03-19T09:00:00.000Z" + } ], + "timestamp" : "2023-03-09T14:13:42.806Z" + } + }, + "scenarioParameter" : { + "unitOfMeasurement" : "KG", + "parameterScenario" : "8d464b8b-6977-4952-8a22-0489067ca081", + "parameterComment" : "updated Delivery Date", + "materialName" : "KK1000GR-Gehäuse-Rot", + "parameterQuantityUpdated" : 1.0, + "parameterId" : "847c71e5-614a-468b-a3a0-674bf2af3004", + "materialNumber" : "KK1000GR", + "parameterDeliveryDateUpdated" : "2023-10-10T09:00:00.000Z", + "parameterDeliveryDateInitial" : "2023-10-09T10:00:00.000Z", + "parameterOrderId" : "OID-011123456", + "parameterQuantityInitial" : 1.0 + }, + "scenarioHeader" : { + "scenarioOwnerRole" : "Customer", + "scenarioCreationTimestamp" : "2023-10-04T09:10:00.000Z", + "scenarioExpirationTimestamp" : "2023-10-07T09:10:00.000Z", + "scenarioOwner" : "BPNS0000007OTZ3", + "scenarioDescription" : "Changes in Delivery Date", + "scenarioId" : "8d464b8b-6977-4952-8a22-0489067ca081", + "scenarioTitle" : "Delivery Modification" + } + } + } + responses: + '200': + description: OK + content: + text: + schema: + type: string + example: The request has succeeded. The requestScenarioFeedback has been successfully processed in the backend system. + '400': + description: Bad request + content: + text: + schema: + type: string + example: The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing). + '401': + description: Unauthorized + content: + text: + schema: + type: string + example: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. + '402': + description: Unknown BPNS + content: + text: + schema: + type: string + example: The BPNS which is given as parameter is not registered in the data provider database as a direct partner. + '403': + description: Forbidden + content: + text: + schema: + type: string + example: The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. + '405': + description: Method not allowed + content: + text: + schema: + type: string + example: The method used to request a scenario feedback was not POST + '500': + description: Internal server error + content: + text: + schema: + type: string + example: The server has encountered a situation it does not know how to handle. + '501': + description: Service unavailable + content: + text: + schema: + type: string + example: The server is not ready to handle the request. + servers: + - url: https://{server-url} + servers: + - url: https://{server-url} + /api/receiveScenarioFeedback/bpns/{bpns}/scenarioId/{scenarioId}/feedback/{feedback}: + get: + tags: + - receiveScenarioFeedback + operationId: receiveScenarioFeedback + description: The receiveScenarioFeedback enables the requestor to transmit the result of his scenario-based evaluation to the requestor + parameters: + - name: bpns + in: path + required: true + style: simple + explode: false + schema: + type: string + example: BPNS00000007OTZ3 + - name: scenarioId + in: path + required: true + style: simple + explode: false + schema: + type: string + example: 50737df3-4237-4652-b092-1ef8649f6ca6 + - name: feedback + in: path + required: true + style: simple + explode: false + schema: + type: string + enum: + - Realizable + - NotRealizable + example: Realizable + responses: + '200': + description: OK + content: + text: + schema: + type: string + example: The GET request has succeeded. The receiveScenarioFeedback has been successfully processed in the backend system. + '400': + description: Bad request + content: + text: + schema: + type: string + example: The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing). + '401': + description: Unauthorized + content: + text: + schema: + type: string + example: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. + '402': + description: Unknown BPNS + content: + text: + schema: + type: string + example: The BPNS which is given as parameter is not registered in the data provider database as a direct partner. + '403': + description: Forbidden + content: + text: + schema: + type: string + example: The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. + '405': + description: Method not allowed + content: + text: + schema: + type: string + example: The method used to request a scenario feedback was not GET + '406': + description: Unknown Scenario + content: + text: + schema: + type: string + example: The scenarioID which is given as parameter is not registered. + '407': + description: Unknown State + content: + text: + schema: + type: string + example: The feedbackState value is unknown. + '500': + description: Internal server error + content: + text: + schema: + type: string + example: The server has encountered a situation it does not know how to handle. + '501': + description: Service unavailable + content: + text: + schema: + type: string + example: The server is not ready to handle the request. + servers: + - url: https://{server-url} + servers: + - url: https://{server-url} + /api/pushScenarioState/bpns/{bpns}/scenarioId/{scenarioId}/state/{state}: + get: + tags: + - pushScenarioState + operationId: pushScenarioState + description: The pushScenarioState enables distribution of a new scenario status and thus a notification of the procedure with the planned scenario + parameters: + - name: bpns + in: path + required: true + style: simple + explode: false + schema: + type: string + example: BPNS00000007OTZ3 + - name: scenarioId + in: path + required: true + style: simple + explode: false + schema: + type: string + example: 50737df3-4237-4652-b092-1ef8649f6ca6 + - name: state + in: path + required: true + style: simple + explode: false + schema: + type: string + enum: + - InRealization + - Processed + - Canceled + example: InRealization + responses: + '200': + description: OK + content: + text: + schema: + type: string + example: The GET has succeeded. The pushScenarioState has been successfully processed in the backend system. + '400': + description: Bad request + content: + text: + schema: + type: string + example: The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing). + '401': + description: Unauthorized + content: + text: + schema: + type: string + example: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. + '402': + description: Unknown BPNS + content: + text: + schema: + type: string + example: The BPNS which is given as parameter is not registered in the data provider database as a direct partner. + '403': + description: Forbidden + content: + text: + schema: + type: string + example: The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. + '405': + description: Method not allowed + content: + text: + schema: + type: string + example: The method used to request a scenario feedback was not GET + '406': + description: Unknown Scenario + content: + text: + schema: + type: string + example: The scenarioID which is given as parameter is not registered. + '407': + description: Unknown State + content: + text: + schema: + type: string + example: The scenarioState value is unknown. + '500': + description: Internal server error + content: + text: + schema: + type: string + example: The server has encountered a situation it does not know how to handle. + '501': + description: Service unavailable + content: + text: + schema: + type: string + example: The server is not ready to handle the request. + servers: + - url: https://{server-url} + servers: + - url: https://{server-url} +components: + schemas: + apireceiveLatestSimulationResultrequestIdrequestId_owner: + type: object + properties: + id: + type: string + apireceiveLatestSimulationResultrequestIdrequestId_batches: + type: object + properties: + unitOfMeasurement: + type: string + materialName: + type: string + quantity: + type: integer + materialNumber: + type: string + batchOrderId: + type: string + batchId: + type: string + hazardousGoods: + type: boolean + batchExpirationTimestamp: + type: string + batchNumber: + type: string + apireceiveLatestSimulationResultrequestIdrequestId_handlingUnits: + type: object + properties: + volume: + type: integer + batches: + type: array + items: + $ref: '#/components/schemas/apireceiveLatestSimulationResultrequestIdrequestId_batches' + handlingUnitId: + type: string + amount: + type: integer + name: + type: string + weight: + type: integer + apireceiveLatestSimulationResultrequestIdrequestId_shipments: + type: object + properties: + handlingUnits: + type: array + items: + $ref: '#/components/schemas/apireceiveLatestSimulationResultrequestIdrequestId_handlingUnits' + shipmentId: + type: string + recipientTimestampPlanned: + type: string + destination: + $ref: '#/components/schemas/apireceiveLatestSimulationResultrequestIdrequestId_owner' + recipient: + $ref: '#/components/schemas/apireceiveLatestSimulationResultrequestIdrequestId_owner' + logistics: + $ref: '#/components/schemas/apireceiveLatestSimulationResultrequestIdrequestId_owner' + preceding: + type: object + properties: {} + splittingAllowed: + type: boolean + destinationTimestamp: + type: string + requestId_requestId_body: + type: object + properties: + owner: + $ref: '#/components/schemas/apireceiveLatestSimulationResultrequestIdrequestId_owner' + dataQuality: + type: integer + description: + type: string + comment: + type: string + expirationTimestamp: + type: string + runId: + type: string + shipments: + type: array + items: + $ref: '#/components/schemas/apireceiveLatestSimulationResultrequestIdrequestId_shipments' + timestamp: + type: string + apirequestScenarioFeedbackbpnsbpns_materialFlowScenarioRequest_scenarioSimResults_resultOwnSimRunInitial_batches: + required: + - batchExpirationTimestamp + - batchId + - batchNumber + - batchOrderId + - materialHazardousGoods + - materialName + - materialNumber + - quantity + - unitOfMeasurement + type: object + properties: + unitOfMeasurement: + type: string + materialName: + type: string + quantity: + type: number + materialNumber: + type: string + materialHazardousGoods: + type: boolean + batchOrderId: + type: string + batchId: + type: string + batchExpirationTimestamp: + type: string + batchNumber: + type: string + apirequestScenarioFeedbackbpnsbpns_materialFlowScenarioRequest_scenarioSimResults_resultOwnSimRunInitial_handlingUnits: + required: + - amount + - batches + - handlingUnitId + - name + - volume + - weight + type: object + properties: + name: + type: string + volume: + type: number + weight: + type: number + batches: + type: array + items: + $ref: '#/components/schemas/apirequestScenarioFeedbackbpnsbpns_materialFlowScenarioRequest_scenarioSimResults_resultOwnSimRunInitial_batches' + handlingUnitId: + type: string + amount: + type: integer + apirequestScenarioFeedbackbpnsbpns_materialFlowScenarioRequest_scenarioSimResults_resultOwnSimRunInitial_shipments: + required: + - destination + - destinationTimestamp + - handlingUnits + - logistics + - preceding + - recipient + - recipientTimestampPlanned + - shipmentId + - splittingAllowed + type: object + properties: + handlingUnits: + type: array + items: + $ref: '#/components/schemas/apirequestScenarioFeedbackbpnsbpns_materialFlowScenarioRequest_scenarioSimResults_resultOwnSimRunInitial_handlingUnits' + shipmentId: + type: string + recipientTimestampPlanned: + type: string + destination: + type: object + recipient: + type: object + logistics: + type: object + preceding: + type: object + splittingAllowed: + type: boolean + destinationTimestamp: + type: string + apirequestScenarioFeedbackbpnsbpns_materialFlowScenarioRequest_scenarioSimResults_resultOwnSimRunInitial: + required: + - comment + - dataQuality + - description + - expirationTimestamp + - owner + - runId + - shipments + - timestamp + type: object + properties: + owner: + type: object + dataQuality: + type: integer + description: + type: string + comment: + type: string + expirationTimestamp: + type: string + runId: + type: string + shipments: + type: array + items: + $ref: '#/components/schemas/apirequestScenarioFeedbackbpnsbpns_materialFlowScenarioRequest_scenarioSimResults_resultOwnSimRunInitial_shipments' + timestamp: + type: string + apirequestScenarioFeedbackbpnsbpns_materialFlowScenarioRequest_scenarioSimResults: + required: + - resultOwnId + - resultOwnSimRunInitial + - resultOwnSimRunUpdated + type: object + properties: + resultOwnId: + type: string + resultOwnSimRunInitial: + $ref: '#/components/schemas/apirequestScenarioFeedbackbpnsbpns_materialFlowScenarioRequest_scenarioSimResults_resultOwnSimRunInitial' + resultOwnSimRunUpdated: + $ref: '#/components/schemas/apirequestScenarioFeedbackbpnsbpns_materialFlowScenarioRequest_scenarioSimResults_resultOwnSimRunInitial' + apirequestScenarioFeedbackbpnsbpns_materialFlowScenarioRequest_scenarioParameter: + required: + - materialName + - materialNumber + - parameterComment + - parameterDeliveryDateInitial + - parameterDeliveryDateUpdated + - parameterId + - parameterOrderId + - parameterQuantityInitial + - parameterQuantityUpdated + - parameterScenario + - unitOfMeasurement + type: object + properties: + unitOfMeasurement: + type: string + parameterScenario: + type: string + parameterComment: + type: string + materialName: + type: string + parameterQuantityUpdated: + type: number + parameterId: + type: string + materialNumber: + type: string + parameterDeliveryDateUpdated: + type: string + parameterDeliveryDateInitial: + type: string + parameterOrderId: + type: string + parameterQuantityInitial: + type: number + apirequestScenarioFeedbackbpnsbpns_materialFlowScenarioRequest_scenarioHeader: + required: + - scenarioCreationTimestamp + - scenarioDescription + - scenarioExpirationTimestamp + - scenarioId + - scenarioOwner + - scenarioOwnerRole + - scenarioTitle + type: object + properties: + scenarioOwnerRole: + type: string + scenarioCreationTimestamp: + type: string + scenarioExpirationTimestamp: + type: string + scenarioOwner: + type: string + scenarioDescription: + type: string + scenarioId: + type: string + scenarioTitle: + type: string + apirequestScenarioFeedbackbpnsbpns_materialFlowScenarioRequest: + required: + - scenarioHeader + - scenarioParameter + - scenarioSimResults + type: object + properties: + scenarioSimResults: + $ref: '#/components/schemas/apirequestScenarioFeedbackbpnsbpns_materialFlowScenarioRequest_scenarioSimResults' + scenarioParameter: + $ref: '#/components/schemas/apirequestScenarioFeedbackbpnsbpns_materialFlowScenarioRequest_scenarioParameter' + scenarioHeader: + $ref: '#/components/schemas/apirequestScenarioFeedbackbpnsbpns_materialFlowScenarioRequest_scenarioHeader' + bpns_bpns_body: + required: + - materialFlowScenarioRequest + type: object + properties: + materialFlowScenarioRequest: + $ref: '#/components/schemas/apirequestScenarioFeedbackbpnsbpns_materialFlowScenarioRequest' diff --git a/openApi/resiliency/osim-api.json b/openApi/resiliency/osim-api.json deleted file mode 100755 index f602eebe3f2..00000000000 --- a/openApi/resiliency/osim-api.json +++ /dev/null @@ -1,1266 +0,0 @@ -{ - "openapi": "3.0.1", - "info": { - "title": "OSim API", - "description": "OSim API for requesting and receiving simulation results as well as for interactions related to scenario management.", - "version": "2.0.0" - }, - "servers": [ - { - "url": "https://{server-url}" - } - ], - "tags": [ - { - "name": "requestLatestSimulationResult", - "description": "Request Latest Simulation Result" - }, - { - "name": "receiveLatestSimulationResult", - "description": "Receive Latest Simulation Result" - }, - { - "name": "requestScenarioFeedback", - "description": "Request Scenario Feedback" - }, - { - "name": "receiveScenarioFeedback", - "description": "Receive Scenario Feedback" - } - ], - "paths": { - "/api/requestLatestSimulationResult/bpns/{bpns}/requestId/{requestId}/simulationRunId/{simulationRunId}": { - "get": { - "tags": ["requestLatestSimulationResult"], - "operationId": "requestLatestSimulationResult", - "description": "Request latest simulation result by referring the latest simulation run id available in own OSim Manager", - "parameters": [ - { - "name": "requestId", - "in": "path", - "required": true, - "style": "simple", - "explode": false, - "schema": { - "type": "string" - }, - "example": "8d628899-3e6f-4666-91c3-74ee7ab88b2b" - }, - { - "name": "bpns", - "in": "path", - "required": true, - "style": "simple", - "explode": false, - "schema": { - "type": "string" - }, - "example": "BPNS00000007OTZ3" - }, - { - "name": "simulationRunId", - "in": "path", - "required": true, - "style": "simple", - "explode": false, - "schema": { - "type": "string" - }, - "example": "50737df3-4237-4652-b092-1ef8649f6ca6" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "text": { - "schema": { - "type": "string", - "example": "The request has succeeded. The requestLatestSimulationResult has been successfully processed in the backend system." - } - } - } - }, - "400": { - "description": "Bad request", - "content": { - "text": { - "schema": { - "type": "string", - "example": "The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing)." - } - } - } - }, - "401": { - "description": "Unauthorized", - "content": { - "text": { - "schema": { - "type": "string", - "example": "Although the HTTP standard specifies \"unauthorized\", semantically this response means \"unauthenticated\". That is, the client must authenticate itself to get the requested response." - } - } - } - }, - "402": { - "description": "Unknown BPNS", - "content": { - "text": { - "schema": { - "type": "string", - "example": "The BPNS which is given as parameter is not registered in the data provider database as a direct partner." - } - } - } - }, - "403": { - "description": "Forbidden", - "content": { - "text": { - "schema": { - "type": "string", - "example": "The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource." - } - } - } - }, - "404": { - "description": "No simulation results are released", - "content": { - "text": { - "schema": { - "type": "string", - "example": "Data provider doesn’t have any released simulation results" - } - } - } - }, - "405": { - "description": "Method not allowed", - "content": { - "text": { - "schema": { - "type": "string", - "example": "The method used to request the data was not GET" - } - } - } - }, - "406": { - "description": "No newer simulation available", - "content": { - "text": { - "schema": { - "type": "string", - "example": "The simulationRunId which is given as parameter is identical to the currently released simulation run in the data provider database" - } - } - } - }, - "407": { - "description": "No shipments planned", - "content": { - "text": { - "schema": { - "type": "string", - "example": "No shipments are currently planned for the requestor" - } - } - } - }, - "500": { - "description": "Internal server error", - "content": { - "text": { - "schema": { - "type": "string", - "example": "The server has encountered a situation it does not know how to handle." - } - } - } - }, - "501": { - "description": "Service unavailable", - "content": { - "text": { - "schema": { - "type": "string", - "example": "The server is not ready to handle the request." - } - } - } - } - }, - "servers": [ - { - "url": "https://{server-url}" - } - ] - }, - "servers": [ - { - "url": "https://{server-url}" - } - ] - }, - "/api/receiveLatestSimulationResult/requestId/{requestId}": { - "post": { - "tags": ["receiveLatestSimulationResult"], - "description": "Receive latest simulation result which can be stored in own OSim Manager instance", - "operationId": "receiveLatestSimulationResult", - "parameters": [ - { - "name": "requestId", - "in": "path", - "required": true, - "style": "simple", - "explode": false, - "schema": { - "type": "string" - }, - "example": "8d628899-3e6f-4666-91c3-74ee7ab88b2b" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/requestId_requestId_body" - }, - "examples": { - "0": { - "value": "{ \n \"owner\": { \"id\": \"BPNS00000007OTZ3\" }, \n \"dataQuality\": 1, \n \"description\": \"Daily standard simulation\", \n \"comment\": \"successful simulation\", \n \"expirationTimestamp\": \"2023-03-24T09:15:24.000Z\", \n \"runId\": \"0fece48b-c8d1-4180-1a9caca6d67e\", \n \"shipments\": [ \n { \n \"handlingUnits\": [ \n { \n \"name\": \"Palette\", \n \"volume\": 1, \n \"weight\": 189, \n \"batches\": [ \n { \n \"unitOfMeasurement\": \"KG\", \n \"materialName\": \"KK1000GR-Gehäuse-Rot\", \n \"quantity\": 50, \n \"materialNumber\": \"KK1000GR\", \n \"batchOrderId\": \"Order-0001\", \n \"batchId\": \"Batch_1\", \n \"hazardousGoods\": false, \n \"batchExpirationTimestamp\": \"2023-08-22T16:00:00.000Z\", \n \"batchNumber\": \"45\" \n } \n ], \n \"handlingUnitId\": \"HUT_1\", \n \"amount\": 1 \n } \n ], \n \"shipmentId\": \"DE51515151\", \n \"recipientTimestampPlanned\": \"2023-04-19T09:00:00.000Z\", \n \"destination\": { \"id\": \"BPNS00000007OTZ3\" }, \n \"recipient\": { \"id\": \"BPNS00000007OTZ4\" }, \n \"logistics\": { \"id\": \"BPNS00000007OS0H\" }, \n \"preceding\": {}, \n \"splittingAllowed\": true, \n \"destinationTimestamp\": \"2023-03-19T09:00:00.000Z\" \n } \n ], \n \"timestamp\": \"2023-03-09T14:13:42.806Z\" \n}" - } - } - } - } - }, - "responses": { - "200": { - "description": "OK", - "content": { - "text": { - "schema": { - "type": "string", - "example": "The POST has succeeded. The receiveLatestSimulationResult has been successfully processed in the backend system." - } - } - } - }, - "400": { - "description": "Bad request", - "content": { - "text": { - "schema": { - "type": "string", - "example": "The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing)." - } - } - } - }, - "401": { - "description": "Unauthorized", - "content": { - "text": { - "schema": { - "type": "string", - "example": "Although the HTTP standard specifies \"unauthorized\", semantically this response means \"unauthenticated\". That is, the client must authenticate itself to get the requested response." - } - } - } - }, - "402": { - "description": "Payload is empty", - "content": { - "text": { - "schema": { - "type": "string", - "example": "The payload of the API call is empty." - } - } - } - }, - "403": { - "description": "Forbidden", - "content": { - "text": { - "schema": { - "type": "string", - "example": "The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource." - } - } - } - }, - "404": { - "description": "Payload structure unknown", - "content": { - "text": { - "schema": { - "type": "string", - "example": "The payload structure is unknown or correspond not to the defined semantic model" - } - } - } - }, - "405": { - "description": "Method not allowed", - "content": { - "text": { - "schema": { - "type": "string", - "example": "The method used to receive the data was not POST" - } - } - } - }, - "406": { - "description": "Payload content invalid", - "content": { - "text": { - "schema": { - "type": "string", - "example": "The content of the payload is invalid. E.g. “owner unknown”" - } - } - } - }, - "500": { - "description": "Internal server error", - "content": { - "text": { - "schema": { - "type": "string", - "example": "The server has encountered a situation it does not know how to handle." - } - } - } - }, - "501": { - "description": "Service unavailable", - "content": { - "text": { - "schema": { - "type": "string", - "example": "The server is not ready to handle the request." - } - } - } - } - }, - "servers": [ - { - "url": "https://{server-url}" - } - ] - }, - "servers": [ - { - "url": "https://{server-url}" - } - ] - }, - "/api/requestScenarioFeedback/bpns/{bpns}": { - "post": { - "tags": ["requestScenarioFeedback"], - "operationId": "requestScenarioFeedback", - "description": "The requestScenarioFeedback is a request from a OSim partner for feedback on the possible fulfillment of the described scenario.", - "parameters": [ - { - "name": "bpns", - "in": "path", - "required": true, - "style": "simple", - "explode": false, - "schema": { - "type": "string" - }, - "example": "BPNS00000007OTZ3" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/bpns_bpns_body" - }, - "examples": { - "0": { - "value": "{\n \"materialFlowScenarioRequest\" : {\n \"scenarioSimResults\" : {\n \"resultOwnId\" : \"916b5688-8bd8-4d7e-83b9-e0d40939274e\",\n \"resultOwnSimRunInitial\" : {\n \"owner\" : { },\n \"dataQuality\" : 0,\n \"description\" : \"Please simulate asap\",\n \"comment\" : \"successful simulation \",\n \"expirationTimestamp\" : \"2023-03-24T09:15:24.000Z\",\n \"runId\" : \"0fece48b-c8d1-4180-1a9caca6d67e\",\n \"shipments\" : [ {\n \"handlingUnits\" : [ {\n \"name\" : \"Palette\",\n \"volume\" : 1.0,\n \"weight\" : 189.0,\n \"batches\" : [ {\n \"unitOfMeasurement\" : \"KG\",\n \"materialName\" : \"KK1000GR-Gehäuse-Rot\",\n \"quantity\" : 50.0,\n \"materialNumber\" : \"KK1000GR\",\n \"materialHazardousGoods\" : false,\n \"batchOrderId\" : \"Order-0001\",\n \"batchId\" : \"Batch_1\",\n \"batchExpirationTimestamp\" : \"2023-08-22T16:00:00.000Z\",\n \"batchNumber\" : \"45\"\n } ],\n \"handlingUnitId\" : \"HUT_1\",\n \"amount\" : 1\n } ],\n \"shipmentId\" : \"DE51515151\",\n \"recipientTimestampPlanned\" : \"2023-04-19T09:00:00.000Z\",\n \"destination\" : { },\n \"recipient\" : { },\n \"logistics\" : { },\n \"preceding\" : { },\n \"splittingAllowed\" : true,\n \"destinationTimestamp\" : \"2023-03-19T09:00:00.000Z\"\n } ],\n \"timestamp\" : \"2023-03-09T14:13:42.806Z\"\n },\n \"resultOwnSimRunUpdated\" : {\n \"owner\" : { },\n \"dataQuality\" : 0,\n \"description\" : \"Please simulate asap\",\n \"comment\" : \"successful simulation \",\n \"expirationTimestamp\" : \"2023-03-24T09:15:24.000Z\",\n \"runId\" : \"0fece48b-c8d1-4180-1a9caca6d67e\",\n \"shipments\" : [ {\n \"handlingUnits\" : [ {\n \"name\" : \"Palette\",\n \"volume\" : 1.0,\n \"weight\" : 189.0,\n \"batches\" : [ {\n \"unitOfMeasurement\" : \"KG\",\n \"materialName\" : \"KK1000GR-Gehäuse-Rot\",\n \"quantity\" : 50.0,\n \"materialNumber\" : \"KK1000GR\",\n \"materialHazardousGoods\" : false,\n \"batchOrderId\" : \"Order-0001\",\n \"batchId\" : \"Batch_1\",\n \"batchExpirationTimestamp\" : \"2023-08-22T16:00:00.000Z\",\n \"batchNumber\" : \"45\"\n } ],\n \"handlingUnitId\" : \"HUT_1\",\n \"amount\" : 1\n } ],\n \"shipmentId\" : \"DE51515151\",\n \"recipientTimestampPlanned\" : \"2023-04-19T09:00:00.000Z\",\n \"destination\" : { },\n \"recipient\" : { },\n \"logistics\" : { },\n \"preceding\" : { },\n \"splittingAllowed\" : true,\n \"destinationTimestamp\" : \"2023-03-19T09:00:00.000Z\"\n } ],\n \"timestamp\" : \"2023-03-09T14:13:42.806Z\"\n }\n },\n \"scenarioParameter\" : {\n \"unitOfMeasurement\" : \"KG\",\n \"parameterScenario\" : \"8d464b8b-6977-4952-8a22-0489067ca081\",\n \"parameterComment\" : \"updated Delivery Date\",\n \"materialName\" : \"KK1000GR-Gehäuse-Rot\",\n \"parameterQuantityUpdated\" : 1.0,\n \"parameterId\" : \"847c71e5-614a-468b-a3a0-674bf2af3004\",\n \"materialNumber\" : \"KK1000GR\",\n \"parameterDeliveryDateUpdated\" : \"2023-10-10T09:00:00.000Z\",\n \"parameterDeliveryDateInitial\" : \"2023-10-09T10:00:00.000Z\",\n \"parameterOrderId\" : \"OID-011123456\",\n \"parameterQuantityInitial\" : 1.0\n },\n \"scenarioHeader\" : {\n \"scenarioOwnerRole\" : \"Customer\",\n \"scenarioCreationTimestamp\" : \"2023-10-04T09:10:00.000Z\",\n \"scenarioExpirationTimestamp\" : \"2023-10-07T09:10:00.000Z\",\n \"scenarioOwner\" : \"BPNS0000007OTZ3\",\n \"scenarioDescription\" : \"Changes in Delivery Date\",\n \"scenarioId\" : \"8d464b8b-6977-4952-8a22-0489067ca081\",\n \"scenarioTitle\" : \"Delivery Modification\"\n }\n }\n}" - } - } - } - } - }, - "responses": { - "200": { - "description": "OK", - "content": { - "text": { - "schema": { - "type": "string", - "example": "The request has succeeded. The requestScenarioFeedback has been successfully processed in the backend system." - } - } - } - }, - "400": { - "description": "Bad request", - "content": { - "text": { - "schema": { - "type": "string", - "example": "The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing)." - } - } - } - }, - "401": { - "description": "Unauthorized", - "content": { - "text": { - "schema": { - "type": "string", - "example": "Although the HTTP standard specifies \"unauthorized\", semantically this response means \"unauthenticated\". That is, the client must authenticate itself to get the requested response." - } - } - } - }, - "402": { - "description": "Unknown BPNS", - "content": { - "text": { - "schema": { - "type": "string", - "example": "The BPNS which is given as parameter is not registered in the data provider database as a direct partner." - } - } - } - }, - "403": { - "description": "Forbidden", - "content": { - "text": { - "schema": { - "type": "string", - "example": "The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource." - } - } - } - }, - "405": { - "description": "Method not allowed", - "content": { - "text": { - "schema": { - "type": "string", - "example": "The method used to request a scenario feedback was not POST" - } - } - } - }, - "500": { - "description": "Internal server error", - "content": { - "text": { - "schema": { - "type": "string", - "example": "The server has encountered a situation it does not know how to handle." - } - } - } - }, - "501": { - "description": "Service unavailable", - "content": { - "text": { - "schema": { - "type": "string", - "example": "The server is not ready to handle the request." - } - } - } - } - }, - "servers": [ - { - "url": "https://{server-url}" - } - ] - }, - "servers": [ - { - "url": "https://{server-url}" - } - ] - }, - "/api/receiveScenarioFeedback/bpns/{bpns}/scenarioId/{scenarioId}/feedback/{feedback}": { - "get": { - "tags": ["receiveScenarioFeedback"], - "operationId": "receiveScenarioFeedback", - - "description": "The receiveScenarioFeedback enables the requestor to transmit the result of his scenario-based evaluation to the requestor", - "parameters": [ - { - "name": "bpns", - "in": "path", - "required": true, - "style": "simple", - "explode": false, - "schema": { - "type": "string" - }, - "example": "BPNS00000007OTZ3" - }, - { - "name": "scenarioId", - "in": "path", - "required": true, - "style": "simple", - "explode": false, - "schema": { - "type": "string" - }, - "example": "50737df3-4237-4652-b092-1ef8649f6ca6" - }, - { - "name": "feedback", - "in": "path", - "required": true, - "style": "simple", - "explode": false, - "schema": { - "type": "string", - "enum": ["Realizable", "NotRealizable"] - }, - "example": "Realizable" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "text": { - "schema": { - "type": "string", - "example": "The GET request has succeeded. The receiveScenarioFeedback has been successfully processed in the backend system." - } - } - } - }, - "400": { - "description": "Bad request", - "content": { - "text": { - "schema": { - "type": "string", - "example": "The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing)." - } - } - } - }, - "401": { - "description": "Unauthorized", - "content": { - "text": { - "schema": { - "type": "string", - "example": "Although the HTTP standard specifies \"unauthorized\", semantically this response means \"unauthenticated\". That is, the client must authenticate itself to get the requested response." - } - } - } - }, - "402": { - "description": "Unknown BPNS", - "content": { - "text": { - "schema": { - "type": "string", - "example": "The BPNS which is given as parameter is not registered in the data provider database as a direct partner." - } - } - } - }, - "403": { - "description": "Forbidden", - "content": { - "text": { - "schema": { - "type": "string", - "example": "The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource." - } - } - } - }, - "405": { - "description": "Method not allowed", - "content": { - "text": { - "schema": { - "type": "string", - "example": "The method used to request a scenario feedback was not GET" - } - } - } - }, - "406": { - "description": "Unknown Scenario", - "content": { - "text": { - "schema": { - "type": "string", - "example": "The scenarioID which is given as parameter is not registered." - } - } - } - }, - "407": { - "description": "Unknown State", - "content": { - "text": { - "schema": { - "type": "string", - "example": "The feedbackState value is unknown." - } - } - } - }, - "500": { - "description": "Internal server error", - "content": { - "text": { - "schema": { - "type": "string", - "example": "The server has encountered a situation it does not know how to handle." - } - } - } - }, - "501": { - "description": "Service unavailable", - "content": { - "text": { - "schema": { - "type": "string", - "example": "The server is not ready to handle the request." - } - } - } - } - }, - "servers": [ - { - "url": "https://{server-url}" - } - ] - }, - "servers": [ - { - "url": "https://{server-url}" - } - ] - }, - "/api/pushScenarioState/bpns/{bpns}/scenarioId/{scenarioId}/state/{state}": { - "get": { - "tags": ["pushScenarioState"], - "operationId": "pushScenarioState", - - "description": "The pushScenarioState enables distribution of a new scenario status and thus a notification of the procedure with the planned scenario", - "parameters": [ - { - "name": "bpns", - "in": "path", - "required": true, - "style": "simple", - "explode": false, - "schema": { - "type": "string" - }, - "example": "BPNS00000007OTZ3" - }, - { - "name": "scenarioId", - "in": "path", - "required": true, - "style": "simple", - "explode": false, - "schema": { - "type": "string" - }, - "example": "50737df3-4237-4652-b092-1ef8649f6ca6" - }, - { - "name": "state", - "in": "path", - "required": true, - "style": "simple", - "explode": false, - "schema": { - "type": "string", - "enum": ["InRealization", "Processed", "Canceled"] - }, - "example": "InRealization" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "text": { - "schema": { - "type": "string", - "example": "The GET has succeeded. The pushScenarioState has been successfully processed in the backend system." - } - } - } - }, - "400": { - "description": "Bad request", - "content": { - "text": { - "schema": { - "type": "string", - "example": "The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing)." - } - } - } - }, - "401": { - "description": "Unauthorized", - "content": { - "text": { - "schema": { - "type": "string", - "example": "Although the HTTP standard specifies \"unauthorized\", semantically this response means \"unauthenticated\". That is, the client must authenticate itself to get the requested response." - } - } - } - }, - "402": { - "description": "Unknown BPNS", - "content": { - "text": { - "schema": { - "type": "string", - "example": "The BPNS which is given as parameter is not registered in the data provider database as a direct partner." - } - } - } - }, - "403": { - "description": "Forbidden", - "content": { - "text": { - "schema": { - "type": "string", - "example": "The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource." - } - } - } - }, - "405": { - "description": "Method not allowed", - "content": { - "text": { - "schema": { - "type": "string", - "example": "The method used to request a scenario feedback was not GET" - } - } - } - }, - "406": { - "description": "Unknown Scenario", - "content": { - "text": { - "schema": { - "type": "string", - "example": "The scenarioID which is given as parameter is not registered." - } - } - } - }, - "407": { - "description": "Unknown State", - "content": { - "text": { - "schema": { - "type": "string", - "example": "The scenarioState value is unknown." - } - } - } - }, - "500": { - "description": "Internal server error", - "content": { - "text": { - "schema": { - "type": "string", - "example": "The server has encountered a situation it does not know how to handle." - } - } - } - }, - "501": { - "description": "Service unavailable", - "content": { - "text": { - "schema": { - "type": "string", - "example": "The server is not ready to handle the request." - } - } - } - } - }, - "servers": [ - { - "url": "https://{server-url}" - } - ] - }, - "servers": [ - { - "url": "https://{server-url}" - } - ] - } - }, - "components": { - "schemas": { - "apireceiveLatestSimulationResultrequestIdrequestId_owner": { - "type": "object", - "properties": { - "id": { - "type": "string" - } - } - }, - "apireceiveLatestSimulationResultrequestIdrequestId_batches": { - "type": "object", - "properties": { - "unitOfMeasurement": { - "type": "string" - }, - "materialName": { - "type": "string" - }, - "quantity": { - "type": "integer" - }, - "materialNumber": { - "type": "string" - }, - "batchOrderId": { - "type": "string" - }, - "batchId": { - "type": "string" - }, - "hazardousGoods": { - "type": "boolean" - }, - "batchExpirationTimestamp": { - "type": "string" - }, - "batchNumber": { - "type": "string" - } - } - }, - "apireceiveLatestSimulationResultrequestIdrequestId_handlingUnits": { - "type": "object", - "properties": { - "volume": { - "type": "integer" - }, - "batches": { - "type": "array", - "items": { - "$ref": "#/components/schemas/apireceiveLatestSimulationResultrequestIdrequestId_batches" - } - }, - "handlingUnitId": { - "type": "string" - }, - "amount": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "weight": { - "type": "integer" - } - } - }, - "apireceiveLatestSimulationResultrequestIdrequestId_shipments": { - "type": "object", - "properties": { - "handlingUnits": { - "type": "array", - "items": { - "$ref": "#/components/schemas/apireceiveLatestSimulationResultrequestIdrequestId_handlingUnits" - } - }, - "shipmentId": { - "type": "string" - }, - "recipientTimestampPlanned": { - "type": "string" - }, - "destination": { - "$ref": "#/components/schemas/apireceiveLatestSimulationResultrequestIdrequestId_owner" - }, - "recipient": { - "$ref": "#/components/schemas/apireceiveLatestSimulationResultrequestIdrequestId_owner" - }, - "logistics": { - "$ref": "#/components/schemas/apireceiveLatestSimulationResultrequestIdrequestId_owner" - }, - "preceding": { - "type": "object", - "properties": {} - }, - "splittingAllowed": { - "type": "boolean" - }, - "destinationTimestamp": { - "type": "string" - } - } - }, - "requestId_requestId_body": { - "type": "object", - "properties": { - "owner": { - "$ref": "#/components/schemas/apireceiveLatestSimulationResultrequestIdrequestId_owner" - }, - "dataQuality": { - "type": "integer" - }, - "description": { - "type": "string" - }, - "comment": { - "type": "string" - }, - "expirationTimestamp": { - "type": "string" - }, - "runId": { - "type": "string" - }, - "shipments": { - "type": "array", - "items": { - "$ref": "#/components/schemas/apireceiveLatestSimulationResultrequestIdrequestId_shipments" - } - }, - "timestamp": { - "type": "string" - } - } - }, - "apirequestScenarioFeedbackbpnsbpns_materialFlowScenarioRequest_scenarioSimResults_resultOwnSimRunInitial_batches": { - "required": [ - "batchExpirationTimestamp", - "batchId", - "batchNumber", - "batchOrderId", - "materialHazardousGoods", - "materialName", - "materialNumber", - "quantity", - "unitOfMeasurement" - ], - "type": "object", - "properties": { - "unitOfMeasurement": { - "type": "string" - }, - "materialName": { - "type": "string" - }, - "quantity": { - "type": "number" - }, - "materialNumber": { - "type": "string" - }, - "materialHazardousGoods": { - "type": "boolean" - }, - "batchOrderId": { - "type": "string" - }, - "batchId": { - "type": "string" - }, - "batchExpirationTimestamp": { - "type": "string" - }, - "batchNumber": { - "type": "string" - } - } - }, - "apirequestScenarioFeedbackbpnsbpns_materialFlowScenarioRequest_scenarioSimResults_resultOwnSimRunInitial_handlingUnits": { - "required": [ - "amount", - "batches", - "handlingUnitId", - "name", - "volume", - "weight" - ], - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "volume": { - "type": "number" - }, - "weight": { - "type": "number" - }, - "batches": { - "type": "array", - "items": { - "$ref": "#/components/schemas/apirequestScenarioFeedbackbpnsbpns_materialFlowScenarioRequest_scenarioSimResults_resultOwnSimRunInitial_batches" - } - }, - "handlingUnitId": { - "type": "string" - }, - "amount": { - "type": "integer" - } - } - }, - "apirequestScenarioFeedbackbpnsbpns_materialFlowScenarioRequest_scenarioSimResults_resultOwnSimRunInitial_shipments": { - "required": [ - "destination", - "destinationTimestamp", - "handlingUnits", - "logistics", - "preceding", - "recipient", - "recipientTimestampPlanned", - "shipmentId", - "splittingAllowed" - ], - "type": "object", - "properties": { - "handlingUnits": { - "type": "array", - "items": { - "$ref": "#/components/schemas/apirequestScenarioFeedbackbpnsbpns_materialFlowScenarioRequest_scenarioSimResults_resultOwnSimRunInitial_handlingUnits" - } - }, - "shipmentId": { - "type": "string" - }, - "recipientTimestampPlanned": { - "type": "string" - }, - "destination": { - "type": "object" - }, - "recipient": { - "type": "object" - }, - "logistics": { - "type": "object" - }, - "preceding": { - "type": "object" - }, - "splittingAllowed": { - "type": "boolean" - }, - "destinationTimestamp": { - "type": "string" - } - } - }, - "apirequestScenarioFeedbackbpnsbpns_materialFlowScenarioRequest_scenarioSimResults_resultOwnSimRunInitial": { - "required": [ - "comment", - "dataQuality", - "description", - "expirationTimestamp", - "owner", - "runId", - "shipments", - "timestamp" - ], - "type": "object", - "properties": { - "owner": { - "type": "object" - }, - "dataQuality": { - "type": "integer" - }, - "description": { - "type": "string" - }, - "comment": { - "type": "string" - }, - "expirationTimestamp": { - "type": "string" - }, - "runId": { - "type": "string" - }, - "shipments": { - "type": "array", - "items": { - "$ref": "#/components/schemas/apirequestScenarioFeedbackbpnsbpns_materialFlowScenarioRequest_scenarioSimResults_resultOwnSimRunInitial_shipments" - } - }, - "timestamp": { - "type": "string" - } - } - }, - "apirequestScenarioFeedbackbpnsbpns_materialFlowScenarioRequest_scenarioSimResults": { - "required": [ - "resultOwnId", - "resultOwnSimRunInitial", - "resultOwnSimRunUpdated" - ], - "type": "object", - "properties": { - "resultOwnId": { - "type": "string" - }, - "resultOwnSimRunInitial": { - "$ref": "#/components/schemas/apirequestScenarioFeedbackbpnsbpns_materialFlowScenarioRequest_scenarioSimResults_resultOwnSimRunInitial" - }, - "resultOwnSimRunUpdated": { - "$ref": "#/components/schemas/apirequestScenarioFeedbackbpnsbpns_materialFlowScenarioRequest_scenarioSimResults_resultOwnSimRunInitial" - } - } - }, - "apirequestScenarioFeedbackbpnsbpns_materialFlowScenarioRequest_scenarioParameter": { - "required": [ - "materialName", - "materialNumber", - "parameterComment", - "parameterDeliveryDateInitial", - "parameterDeliveryDateUpdated", - "parameterId", - "parameterOrderId", - "parameterQuantityInitial", - "parameterQuantityUpdated", - "parameterScenario", - "unitOfMeasurement" - ], - "type": "object", - "properties": { - "unitOfMeasurement": { - "type": "string" - }, - "parameterScenario": { - "type": "string" - }, - "parameterComment": { - "type": "string" - }, - "materialName": { - "type": "string" - }, - "parameterQuantityUpdated": { - "type": "number" - }, - "parameterId": { - "type": "string" - }, - "materialNumber": { - "type": "string" - }, - "parameterDeliveryDateUpdated": { - "type": "string" - }, - "parameterDeliveryDateInitial": { - "type": "string" - }, - "parameterOrderId": { - "type": "string" - }, - "parameterQuantityInitial": { - "type": "number" - } - } - }, - "apirequestScenarioFeedbackbpnsbpns_materialFlowScenarioRequest_scenarioHeader": { - "required": [ - "scenarioCreationTimestamp", - "scenarioDescription", - "scenarioExpirationTimestamp", - "scenarioId", - "scenarioOwner", - "scenarioOwnerRole", - "scenarioTitle" - ], - "type": "object", - "properties": { - "scenarioOwnerRole": { - "type": "string" - }, - "scenarioCreationTimestamp": { - "type": "string" - }, - "scenarioExpirationTimestamp": { - "type": "string" - }, - "scenarioOwner": { - "type": "string" - }, - "scenarioDescription": { - "type": "string" - }, - "scenarioId": { - "type": "string" - }, - "scenarioTitle": { - "type": "string" - } - } - }, - "apirequestScenarioFeedbackbpnsbpns_materialFlowScenarioRequest": { - "required": [ - "scenarioHeader", - "scenarioParameter", - "scenarioSimResults" - ], - "type": "object", - "properties": { - "scenarioSimResults": { - "$ref": "#/components/schemas/apirequestScenarioFeedbackbpnsbpns_materialFlowScenarioRequest_scenarioSimResults" - }, - "scenarioParameter": { - "$ref": "#/components/schemas/apirequestScenarioFeedbackbpnsbpns_materialFlowScenarioRequest_scenarioParameter" - }, - "scenarioHeader": { - "$ref": "#/components/schemas/apirequestScenarioFeedbackbpnsbpns_materialFlowScenarioRequest_scenarioHeader" - } - } - }, - "bpns_bpns_body": { - "required": ["materialFlowScenarioRequest"], - "type": "object", - "properties": { - "materialFlowScenarioRequest": { - "$ref": "#/components/schemas/apirequestScenarioFeedbackbpnsbpns_materialFlowScenarioRequest" - } - } - } - } - } -}