Skip to content

Commit

Permalink
Merge pull request #962 from dominikoeh/24-08/osim
Browse files Browse the repository at this point in the history 
OSim KIT 24.08
  • Loading branch information
@stephanbcbauer
stephanbcbauer authored Aug 2, 2024
2 parents 2552403 + 0dd1057 commit ab0e085
Show file tree
Hide file tree
Showing 13 changed files with 1,323 additions and 1,422 deletions.
Binary file added docs-kits/kits/OSim Kit/OSim-Product-Documentation-EN.pdf
View file
Binary file not shown.
13 changes: 8 additions & 5 deletions docs-kits/kits/OSim Kit/Software Development View/01-osim-api.info.mdx
View file
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -13,10 +13,13 @@ import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";
import Export from "@theme/ApiDemoPanel/Export";

<span className={"theme-doc-version-badge badge badge--secondary"}>
Version: 2.0.0
</span>
<span className={"theme-doc-version-badge badge badge--secondary"}>Version: 3.0.0</span>

# 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



185 changes: 110 additions & 75 deletions ...ts/kits/OSim Kit/Software Development View/02-page_software-development-view.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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"
}
}
```

Expand All @@ -70,28 +82,30 @@ 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": [
{
"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"
}
Expand All @@ -102,39 +116,49 @@ 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"
}
],
"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": [
{
"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"
}
Expand All @@ -145,35 +169,46 @@ 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"
}
],
"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"
Expand Down
2 changes: 1 addition & 1 deletion .../OSim Kit/Software Development View/03-request-latest-simulation-result.api.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading

0 comments on commit ab0e085

Please sign in to comment.