diff --git a/io.catenax.material_flow_simulation_result/1.0.0/gen/MaterialFlowSimulationResult-aas.xml b/io.catenax.material_flow_simulation_result/1.0.0/gen/MaterialFlowSimulationResult-aas.xml new file mode 100644 index 00000000..9d6a1bf6 --- /dev/null +++ b/io.catenax.material_flow_simulation_result/1.0.0/gen/MaterialFlowSimulationResult-aas.xml @@ -0,0 +1,1653 @@ + + + + + defaultAdminShell + + + + + defaultAsset + + + + + MaterialFlowSimulationResult + + Material Flow Simulation Result + + APPLICATION_CLASS + + Result of a Material Flow Simulation + + urn:bamm:io.catenax.material_flow_simulation_result:1.0.0#MaterialFlowSimulationResult + + + + + Material Flow Simulation Result + + + MaterialFlowSimulationResult + + + Result of a Material Flow Simulation + + + + + + http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0 + + + + + + Timestamp + + Timestamp + + urn:bamm:io.catenax.material_flow_simulation_result:1.0.0#timestamp + + + + + Timestamp + + + timestamp + + String + + Describes a Property which contains the date and time with an optional timezone. + + + + + + http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0 + + + + + + Text + + Text + + urn:bamm:io.catenax.material_flow_simulation_result:1.0.0#shipmentId + + + + + Shipment Id + + + shipmentId + + String + + Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc. + + + + + + http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0 + + + + + + DestinationCharacteristic + + Destination Characteristic + + urn:bamm:io.catenax.material_flow_simulation_result:1.0.0#destination + + + + + Destination + + + destination + + String + + Address where the shipment is immediately delivered to (by logistician) or provided for pickup (by producer) + + + + + + http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0 + + + + + + Timestamp + + Timestamp + + urn:bamm:io.catenax.material_flow_simulation_result:1.0.0#destinationTimestamp + + + + + Destination Timestamp + + + destinationTimestamp + + String + + Describes a Property which contains the date and time with an optional timezone. + + + + + + http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0 + + + + + + RecipientCharacteristic + + Recipient Characteristic + + urn:bamm:io.catenax.material_flow_simulation_result:1.0.0#recipient + + + + + Recipient + + + recipient + + String + + Location identifier of the final recipient of the shipment + + + + + + http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0 + + + + + + Timestamp + + Timestamp + + urn:bamm:io.catenax.material_flow_simulation_result:1.0.0#recipientTimestampPlanned + + + + + Recipient Timestamp Planned + + + recipientTimestampPlanned + + String + + Describes a Property which contains the date and time with an optional timezone. + + + + + + http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0 + + + + + + Boolean + + Boolean + + urn:bamm:io.catenax.material_flow_simulation_result:1.0.0#splittingAllowed + + + + + Splitting Allowed + + + splittingAllowed + + Boolean + + Represents a boolean value (i.e. a "flag"). + + + + + + http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0 + + + + + + LogisticsCharacteristic + + Logistics Characteristic + + urn:bamm:io.catenax.material_flow_simulation_result:1.0.0#logistics + + + + + Logistics + + + logistics + + String + + Site identifier of the logistician executing the shipment + + + + + + http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0 + + + + + + PrecedingCharacteristic + + Preceding Characteristic + + urn:bamm:io.catenax.material_flow_simulation_result:1.0.0#preceding + + + + + Preceding + + + preceding + + String + + Reference of preceding shipments + + + + + + http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0 + + + + + + Text + + Text + + urn:bamm:io.catenax.material_flow_simulation_result:1.0.0#handlingUnitId + + + + + Handling Unit Id + + + handlingUnitId + + String + + Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc. + + + + + + http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0 + + + + + + Text + + Text + + urn:bamm:io.catenax.material_flow_simulation_result:1.0.0#name + + + + + Name + + + name + + String + + Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc. + + + + + + http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0 + + + + + + VolumeCharacteristic + + Volume Characteristic + + urn:bamm:io.catenax.material_flow_simulation_result:1.0.0#volume + + + + + Volume + + + volume + + litre + RealMeasure + + Volumetric value determining the volume of the handling unit + + + + + + http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0 + + + + + + WeightCharacteristic + + Weight Characteristic + + urn:bamm:io.catenax.material_flow_simulation_result:1.0.0#weight + + + + + Weight + + + weight + + kilogram + RealMeasure + + Amount of weight of the handling unit + + + + + + http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0 + + + + + + AmountCharacteristic + + Amount Characteristic + + urn:bamm:io.catenax.material_flow_simulation_result:1.0.0#amount + + + + + Amount + + + amount + + piece + IntegerCount + + Number describing handling units with identical pieces + + + + + + http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0 + + + + + + Text + + Text + + urn:bamm:io.catenax.material_flow_simulation_result:1.0.0#batchId + + + + + Batch Id + + + batchId + + String + + Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc. + + + + + + http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0 + + + + + + Text + + Text + + urn:bamm:io.catenax.material_flow_simulation_result:1.0.0#materialNumber + + + + + Material Number + + + materialNumber + + String + + Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc. + + + + + + http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0 + + + + + + Text + + Text + + urn:bamm:io.catenax.material_flow_simulation_result:1.0.0#materialName + + + + + Material Name + + + materialName + + String + + Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc. + + + + + + http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0 + + + + + + Boolean + + Boolean + + urn:bamm:io.catenax.material_flow_simulation_result:1.0.0#hazardousGoods + + + + + Hazardous Goods + + + hazardousGoods + + Boolean + + Represents a boolean value (i.e. a "flag"). + + + + + + http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0 + + + + + + Timestamp + + Timestamp + + urn:bamm:io.catenax.material_flow_simulation_result:1.0.0#batchExpirationTimestamp + + + + + Batch Expiration Timestamp + + + batchExpirationTimestamp + + String + + Describes a Property which contains the date and time with an optional timezone. + + + + + + http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0 + + + + + + QuantityCharacteristic + + Quantity Characteristic + + urn:bamm:io.catenax.material_flow_simulation_result:1.0.0#quantity + + + + + Quantity + + + quantity + + RealMeasure + + Number of materials contained within a handling unit + + + + + + http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0 + + + + + + UnitOfMeasurementCharacteristic + + Unit Of Measurement Characteristic + + urn:bamm:io.catenax.material_flow_simulation_result:1.0.0#unitOfMeasurement + + + + + UnitOfMeasurement + + + unitOfMeasurement + + String + + Possible options for units of measurement + + + + + + urn:bamm:io.catenax.material_flow_simulation_result:1.0.0#UnitOfMeasurementCharacteristic:DefaultScalarValue[value=KG, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] + + + DefaultScalarValue[value=KG, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] + + + + + urn:bamm:io.catenax.material_flow_simulation_result:1.0.0#UnitOfMeasurementCharacteristic:DefaultScalarValue[value=Liter, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] + + + DefaultScalarValue[value=Liter, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] + + + + + urn:bamm:io.catenax.material_flow_simulation_result:1.0.0#UnitOfMeasurementCharacteristic:DefaultScalarValue[value=Piece, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] + + + DefaultScalarValue[value=Piece, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] + + + + + + + http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0 + + + + + + Text + + Text + + urn:bamm:io.catenax.material_flow_simulation_result:1.0.0#batchNumber + + + + + Batch Number + + + batchNumber + + String + + Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc. + + + + + + http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0 + + + + + + Text + + Text + + urn:bamm:io.catenax.material_flow_simulation_result:1.0.0#batchOrderId + + + + + Batch Order Id + + + batchOrderId + + String + + Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc. + + + + + + http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0 + + + + + + BatchList + + Batch List + + urn:bamm:io.catenax.material_flow_simulation_result:1.0.0#batches + + + + + Batches + + + batches + + String + + List of material batches + + + + + + http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0 + + + + + + HandlingUnitList + + Handling Unit List + + urn:bamm:io.catenax.material_flow_simulation_result:1.0.0#handlingUnits + + + + + Handling Units + + + handlingUnits + + String + + List of handling units included in the shipment + + + + + + http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0 + + + + + + ShipmentList + + Shipment List + + urn:bamm:io.catenax.material_flow_simulation_result:1.0.0#shipments + + + + + Shipments + + + shipments + + String + + List of shipments contained in the simulation + + + + + + http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0 + + + + + + DataQualityOptions + + Data Quality Options + + urn:bamm:io.catenax.material_flow_simulation_result:1.0.0#dataQuality + + + + + Data Quality + + + dataQuality + + IntegerCount + + Possible values determining data quality + + + + + + urn:bamm:io.catenax.material_flow_simulation_result:1.0.0#DataQualityOptions:DefaultScalarValue[value=0, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#positiveInteger']'] + + + DefaultScalarValue[value=0, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#positiveInteger']'] + + + + + urn:bamm:io.catenax.material_flow_simulation_result:1.0.0#DataQualityOptions:DefaultScalarValue[value=1, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#positiveInteger']'] + + + DefaultScalarValue[value=1, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#positiveInteger']'] + + + + + urn:bamm:io.catenax.material_flow_simulation_result:1.0.0#DataQualityOptions:DefaultScalarValue[value=2, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#positiveInteger']'] + + + DefaultScalarValue[value=2, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#positiveInteger']'] + + + + + urn:bamm:io.catenax.material_flow_simulation_result:1.0.0#DataQualityOptions:DefaultScalarValue[value=3, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#positiveInteger']'] + + + DefaultScalarValue[value=3, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#positiveInteger']'] + + + + + urn:bamm:io.catenax.material_flow_simulation_result:1.0.0#DataQualityOptions:DefaultScalarValue[value=4, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#positiveInteger']'] + + + DefaultScalarValue[value=4, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#positiveInteger']'] + + + + + urn:bamm:io.catenax.material_flow_simulation_result:1.0.0#DataQualityOptions:DefaultScalarValue[value=5, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#positiveInteger']'] + + + DefaultScalarValue[value=5, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#positiveInteger']'] + + + + + + + http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0 + + + + + + Text + + Text + + urn:bamm:io.catenax.material_flow_simulation_result:1.0.0#comment + + + + + Comment + + + comment + + String + + Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc. + + + + + + http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0 + + + + + + Timestamp + + Timestamp + + urn:bamm:io.catenax.material_flow_simulation_result:1.0.0#expirationTimestamp + + + + + ExpirationTimestamp + + + expirationTimestamp + + String + + Describes a Property which contains the date and time with an optional timezone. + + + + + + http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0 + + + + + + Text + + Text + + urn:bamm:io.catenax.material_flow_simulation_result:1.0.0#runId + + + + + RunId + + + runId + + String + + Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc. + + + + + + http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0 + + + + + + OwnerCharacteristic + + Owner Characteristic + + urn:bamm:io.catenax.material_flow_simulation_result:1.0.0#owner + + + + + Owner + + + owner + + String + + Site identifier of the simulation originator + + + + + + http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0 + + + + + + Text + + Text + + urn:bamm:io.catenax.material_flow_simulation_result:1.0.0#description + + + + + Description + + + description + + String + + Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc. + + + + + + http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0 + + + + + + + + MaterialFlowSimulationResult + + Result of a Material Flow Simulation + + Template + + + urn:bamm:io.catenax.material_flow_simulation_result:1.0.0#MaterialFlowSimulationResult + + + + + + timestamp + + Timestamp + + + Timestamp of simulation run + + Template + + + urn:bamm:io.catenax.material_flow_simulation_result:1.0.0#timestamp + + + DefaultScalarValue[value=2023-03-09T14:13:42.806Z, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#dateTime']'] + http://www.w3.org/2001/XMLSchema#dateTime + + + + + shipments + + Shipments + + + List of shipments + + false + true + + + + Shipment + + Shipment + + + Delivery item from a sender to a recipient containing goods + + false + false + + + + shipmentId + + Shipment Id + + + ID to identify the shipment + + Template + + + urn:bamm:io.catenax.material_flow_simulation_result:1.0.0#shipmentId + + + DefaultScalarValue[value=DE51515151, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] + http://www.w3.org/2001/XMLSchema#string + + + + + BusinessPartnerSite + + Business Partner Site + + + Identifier for the physical location of a business partner plant or site, (e.g. BPNS in Catena-X context) + + false + false + + + + + + destinationTimestamp + + Destination Timestamp + + + Time when delivery arrives or is ready at goods issue + + Template + + + urn:bamm:io.catenax.material_flow_simulation_result:1.0.0#destinationTimestamp + + + DefaultScalarValue[value=2023-03-19T09:00:00.000Z, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#dateTime']'] + http://www.w3.org/2001/XMLSchema#dateTime + + + + + BusinessPartnerSite + + Business Partner Site + + + Identifier for the physical location of a business partner plant or site, (e.g. BPNS in Catena-X context) + + false + false + + + + + + recipientTimestampPlanned + + Recipient Timestamp Planned + + + Planned delivery time + + Template + + + urn:bamm:io.catenax.material_flow_simulation_result:1.0.0#recipientTimestampPlanned + + + DefaultScalarValue[value=2023-04-19T09:00:00.000Z, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#dateTime']'] + http://www.w3.org/2001/XMLSchema#dateTime + + + + + splittingAllowed + + Splitting Allowed + + + Permission to split the shipment into individual deliveries + + Template + + + urn:bamm:io.catenax.material_flow_simulation_result:1.0.0#splittingAllowed + + + DefaultScalarValue[value=true, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#boolean']'] + http://www.w3.org/2001/XMLSchema#boolean + + + + + BusinessPartnerSite + + Business Partner Site + + + Identifier for the physical location of a business partner plant or site, (e.g. BPNS in Catena-X context) + + false + false + + + + + + BusinessPartnerSite + + Business Partner Site + + + Identifier for the physical location of a business partner plant or site, (e.g. BPNS in Catena-X context) + + false + false + + + + + + handlingUnits + + Handling Units + + + List of Handling Units + + false + true + + + + HandlingUnit + + Handling Unit + + + Handling Unit is the smallest shipment unit and cannot be divided into several shipments + + false + false + + + + handlingUnitId + + Handling Unit Id + + + ID of the handling unit + + Template + + + urn:bamm:io.catenax.material_flow_simulation_result:1.0.0#handlingUnitId + + + DefaultScalarValue[value=HUT_1, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] + http://www.w3.org/2001/XMLSchema#string + + + + + name + + Name + + + Name of the type of handling unit + + Template + + + urn:bamm:io.catenax.material_flow_simulation_result:1.0.0#name + + + DefaultScalarValue[value=Palette, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] + http://www.w3.org/2001/XMLSchema#string + + + + + volume + + Volume + + + Volume of the handling unit + + Template + + + urn:bamm:io.catenax.material_flow_simulation_result:1.0.0#volume + + + DefaultScalarValue[value=1.0, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#float']'] + http://www.w3.org/2001/XMLSchema#float + + + + + weight + + Weight + + + Weight of the handling unit + + Template + + + urn:bamm:io.catenax.material_flow_simulation_result:1.0.0#weight + + + DefaultScalarValue[value=189.0, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#float']'] + http://www.w3.org/2001/XMLSchema#float + + + + + amount + + Amount + + + Number of handling units with identical content + + Template + + + urn:bamm:io.catenax.material_flow_simulation_result:1.0.0#amount + + + DefaultScalarValue[value=1, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#positiveInteger']'] + http://www.w3.org/2001/XMLSchema#positiveInteger + + + + + batches + + Batches + + + List of material batches contained within a handling unit + + false + true + + + + MaterialBatch + + Material Batch + + + Material Batches are part of a handling unit + + false + false + + + + batchId + + Batch Id + + + ID for the material batch + + Template + + + urn:bamm:io.catenax.material_flow_simulation_result:1.0.0#batchId + + + DefaultScalarValue[value=Batch_1, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] + http://www.w3.org/2001/XMLSchema#string + + + + + materialNumber + + Material Number + + + ID of the material contained in the batch + + Template + + + urn:bamm:io.catenax.material_flow_simulation_result:1.0.0#materialNumber + + + DefaultScalarValue[value=KK1000GR, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] + http://www.w3.org/2001/XMLSchema#string + + + + + materialName + + Material Name + + + Name of the material + + Template + + + urn:bamm:io.catenax.material_flow_simulation_result:1.0.0#materialName + + + DefaultScalarValue[value=KK1000GR-Gehäuse-Rot, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] + http://www.w3.org/2001/XMLSchema#string + + + + + hazardousGoods + + Hazardous Goods + + + Flags hazardous goods + + Template + + + urn:bamm:io.catenax.material_flow_simulation_result:1.0.0#hazardousGoods + + + DefaultScalarValue[value=false, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#boolean']'] + http://www.w3.org/2001/XMLSchema#boolean + + + + + batchExpirationTimestamp + + Batch Expiration Timestamp + + + Expiration date of batch + + Template + + + urn:bamm:io.catenax.material_flow_simulation_result:1.0.0#batchExpirationTimestamp + + + DefaultScalarValue[value=2023-08-22T16:00:00.000Z, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#dateTime']'] + http://www.w3.org/2001/XMLSchema#dateTime + + + + + quantity + + Quantity + + + Amount of materials + + Template + + + urn:bamm:io.catenax.material_flow_simulation_result:1.0.0#quantity + + + DefaultScalarValue[value=50.0, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#float']'] + http://www.w3.org/2001/XMLSchema#float + + + + + unitOfMeasurement + + UnitOfMeasurement + + + Unit used for measuring the quantity + + Template + + + urn:bamm:io.catenax.material_flow_simulation_result:1.0.0#unitOfMeasurement + + + Unknown + http://www.w3.org/2001/XMLSchema#string + + + + + batchNumber + + Batch Number + + + Number of the batch, generated by originator (e.g. from ERP system, no uuid) + + Template + + + urn:bamm:io.catenax.material_flow_simulation_result:1.0.0#batchNumber + + + DefaultScalarValue[value=45, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] + http://www.w3.org/2001/XMLSchema#string + + + + + batchOrderId + + Batch Order Id + + + Order ID to which the batch belongs + + Template + + + urn:bamm:io.catenax.material_flow_simulation_result:1.0.0#batchOrderId + + + DefaultScalarValue[value=Order-0001, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] + http://www.w3.org/2001/XMLSchema#string + + + + + + + + + + + + + + + + + + + + + + + dataQuality + + Data Quality + + + Information on quality of simulation results + + Template + + + urn:bamm:io.catenax.material_flow_simulation_result:1.0.0#dataQuality + + + DefaultScalarValue[value=0, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#positiveInteger']'] + http://www.w3.org/2001/XMLSchema#positiveInteger + + + + + comment + + Comment + + + Additional comments + + Template + + + urn:bamm:io.catenax.material_flow_simulation_result:1.0.0#comment + + + DefaultScalarValue[value=successful simulation , typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] + http://www.w3.org/2001/XMLSchema#string + + + + + expirationTimestamp + + ExpirationTimestamp + + + Date and time when the simulation is expired + + Template + + + urn:bamm:io.catenax.material_flow_simulation_result:1.0.0#expirationTimestamp + + + DefaultScalarValue[value=2023-03-24T09:15:24.000Z, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#dateTime']'] + http://www.w3.org/2001/XMLSchema#dateTime + + + + + runId + + RunId + + + Id of the simulation run + + Template + + + urn:bamm:io.catenax.material_flow_simulation_result:1.0.0#runId + + + DefaultScalarValue[value=0fece48b-c8d1-4180-1a9caca6d67e, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] + http://www.w3.org/2001/XMLSchema#string + + + + + BusinessPartnerSite + + Business Partner Site + + + Identifier for the physical location of a business partner plant or site, (e.g. BPNS in Catena-X context) + + false + false + + + + + + description + + Description + + + Verbal description + + Template + + + urn:bamm:io.catenax.material_flow_simulation_result:1.0.0#description + + + DefaultScalarValue[value=Please simulate asap, typeUri='DefaultScalar[metaModelVersion=BAMM_2_0_0, urn='http://www.w3.org/2001/XMLSchema#string']'] + http://www.w3.org/2001/XMLSchema#string + + + + + + diff --git a/io.catenax.material_flow_simulation_result/1.0.0/gen/MaterialFlowSimulationResult-schema.json b/io.catenax.material_flow_simulation_result/1.0.0/gen/MaterialFlowSimulationResult-schema.json new file mode 100644 index 00000000..7393d71b --- /dev/null +++ b/io.catenax.material_flow_simulation_result/1.0.0/gen/MaterialFlowSimulationResult-schema.json @@ -0,0 +1,232 @@ +{ + "$schema" : "http://json-schema.org/draft-04/schema", + "description" : "Result of a Material Flow Simulation", + "type" : "object", + "components" : { + "schemas" : { + "urn_bamm_io.openmanufacturing_characteristic_2.0.0_Timestamp" : { + "type" : "string", + "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))?", + "description" : "Describes a Property which contains the date and time with an optional timezone." + }, + "urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text" : { + "type" : "string", + "description" : "Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc." + }, + "urn_bamm_io.catenax.material_flow_simulation_result_1.0.0_BusinessPartnerSite" : { + "description" : "Site identifier of the simulation originator", + "type" : "object", + "properties" : { } + }, + "urn_bamm_io.openmanufacturing_characteristic_2.0.0_Boolean" : { + "type" : "boolean", + "description" : "Represents a boolean value (i.e. a \"flag\")." + }, + "urn_bamm_io.catenax.material_flow_simulation_result_1.0.0_Text" : { + "type" : "string", + "description" : "Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc." + }, + "urn_bamm_io.catenax.material_flow_simulation_result_1.0.0_VolumeCharacteristic" : { + "type" : "number", + "description" : "Volumetric value determining the volume of the handling unit" + }, + "urn_bamm_io.catenax.material_flow_simulation_result_1.0.0_WeightCharacteristic" : { + "type" : "number", + "description" : "Amount of weight of the handling unit" + }, + "urn_bamm_io.catenax.material_flow_simulation_result_1.0.0_AmountCharacteristic" : { + "type" : "number", + "minimum" : 1, + "description" : "Number describing handling units with identical pieces" + }, + "urn_bamm_io.catenax.material_flow_simulation_result_1.0.0_QuantityCharacteristic" : { + "type" : "number", + "description" : "Number of materials contained within a handling unit" + }, + "urn_bamm_io.catenax.material_flow_simulation_result_1.0.0_UnitOfMeasurementCharacteristic" : { + "type" : "string", + "description" : "Possible options for units of measurement", + "enum" : [ "KG", "Liter", "Piece" ] + }, + "urn_bamm_io.catenax.material_flow_simulation_result_1.0.0_MaterialBatch" : { + "description" : "Material Batches are part of a handling unit", + "type" : "object", + "properties" : { + "batchId" : { + "description" : "ID for the material batch", + "$ref" : "#/components/schemas/urn_bamm_io.catenax.material_flow_simulation_result_1.0.0_Text" + }, + "materialNumber" : { + "description" : "ID of the material contained in the batch", + "$ref" : "#/components/schemas/urn_bamm_io.catenax.material_flow_simulation_result_1.0.0_Text" + }, + "materialName" : { + "description" : "Name of the material", + "$ref" : "#/components/schemas/urn_bamm_io.catenax.material_flow_simulation_result_1.0.0_Text" + }, + "hazardousGoods" : { + "description" : "Flags hazardous goods", + "$ref" : "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Boolean" + }, + "batchExpirationTimestamp" : { + "description" : "Expiration date of batch", + "$ref" : "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Timestamp" + }, + "quantity" : { + "description" : "Amount of materials", + "$ref" : "#/components/schemas/urn_bamm_io.catenax.material_flow_simulation_result_1.0.0_QuantityCharacteristic" + }, + "unitOfMeasurement" : { + "description" : "Unit used for measuring the quantity", + "$ref" : "#/components/schemas/urn_bamm_io.catenax.material_flow_simulation_result_1.0.0_UnitOfMeasurementCharacteristic" + }, + "batchNumber" : { + "description" : "Number of the batch, generated by originator (e.g. from ERP system, no uuid)", + "$ref" : "#/components/schemas/urn_bamm_io.catenax.material_flow_simulation_result_1.0.0_Text" + }, + "batchOrderId" : { + "description" : "Order ID to which the batch belongs", + "$ref" : "#/components/schemas/urn_bamm_io.catenax.material_flow_simulation_result_1.0.0_Text" + } + }, + "required" : [ "batchId", "materialNumber", "materialName", "hazardousGoods", "batchExpirationTimestamp", "quantity", "unitOfMeasurement", "batchNumber", "batchOrderId" ] + }, + "urn_bamm_io.catenax.material_flow_simulation_result_1.0.0_BatchList" : { + "description" : "List of material batches", + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/urn_bamm_io.catenax.material_flow_simulation_result_1.0.0_MaterialBatch" + } + }, + "urn_bamm_io.catenax.material_flow_simulation_result_1.0.0_HandlingUnit" : { + "description" : "Handling Unit is the smallest shipment unit and cannot be divided into several shipments", + "type" : "object", + "properties" : { + "handlingUnitId" : { + "description" : "ID of the handling unit", + "$ref" : "#/components/schemas/urn_bamm_io.catenax.material_flow_simulation_result_1.0.0_Text" + }, + "name" : { + "description" : "Name of the type of handling unit", + "$ref" : "#/components/schemas/urn_bamm_io.catenax.material_flow_simulation_result_1.0.0_Text" + }, + "volume" : { + "description" : "Volume of the handling unit", + "$ref" : "#/components/schemas/urn_bamm_io.catenax.material_flow_simulation_result_1.0.0_VolumeCharacteristic" + }, + "weight" : { + "description" : "Weight of the handling unit", + "$ref" : "#/components/schemas/urn_bamm_io.catenax.material_flow_simulation_result_1.0.0_WeightCharacteristic" + }, + "amount" : { + "description" : "Number of handling units with identical content", + "$ref" : "#/components/schemas/urn_bamm_io.catenax.material_flow_simulation_result_1.0.0_AmountCharacteristic" + }, + "batches" : { + "description" : "List of material batches contained within a handling unit", + "$ref" : "#/components/schemas/urn_bamm_io.catenax.material_flow_simulation_result_1.0.0_BatchList" + } + }, + "required" : [ "handlingUnitId", "name", "volume", "weight", "amount", "batches" ] + }, + "urn_bamm_io.catenax.material_flow_simulation_result_1.0.0_HandlingUnitList" : { + "description" : "List of handling units included in the shipment", + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/urn_bamm_io.catenax.material_flow_simulation_result_1.0.0_HandlingUnit" + } + }, + "urn_bamm_io.catenax.material_flow_simulation_result_1.0.0_Shipment" : { + "description" : "Delivery item from a sender to a recipient containing goods", + "type" : "object", + "properties" : { + "shipmentId" : { + "description" : "ID to identify the shipment", + "$ref" : "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text" + }, + "destination" : { + "description" : "Address where the shipment is immediately delivered to (by logistician) or provided for pickup (by producer)", + "$ref" : "#/components/schemas/urn_bamm_io.catenax.material_flow_simulation_result_1.0.0_BusinessPartnerSite" + }, + "destinationTimestamp" : { + "description" : "Time when delivery arrives or is ready at goods issue", + "$ref" : "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Timestamp" + }, + "recipient" : { + "description" : "Address of final recipient of shipment", + "$ref" : "#/components/schemas/urn_bamm_io.catenax.material_flow_simulation_result_1.0.0_BusinessPartnerSite" + }, + "recipientTimestampPlanned" : { + "description" : "Planned delivery time", + "$ref" : "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Timestamp" + }, + "splittingAllowed" : { + "description" : "Permission to split the shipment into individual deliveries", + "$ref" : "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Boolean" + }, + "logistics" : { + "description" : "Address of logistician executing the shipment", + "$ref" : "#/components/schemas/urn_bamm_io.catenax.material_flow_simulation_result_1.0.0_BusinessPartnerSite" + }, + "preceding" : { + "description" : "Reference ID of a preceding shipment", + "$ref" : "#/components/schemas/urn_bamm_io.catenax.material_flow_simulation_result_1.0.0_BusinessPartnerSite" + }, + "handlingUnits" : { + "description" : "List of Handling Units", + "$ref" : "#/components/schemas/urn_bamm_io.catenax.material_flow_simulation_result_1.0.0_HandlingUnitList" + } + }, + "required" : [ "shipmentId", "destination", "destinationTimestamp", "recipient", "recipientTimestampPlanned", "splittingAllowed", "logistics", "preceding", "handlingUnits" ] + }, + "urn_bamm_io.catenax.material_flow_simulation_result_1.0.0_ShipmentList" : { + "description" : "List of shipments contained in the simulation", + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/urn_bamm_io.catenax.material_flow_simulation_result_1.0.0_Shipment" + } + }, + "urn_bamm_io.catenax.material_flow_simulation_result_1.0.0_DataQualityOptions" : { + "type" : "number", + "minimum" : 1, + "description" : "Possible values determining data quality", + "enum" : [ 0, 1, 2, 3, 4, 5 ] + } + } + }, + "properties" : { + "timestamp" : { + "description" : "Timestamp of simulation run", + "$ref" : "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Timestamp" + }, + "shipments" : { + "description" : "List of shipments", + "$ref" : "#/components/schemas/urn_bamm_io.catenax.material_flow_simulation_result_1.0.0_ShipmentList" + }, + "dataQuality" : { + "description" : "Information on quality of simulation results", + "$ref" : "#/components/schemas/urn_bamm_io.catenax.material_flow_simulation_result_1.0.0_DataQualityOptions" + }, + "comment" : { + "description" : "Additional comments", + "$ref" : "#/components/schemas/urn_bamm_io.catenax.material_flow_simulation_result_1.0.0_Text" + }, + "expirationTimestamp" : { + "description" : "Date and time when the simulation is expired", + "$ref" : "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Timestamp" + }, + "runId" : { + "description" : "Id of the simulation run", + "$ref" : "#/components/schemas/urn_bamm_io.catenax.material_flow_simulation_result_1.0.0_Text" + }, + "owner" : { + "description" : "Site identifier of the simulation originator", + "$ref" : "#/components/schemas/urn_bamm_io.catenax.material_flow_simulation_result_1.0.0_BusinessPartnerSite" + }, + "description" : { + "description" : "Verbal description", + "$ref" : "#/components/schemas/urn_bamm_io.catenax.material_flow_simulation_result_1.0.0_Text" + } + }, + "required" : [ "timestamp", "shipments", "dataQuality", "comment", "expirationTimestamp", "runId", "owner", "description" ] +} \ No newline at end of file diff --git a/io.catenax.material_flow_simulation_result/1.0.0/gen/MaterialFlowSimulationResult.aasx b/io.catenax.material_flow_simulation_result/1.0.0/gen/MaterialFlowSimulationResult.aasx new file mode 100644 index 00000000..ac051e7b Binary files /dev/null and b/io.catenax.material_flow_simulation_result/1.0.0/gen/MaterialFlowSimulationResult.aasx differ diff --git a/io.catenax.material_flow_simulation_result/1.0.0/gen/MaterialFlowSimulationResult.html b/io.catenax.material_flow_simulation_result/1.0.0/gen/MaterialFlowSimulationResult.html new file mode 100644 index 00000000..f8ac3c08 --- /dev/null +++ b/io.catenax.material_flow_simulation_result/1.0.0/gen/MaterialFlowSimulationResult.html @@ -0,0 +1,2205 @@ + + + + + + + + + + + + + + Dokumentation Material Flow Simulation Result + + +
+
+
+
+

