Skip to main content
Version: Next

receiveLatestSimulationResult​

Receive latest simulation result which can be stored in own OSim Manager instance

Path Parameters
  • requestId string required
    Example: 8d628899-3e6f-4666-91c3-74ee7ab88b2b
Request Body
  • description string required

    Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc.

  • runId string required

    Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc.

  • comment string required

    Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc.

  • expirationTimestamp string required

    Possible values: Value must match regular expression -?([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))?

    Describes a Property which contains the date and time with an optional timezone.

  • owner object

    Characteristic describing the Scenario Owner

  • bpnsProperty string required

    Possible values: Value must match regular expression ^BPNS[a-zA-Z0-9]{12}$

    The provided regular expression ensures that the BPNS is composed of prefix 'BPNS', 10 digits and two alphanumeric letters.

  • dataQuality number required

    Possible values: [0, 1, 2, 3, 4, 5]

    Possible values determining data quality

  • shipments object[] required

    List of shipments contained in the simulation

  • shipmentId string required

    Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc.

  • destination object

    Characteristic describing the Scenario Owner

  • bpnsProperty string required

    Possible values: Value must match regular expression ^BPNS[a-zA-Z0-9]{12}$

    The provided regular expression ensures that the BPNS is composed of prefix 'BPNS', 10 digits and two alphanumeric letters.

  • destinationTimestamp string required

    Possible values: Value must match regular expression -?([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))?

    Describes a Property which contains the date and time with an optional timezone.

  • recipient object

    Characteristic describing the Scenario Owner

  • bpnsProperty string required

    Possible values: Value must match regular expression ^BPNS[a-zA-Z0-9]{12}$

    The provided regular expression ensures that the BPNS is composed of prefix 'BPNS', 10 digits and two alphanumeric letters.

  • recipientTimestampPlanned string required

    Possible values: Value must match regular expression -?([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))?

    Describes a Property which contains the date and time with an optional timezone.

  • splittingAllowed boolean required

    Represents a boolean value (i.e. a "flag").

  • logistics object

    Characteristic describing the Scenario Owner

  • bpnsProperty string required

    Possible values: Value must match regular expression ^BPNS[a-zA-Z0-9]{12}$

    The provided regular expression ensures that the BPNS is composed of prefix 'BPNS', 10 digits and two alphanumeric letters.

  • preceding object

    Characteristic describing the Scenario Owner

  • bpnsProperty string required

    Possible values: Value must match regular expression ^BPNS[a-zA-Z0-9]{12}$

    The provided regular expression ensures that the BPNS is composed of prefix 'BPNS', 10 digits and two alphanumeric letters.

  • handlingUnits object[] required

    List of handling units included in the shipment

  • handlingUnitId string required

    Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc.

  • name string required

    Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc.

  • volume number required

    Volumetric value determining the volume of the handling unit

  • weight number required

    Amount of weight of the handling unit

  • amount number required

    Possible values: >= 1

    Number describing handling units with identical pieces

  • batches object[] required

    List of material batches

  • batchSerialNumber string required

    Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc.

  • materialNumber string required

    Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc.

  • materialName string required

    Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc.

  • materialHazardousGoods boolean required

    Represents a boolean value (i.e. a "flag").

  • batchExpirationTimestamp string required

    Possible values: Value must match regular expression -?([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))?

    Describes a Property which contains the date and time with an optional timezone.

  • quantity number required

    Number of materials contained within a handling unit

  • unitOfMeasurement string required

    Possible values: [KG, Liter, Piece]

    Possible options for units of measurement

  • batchNumber string required

    Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc.

  • batchOrderId string required

    Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc.

  • timestamp string required

    Possible values: Value must match regular expression -?([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))?

    Describes a Property which contains the date and time with an optional timezone.

Responses

OK

Schema
  • string
POST /api/receiveLatestSimulationResult/requestId/:requestId

Request

Base URL
https://{server-url}
requestId — path required
Body
{

  "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"

  }

}

curl -L -g -X POST 'https://{server-url}/api/receiveLatestSimulationResult/requestId/:requestId' \
-H 'Content-Type: application/json' \
-H 'Accept: text' \
--data-raw '{
  "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"
  }
}'