Aspect Model Material Flow Simulation Result

+
urn:bamm:io.catenax.material_flow_simulation_result:1.0.0#MaterialFlowSimulationResult
+
+
+
+
+
+
+
+ +
+ + +
+ Result of a Material Flow Simulation +
+ + +
+

Übersicht

+
+
+
+
+ Aspect Model Diagram +
+
+
+ + +
+
+

Properties

+
+ +
+ +
+

Comment

+
+ +Additional comments + +
+
Name
+
comment
+
+ + + +
+
Characteristic
+ +
+ +
+
Beispiel
+
successful simulation
+
+ +
+
Optional
+
+ Nein
+
+ +
+
Im Payload
+
+ Ja
+
+ +
+
Payload Schlüssel
+
comment
+
+ + +
+
+ +
+

Data Quality

+
+ +Information on quality of simulation results + +
+
Name
+
dataQuality
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Werte
+
+
+
+
    +
  • 0
  • +
  • 1
  • +
  • 2
  • +
  • 3
  • +
  • 4
  • +
  • 5
  • +
+
+
+ +
+
+
+ +
+
Beispiel
+
0
+
+ +
+
Optional
+
+ Nein
+
+ +
+
Im Payload
+
+ Ja
+
+ +
+
Payload Schlüssel
+
dataQuality
+
+ + +
+
+ +
+

Description

+
+ +Verbal description + +
+
Name
+
description
+
+ + + +
+
Characteristic
+ +
+ +
+
Beispiel
+
Please simulate asap
+
+ +
+
Optional
+
+ Nein
+
+ +
+
Im Payload
+
+ Ja
+
+ +
+
Payload Schlüssel
+
description
+
+ + +
+
+ +
+

ExpirationTimestamp

+
+ +Date and time when the simulation is expired + +
+
Name
+
expirationTimestamp
+
+ + + +
+
Characteristic
+ +
+ +
+
Beispiel
+
2023-03-24T09:15:24.000Z
+
+ +
+
Optional
+
+ Nein
+
+ +
+
Im Payload
+
+ Ja
+
+ +
+
Payload Schlüssel
+
expirationTimestamp
+
+ + +
+
+ +
+

Owner

+
+ +Site identifier of the simulation originator + +
+
Name
+
owner
+
+ + + +
+
Characteristic
+ +
+ + +
+
Optional
+
+ Nein
+
+ +
+
Im Payload
+
+ Ja
+
+ +
+
Payload Schlüssel
+
owner
+
+ + +
+
+ +
+

RunId

+
+ +Id of the simulation run + +
+
Name
+
runId
+
+ + + +
+
Characteristic
+ +
+ +
+
Beispiel
+
0fece48b-c8d1-4180-1a9caca6d67e
+
+ +
+
Optional
+
+ Nein
+
+ +
+
Im Payload
+
+ Ja
+
+ +
+
Payload Schlüssel
+
runId
+
+ + +
+
+ +
+

Shipments

+
+ +List of shipments + +
+
Name
+
shipments
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Sortierung
+
+
+
Erlaubt Duplikate
+
+ +
+
+
+ + +
+
Optional
+
+ Nein
+
+ +
+
Im Payload
+
+ Ja
+
+ +
+
Payload Schlüssel
+
shipments
+
+ + +
+
+ +
+

Timestamp

+
+ +Timestamp of simulation run + +
+
Name
+
timestamp
+
+ + + +
+
Characteristic
+ +
+ +
+
Beispiel
+
2023-03-09T14:13:42.806Z
+
+ +
+
Optional
+
+ Nein
+
+ +
+
Im Payload
+
+ Ja
+
+ +
+
Payload Schlüssel
+
timestamp
+
+ + +
+
+ + + +
+
+

Objekt

+
+ +
+
+

Business Partner Site

+
+
+ Identifier for the physical location of a business partner plant or site, (e.g. BPNS in Catena-X context) +
+ +
+

Properties

+
+
+
+
+

Handling Unit

+
+
+ Handling Unit is the smallest shipment unit and cannot be divided into several shipments +
+ +
+

Properties

+
+
+ +
+
Handling Unit Id
+
+ +ID of the handling unit + +
+
Name
+
handlingUnitId
+
+ + + +
+
Characteristic
+ +
+ +
+
Beispiel
+
HUT_1
+
+ +
+
Optional
+
+ Nein
+
+ +
+
Im Payload
+
+ Ja
+
+ +
+
Payload Schlüssel
+
handlingUnitId
+
+ + +
+
+ +
+
Name
+
+ +Name of the type of handling unit + +
+
Name
+
name
+
+ + + +
+
Characteristic
+ +
+ +
+
Beispiel
+
Palette
+
+ +
+
Optional
+
+ Nein
+
+ +
+
Im Payload
+
+ Ja
+
+ +
+
Payload Schlüssel
+
name
+
+ + +
+
+ +
+
Volume
+
+ +Volume of the handling unit + +
+
Name
+
volume
+
+ + + +
+
Characteristic
+
+
+
+
Measurement
+
+
+
Volumetric value determining the volume of the handling unit
+
+
+
Einheit
+
+
+
+
    +
  • + litre +
  • +
  • + Symbol l +
  • +
  • + Code LTR +
  • +
  • + Überführungsfaktor 10⁻³ m³ +
  • +
+
+
+ +
+
+
+ +
+
Beispiel
+
1.0
+
+ +
+
Optional
+
+ Nein
+
+ +
+
Im Payload
+
+ Ja
+
+ +
+
Payload Schlüssel
+
volume
+
+ + +
+
+ +
+
Weight
+
+ +Weight of the handling unit + +
+
Name
+
weight
+
+ + + +
+
Characteristic
+
+
+
+
Measurement
+
+
+
Amount of weight of the handling unit
+
+
+
Einheit
+
+
+
+
    +
  • + kilogram +
  • +
  • + Symbol kg +
  • +
  • + Code KGM +
  • +
+
+
+ +
+
+
+ +
+
Beispiel
+
189.0
+
+ +
+
Optional
+
+ Nein
+
+ +
+
Im Payload
+
+ Ja
+
+ +
+
Payload Schlüssel
+
weight
+
+ + +
+
+ +
+
Amount
+
+ +Number of handling units with identical content + +
+
Name
+
amount
+
+ + + +
+
Characteristic
+
+
+
+
Quantifiable
+
+
+
Duration
+
+
+
Number describing handling units with identical pieces
+
+
+
Einheit
+
+
+
+
    +
  • + piece +
  • +
  • + Code H87 +
  • +
+
+
+ +
+
+
+ +
+
Beispiel
+
1
+
+ +
+
Optional
+
+ Nein
+
+ +
+
Im Payload
+
+ Ja
+
+ +
+
Payload Schlüssel
+
amount
+
+ + +
+
+ +
+
Batches
+
+ +List of material batches contained within a handling unit + +
+
Name
+
batches
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Sortierung
+
+
+
Erlaubt Duplikate
+
+ +
+
+
+ + +
+
Optional
+
+ Nein
+
+ +
+
Im Payload
+
+ Ja
+
+ +
+
Payload Schlüssel
+
batches
+
+ + +
+
+
+
+

Material Batch

+
+
+ Material Batches are part of a handling unit +
+ +
+

Properties

+
+
+ +
+
Batch Id
+
+ +ID for the material batch + +
+
Name
+
batchId
+
+ + + +
+
Characteristic
+ +
+ +
+
Beispiel
+
Batch_1
+
+ +
+
Optional
+
+ Nein
+
+ +
+
Im Payload
+
+ Ja
+
+ +
+
Payload Schlüssel
+
batchId
+
+ + +
+
+ +
+
Material Number
+
+ +ID of the material contained in the batch + +
+
Name
+
materialNumber
+
+ + + +
+
Characteristic
+ +
+ +
+
Beispiel
+
KK1000GR
+
+ +
+
Optional
+
+ Nein
+
+ +
+
Im Payload
+
+ Ja
+
+ +
+
Payload Schlüssel
+
materialNumber
+
+ + +
+
+ +
+
Material Name
+
+ +Name of the material + +
+
Name
+
materialName
+
+ + + +
+
Characteristic
+ +
+ +
+
Beispiel
+
KK1000GR-Gehäuse-Rot
+
+ +
+
Optional
+
+ Nein
+
+ +
+
Im Payload
+
+ Ja
+
+ +
+
Payload Schlüssel
+
materialName
+
+ + +
+
+ +
+
Hazardous Goods
+
+ +Flags hazardous goods + +
+
Name
+
hazardousGoods
+
+ + + +
+
Characteristic
+ +
+ +
+
Beispiel
+
false
+
+ +
+
Optional
+
+ Nein
+
+ +
+
Im Payload
+
+ Ja
+
+ +
+
Payload Schlüssel
+
hazardousGoods
+
+ + +
+
+ +
+
Batch Expiration Timestamp
+
+ +Expiration date of batch + +
+
Name
+
batchExpirationTimestamp
+
+ + + +
+
Characteristic
+ +
+ +
+
Beispiel
+
2023-08-22T16:00:00.000Z
+
+ +
+
Optional
+
+ Nein
+
+ +
+
Im Payload
+
+ Ja
+
+ +
+
Payload Schlüssel
+
batchExpirationTimestamp
+
+ + +
+
+ +
+
Quantity
+
+ +Amount of materials + +
+
Name
+
quantity
+
+ + + +
+
Characteristic
+ +
+ +
+
Beispiel
+
50.0
+
+ +
+
Optional
+
+ Nein
+
+ +
+
Im Payload
+
+ Ja
+
+ +
+
Payload Schlüssel
+
quantity
+
+ + +
+
+ +
+
UnitOfMeasurement
+
+ +Unit used for measuring the quantity + +
+
Name
+
unitOfMeasurement
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Werte
+
+
+
+
    +
  • KG
  • +
  • Liter
  • +
  • Piece
  • +
+
+
+ +
+
+
+ + +
+
Optional
+
+ Nein
+
+ +
+
Im Payload
+
+ Ja
+
+ +
+
Payload Schlüssel
+
unitOfMeasurement
+
+ + +
+
+ +
+
Batch Number
+
+ +Number of the batch, generated by originator (e.g. from ERP system, no uuid) + +
+
Name
+
batchNumber
+
+ + + +
+
Characteristic
+ +
+ +
+
Beispiel
+
45
+
+ +
+
Optional
+
+ Nein
+
+ +
+
Im Payload
+
+ Ja
+
+ +
+
Payload Schlüssel
+
batchNumber
+
+ + +
+
+ +
+
Batch Order Id
+
+ +Order ID to which the batch belongs + +
+
Name
+
batchOrderId
+
+ + + +
+
Characteristic
+ +
+ +
+
Beispiel
+
Order-0001
+
+ +
+
Optional
+
+ Nein
+
+ +
+
Im Payload
+
+ Ja
+
+ +
+
Payload Schlüssel
+
batchOrderId
+
+ + +
+
+
+
+

Shipment

+
+
+ Delivery item from a sender to a recipient containing goods +
+ +
+

Properties

+
+
+ +
+
Shipment Id
+
+ +ID to identify the shipment + +
+
Name
+
shipmentId
+
+ + + +
+
Characteristic
+ +
+ +
+
Beispiel
+
DE51515151
+
+ +
+
Optional
+
+ Nein
+
+ +
+
Im Payload
+
+ Ja
+
+ +
+
Payload Schlüssel
+
shipmentId
+
+ + +
+
+ +
+
Destination
+
+ +Address where the shipment is immediately delivered to (by logistician) or provided for pickup (by producer) + +
+
Name
+
destination
+
+ + + +
+
Characteristic
+ +
+ + +
+
Optional
+
+ Nein
+
+ +
+
Im Payload
+
+ Ja
+
+ +
+
Payload Schlüssel
+
destination
+
+ + +
+
+ +
+
Destination Timestamp
+
+ +Time when delivery arrives or is ready at goods issue + +
+
Name
+
destinationTimestamp
+
+ + + +
+
Characteristic
+ +
+ +
+
Beispiel
+
2023-03-19T09:00:00.000Z
+
+ +
+
Optional
+
+ Nein
+
+ +
+
Im Payload
+
+ Ja
+
+ +
+
Payload Schlüssel
+
destinationTimestamp
+
+ + +
+
+ +
+
Recipient
+
+ +Address of final recipient of shipment + +
+
Name
+
recipient
+
+ + + +
+
Characteristic
+ +
+ + +
+
Optional
+
+ Nein
+
+ +
+
Im Payload
+
+ Ja
+
+ +
+
Payload Schlüssel
+
recipient
+
+ + +
+
+ +
+
Recipient Timestamp Planned
+
+ +Planned delivery time + +
+
Name
+
recipientTimestampPlanned
+
+ + + +
+
Characteristic
+ +
+ +
+
Beispiel
+
2023-04-19T09:00:00.000Z
+
+ +
+
Optional
+
+ Nein
+
+ +
+
Im Payload
+
+ Ja
+
+ +
+
Payload Schlüssel
+
recipientTimestampPlanned
+
+ + +
+
+ +
+
Splitting Allowed
+
+ +Permission to split the shipment into individual deliveries + +
+
Name
+
splittingAllowed
+
+ + + +
+
Characteristic
+ +
+ +
+
Beispiel
+
true
+
+ +
+
Optional
+
+ Nein
+
+ +
+
Im Payload
+
+ Ja
+
+ +
+
Payload Schlüssel
+
splittingAllowed
+
+ + +
+
+ +
+
Logistics
+
+ +Address of logistician executing the shipment + +
+
Name
+
logistics
+
+ + + +
+
Characteristic
+ +
+ + +
+
Optional
+
+ Nein
+
+ +
+
Im Payload
+
+ Ja
+
+ +
+
Payload Schlüssel
+
logistics
+
+ + +
+
+ +
+
Preceding
+
+ +Reference ID of a preceding shipment + +
+
Name
+
preceding
+
+ + + +
+
Characteristic
+ +
+ + +
+
Optional
+
+ Nein
+
+ +
+
Im Payload
+
+ Ja
+
+ +
+
Payload Schlüssel
+
preceding
+
+ + +
+
+ +
+
Handling Units
+
+ +List of Handling Units + +
+
Name
+
handlingUnits
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Sortierung
+
+
+
Erlaubt Duplikate
+
+ +
+
+
+ + +
+
Optional
+
+ Nein
+
+ +
+
Im Payload
+
+ Ja
+
+ +
+
Payload Schlüssel
+
handlingUnits
+
+ + +
+
+
+ +
+ Third party licenses + +
+ +
+ + +
+ + + \ No newline at end of file diff --git a/io.catenax.material_flow_simulation_result/1.0.0/gen/MaterialFlowSimulationResult.json b/io.catenax.material_flow_simulation_result/1.0.0/gen/MaterialFlowSimulationResult.json new file mode 100644 index 00000000..0ff19be9 --- /dev/null +++ b/io.catenax.material_flow_simulation_result/1.0.0/gen/MaterialFlowSimulationResult.json @@ -0,0 +1,37 @@ +{ + "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", + "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" : { }, + "recipient" : { }, + "logistics" : { }, + "preceding" : { }, + "splittingAllowed" : true, + "destinationTimestamp" : "2023-03-19T09:00:00.000Z" + } ], + "timestamp" : "2023-03-09T14:13:42.806Z" +} \ No newline at end of file diff --git a/io.catenax.material_flow_simulation_result/1.0.0/gen/MaterialFlowSimulationResult.yml b/io.catenax.material_flow_simulation_result/1.0.0/gen/MaterialFlowSimulationResult.yml new file mode 100644 index 00000000..e67e6d33 --- /dev/null +++ b/io.catenax.material_flow_simulation_result/1.0.0/gen/MaterialFlowSimulationResult.yml @@ -0,0 +1,343 @@ +--- +openapi: 3.0.3 +info: + title: Material Flow Simulation Result + version: v1 +servers: +- url: catenax.io/api/v1 + variables: + api-version: + default: v1 +paths: + /{tenant-id}/material-flow-simulation-result: + get: + tags: + - MaterialFlowSimulationResult + operationId: getMaterialFlowSimulationResult + parameters: + - name: tenant-id + in: path + description: The ID of the tenant owning the requested Twin. + required: true + schema: + type: string + format: uuid + - name: start + in: query + description: Starting index which is starting by 0 + required: false + schema: + type: number + - name: count + in: query + description: Number of items to return per call. + required: false + schema: + type: number + - name: totalItemCount + in: query + description: Flag that indicates that the total counts should be returned. + required: false + schema: + type: boolean + responses: + "200": + $ref: '#/components/responses/MaterialFlowSimulationResult' + "401": + $ref: '#/components/responses/ClientError' + "402": + $ref: '#/components/responses/Unauthorized' + "403": + $ref: '#/components/responses/Forbidden' + "404": + $ref: '#/components/responses/NotFoundError' +components: + schemas: + ErrorResponse: + type: object + required: + - error + properties: + error: + $ref: '#/components/schemas/Error' + Error: + type: object + required: + - details + properties: + message: + type: string + minLength: 1 + path: + type: string + minLength: 1 + details: + type: object + minLength: 1 + additionalProperties: + type: object + code: + type: string + nullable: true + PagingSchema: + type: object + properties: + items: + type: array + items: + $ref: '#/components/schemas/MaterialFlowSimulationResult' + totalItems: + type: number + totalPages: + type: number + pageSize: + type: number + currentPage: + type: number + urn_bamm_io.openmanufacturing_characteristic_2.0.0_Timestamp: + type: string + 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))?" + description: Describes a Property which contains the date and time with an optional + timezone. + urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text: + type: string + description: "Describes a Property which contains plain text. This is intended\ + \ exclusively for human readable strings, not for identifiers, measurement\ + \ values, etc." + urn_bamm_io.catenax.material_flow_simulation_result_1.0.0_BusinessPartnerSite: + description: Site identifier of the simulation originator + type: object + properties: {} + urn_bamm_io.openmanufacturing_characteristic_2.0.0_Boolean: + type: boolean + description: Represents a boolean value (i.e. a "flag"). + urn_bamm_io.catenax.material_flow_simulation_result_1.0.0_Text: + type: string + description: "Describes a Property which contains plain text. This is intended\ + \ exclusively for human readable strings, not for identifiers, measurement\ + \ values, etc." + urn_bamm_io.catenax.material_flow_simulation_result_1.0.0_VolumeCharacteristic: + type: number + description: Volumetric value determining the volume of the handling unit + urn_bamm_io.catenax.material_flow_simulation_result_1.0.0_WeightCharacteristic: + type: number + description: Amount of weight of the handling unit + urn_bamm_io.catenax.material_flow_simulation_result_1.0.0_AmountCharacteristic: + type: number + minimum: 1 + description: Number describing handling units with identical pieces + urn_bamm_io.catenax.material_flow_simulation_result_1.0.0_QuantityCharacteristic: + type: number + description: Number of materials contained within a handling unit + urn_bamm_io.catenax.material_flow_simulation_result_1.0.0_UnitOfMeasurementCharacteristic: + type: string + description: Possible options for units of measurement + enum: + - KG + - Liter + - Piece + urn_bamm_io.catenax.material_flow_simulation_result_1.0.0_MaterialBatch: + description: Material Batches are part of a handling unit + type: object + properties: + batchId: + description: ID for the material batch + $ref: '#/components/schemas/urn_bamm_io.catenax.material_flow_simulation_result_1.0.0_Text' + materialNumber: + description: ID of the material contained in the batch + $ref: '#/components/schemas/urn_bamm_io.catenax.material_flow_simulation_result_1.0.0_Text' + materialName: + description: Name of the material + $ref: '#/components/schemas/urn_bamm_io.catenax.material_flow_simulation_result_1.0.0_Text' + hazardousGoods: + description: Flags hazardous goods + $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Boolean' + batchExpirationTimestamp: + description: Expiration date of batch + $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Timestamp' + quantity: + description: Amount of materials + $ref: '#/components/schemas/urn_bamm_io.catenax.material_flow_simulation_result_1.0.0_QuantityCharacteristic' + unitOfMeasurement: + description: Unit used for measuring the quantity + $ref: '#/components/schemas/urn_bamm_io.catenax.material_flow_simulation_result_1.0.0_UnitOfMeasurementCharacteristic' + batchNumber: + description: "Number of the batch, generated by originator (e.g. from ERP\ + \ system, no uuid)" + $ref: '#/components/schemas/urn_bamm_io.catenax.material_flow_simulation_result_1.0.0_Text' + batchOrderId: + description: Order ID to which the batch belongs + $ref: '#/components/schemas/urn_bamm_io.catenax.material_flow_simulation_result_1.0.0_Text' + required: + - batchId + - materialNumber + - materialName + - hazardousGoods + - batchExpirationTimestamp + - quantity + - unitOfMeasurement + - batchNumber + - batchOrderId + urn_bamm_io.catenax.material_flow_simulation_result_1.0.0_BatchList: + description: List of material batches + type: array + items: + $ref: '#/components/schemas/urn_bamm_io.catenax.material_flow_simulation_result_1.0.0_MaterialBatch' + urn_bamm_io.catenax.material_flow_simulation_result_1.0.0_HandlingUnit: + description: Handling Unit is the smallest shipment unit and cannot be divided + into several shipments + type: object + properties: + handlingUnitId: + description: ID of the handling unit + $ref: '#/components/schemas/urn_bamm_io.catenax.material_flow_simulation_result_1.0.0_Text' + name: + description: Name of the type of handling unit + $ref: '#/components/schemas/urn_bamm_io.catenax.material_flow_simulation_result_1.0.0_Text' + volume: + description: Volume of the handling unit + $ref: '#/components/schemas/urn_bamm_io.catenax.material_flow_simulation_result_1.0.0_VolumeCharacteristic' + weight: + description: Weight of the handling unit + $ref: '#/components/schemas/urn_bamm_io.catenax.material_flow_simulation_result_1.0.0_WeightCharacteristic' + amount: + description: Number of handling units with identical content + $ref: '#/components/schemas/urn_bamm_io.catenax.material_flow_simulation_result_1.0.0_AmountCharacteristic' + batches: + description: List of material batches contained within a handling unit + $ref: '#/components/schemas/urn_bamm_io.catenax.material_flow_simulation_result_1.0.0_BatchList' + required: + - handlingUnitId + - name + - volume + - weight + - amount + - batches + urn_bamm_io.catenax.material_flow_simulation_result_1.0.0_HandlingUnitList: + description: List of handling units included in the shipment + type: array + items: + $ref: '#/components/schemas/urn_bamm_io.catenax.material_flow_simulation_result_1.0.0_HandlingUnit' + urn_bamm_io.catenax.material_flow_simulation_result_1.0.0_Shipment: + description: Delivery item from a sender to a recipient containing goods + type: object + properties: + shipmentId: + description: ID to identify the shipment + $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text' + destination: + description: Address where the shipment is immediately delivered to (by + logistician) or provided for pickup (by producer) + $ref: '#/components/schemas/urn_bamm_io.catenax.material_flow_simulation_result_1.0.0_BusinessPartnerSite' + destinationTimestamp: + description: Time when delivery arrives or is ready at goods issue + $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Timestamp' + recipient: + description: Address of final recipient of shipment + $ref: '#/components/schemas/urn_bamm_io.catenax.material_flow_simulation_result_1.0.0_BusinessPartnerSite' + recipientTimestampPlanned: + description: Planned delivery time + $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Timestamp' + splittingAllowed: + description: Permission to split the shipment into individual deliveries + $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Boolean' + logistics: + description: Address of logistician executing the shipment + $ref: '#/components/schemas/urn_bamm_io.catenax.material_flow_simulation_result_1.0.0_BusinessPartnerSite' + preceding: + description: Reference ID of a preceding shipment + $ref: '#/components/schemas/urn_bamm_io.catenax.material_flow_simulation_result_1.0.0_BusinessPartnerSite' + handlingUnits: + description: List of Handling Units + $ref: '#/components/schemas/urn_bamm_io.catenax.material_flow_simulation_result_1.0.0_HandlingUnitList' + required: + - shipmentId + - destination + - destinationTimestamp + - recipient + - recipientTimestampPlanned + - splittingAllowed + - logistics + - preceding + - handlingUnits + urn_bamm_io.catenax.material_flow_simulation_result_1.0.0_ShipmentList: + description: List of shipments contained in the simulation + type: array + items: + $ref: '#/components/schemas/urn_bamm_io.catenax.material_flow_simulation_result_1.0.0_Shipment' + urn_bamm_io.catenax.material_flow_simulation_result_1.0.0_DataQualityOptions: + type: number + minimum: 1 + description: Possible values determining data quality + enum: + - 0 + - 1 + - 2 + - 3 + - 4 + - 5 + MaterialFlowSimulationResult: + description: Result of a Material Flow Simulation + type: object + properties: + timestamp: + description: Timestamp of simulation run + $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Timestamp' + shipments: + description: List of shipments + $ref: '#/components/schemas/urn_bamm_io.catenax.material_flow_simulation_result_1.0.0_ShipmentList' + dataQuality: + description: Information on quality of simulation results + $ref: '#/components/schemas/urn_bamm_io.catenax.material_flow_simulation_result_1.0.0_DataQualityOptions' + comment: + description: Additional comments + $ref: '#/components/schemas/urn_bamm_io.catenax.material_flow_simulation_result_1.0.0_Text' + expirationTimestamp: + description: Date and time when the simulation is expired + $ref: '#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Timestamp' + runId: + description: Id of the simulation run + $ref: '#/components/schemas/urn_bamm_io.catenax.material_flow_simulation_result_1.0.0_Text' + owner: + description: Site identifier of the simulation originator + $ref: '#/components/schemas/urn_bamm_io.catenax.material_flow_simulation_result_1.0.0_BusinessPartnerSite' + description: + description: Verbal description + $ref: '#/components/schemas/urn_bamm_io.catenax.material_flow_simulation_result_1.0.0_Text' + required: + - timestamp + - shipments + - dataQuality + - comment + - expirationTimestamp + - runId + - owner + - description + responses: + Unauthorized: + description: The requesting user or client is not authenticated. + Forbidden: + description: The requesting user or client is not authorized to access resources + for the given tenant. + NotFoundError: + description: The requested Twin has not been found. + ClientError: + description: Payload or user input is invalid. See error details in the payload + for more. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + MaterialFlowSimulationResult: + content: + application/json: + schema: + $ref: '#/components/schemas/PagingSchema' + description: The request was successful. + requestBodies: + MaterialFlowSimulationResult: + content: + application/json: + schema: + $ref: '#/components/schemas/MaterialFlowSimulationResult'