From 43f52db9a2720a139ba2041404fca8980bf31127 Mon Sep 17 00:00:00 2001 From: Sahil Aggarwal Date: Wed, 17 Apr 2024 12:08:03 +0200 Subject: [PATCH] regenerated artifacts --- .../1.0.0/gen/Vehicles-aas.xml | 4526 +++++++++++++++++ .../1.0.0/gen/Vehicles-schema.json | 360 ++ .../1.0.0/gen/Vehicles.aasx | Bin 0 -> 10659 bytes .../1.0.0/gen/Vehicles.html | 3535 +++++++++++++ .../1.0.0/gen/Vehicles.json | 58 + .../1.0.0/gen/Vehicles.yml | 553 ++ .../2.0.0/gen/PartsAnalyses-aas.xml | 1268 +++++ .../2.0.0/gen/PartsAnalyses-schema.json | 133 + .../2.0.0/gen/PartsAnalyses.aasx | Bin 0 -> 5075 bytes .../2.0.0/gen/PartsAnalyses.html | 1305 +++++ .../2.0.0/gen/PartsAnalyses.json | 20 + .../2.0.0/gen/PartsAnalyses.yml | 254 + .../1.0.0/gen/QualityTaskAttachment-aas.xml | 1282 +++++ .../gen/QualityTaskAttachment-schema.json | 130 + .../1.0.0/gen/QualityTaskAttachment.aasx | Bin 0 -> 5223 bytes .../1.0.0/gen/QualityTaskAttachment.html | 1291 +++++ .../1.0.0/gen/QualityTaskAttachment.json | 21 + .../1.0.0/gen/QualityTaskAttachment.yml | 242 + .../3.0.0/gen/ProductDescription-aas.xml | 4504 ++++++++++++++++ .../3.0.0/gen/ProductDescription-schema.json | 353 ++ .../3.0.0/gen/ProductDescription.aasx | Bin 0 -> 10571 bytes .../3.0.0/gen/ProductDescription.html | 3528 +++++++++++++ .../3.0.0/gen/ProductDescription.json | 58 + .../3.0.0/gen/ProductDescription.yml | 515 ++ 24 files changed, 23936 insertions(+) create mode 100644 io.catenax.fleet.vehicles/1.0.0/gen/Vehicles-aas.xml create mode 100644 io.catenax.fleet.vehicles/1.0.0/gen/Vehicles-schema.json create mode 100644 io.catenax.fleet.vehicles/1.0.0/gen/Vehicles.aasx create mode 100644 io.catenax.fleet.vehicles/1.0.0/gen/Vehicles.html create mode 100644 io.catenax.fleet.vehicles/1.0.0/gen/Vehicles.json create mode 100644 io.catenax.fleet.vehicles/1.0.0/gen/Vehicles.yml create mode 100644 io.catenax.parts_analyses/2.0.0/gen/PartsAnalyses-aas.xml create mode 100644 io.catenax.parts_analyses/2.0.0/gen/PartsAnalyses-schema.json create mode 100644 io.catenax.parts_analyses/2.0.0/gen/PartsAnalyses.aasx create mode 100644 io.catenax.parts_analyses/2.0.0/gen/PartsAnalyses.html create mode 100644 io.catenax.parts_analyses/2.0.0/gen/PartsAnalyses.json create mode 100644 io.catenax.parts_analyses/2.0.0/gen/PartsAnalyses.yml create mode 100644 io.catenax.quality_task_attachment/1.0.0/gen/QualityTaskAttachment-aas.xml create mode 100644 io.catenax.quality_task_attachment/1.0.0/gen/QualityTaskAttachment-schema.json create mode 100644 io.catenax.quality_task_attachment/1.0.0/gen/QualityTaskAttachment.aasx create mode 100644 io.catenax.quality_task_attachment/1.0.0/gen/QualityTaskAttachment.html create mode 100644 io.catenax.quality_task_attachment/1.0.0/gen/QualityTaskAttachment.json create mode 100644 io.catenax.quality_task_attachment/1.0.0/gen/QualityTaskAttachment.yml create mode 100644 io.catenax.vehicle.product_description/3.0.0/gen/ProductDescription-aas.xml create mode 100644 io.catenax.vehicle.product_description/3.0.0/gen/ProductDescription-schema.json create mode 100644 io.catenax.vehicle.product_description/3.0.0/gen/ProductDescription.aasx create mode 100644 io.catenax.vehicle.product_description/3.0.0/gen/ProductDescription.html create mode 100644 io.catenax.vehicle.product_description/3.0.0/gen/ProductDescription.json create mode 100644 io.catenax.vehicle.product_description/3.0.0/gen/ProductDescription.yml diff --git a/io.catenax.fleet.vehicles/1.0.0/gen/Vehicles-aas.xml b/io.catenax.fleet.vehicles/1.0.0/gen/Vehicles-aas.xml new file mode 100644 index 00000000..5482ec30 --- /dev/null +++ b/io.catenax.fleet.vehicles/1.0.0/gen/Vehicles-aas.xml @@ -0,0 +1,4526 @@ + + + + + defaultAdminShell + + + en + defaultAdminShell + + + + urn:samm:io.catenax.fleet.vehicles:1.0.0#Vehicles + + Type + + + + ModelReference + + + Submodel + urn:samm:io.catenax.fleet.vehicles:1.0.0#Vehicles/submodel + + + + + + + + + Vehicles + + + en + Fleet of vehicles. This model is a shell around io.catenax.vehicle.product_description 3.0.0 +It allows to send multiple io.catenax.vehicle.product_description. + + + + urn:samm:io.catenax.fleet.vehicles:1.0.0#Vehicles/submodel + Template + + ModelReference + + + ConceptDescription + urn:samm:io.catenax.fleet.vehicles:1.0.0#Vehicles + + + + + + listOfVehicles + + + en + listOfVehicles + + + + + en + List of Vehicle.ProductDescription + + + true + DataElement + + + Vehicle + + + en + Vehicle + + + + + en + Vehicle data that does not fit into one of the other entities. + + + + + anonymizedVin + + + en + Anonymized VIN + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.vehicle.product_description:3.0.0#anonymizedVin + + + + xs:string + + + + catenaXId + + + en + Vehicle Catena-X Identifier + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.vehicle.product_description:3.0.0#catenaXId + + + + xs:string + + + + vehicleSeries + + + en + Vehicle series + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.vehicle.product_description:3.0.0#vehicleSeries + + + + xs:string + + + + modelDescription + + + en + Vehicle model + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.vehicle.product_description:3.0.0#modelDescription + + + + xs:string + + + + modelIdentifier + + + en + Model identifier + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.vehicle.product_description:3.0.0#modelIdentifier + + + + xs:string + + + + class + + + en + Vehicle class + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.vehicle.product_description:3.0.0#class + + + + xs:string + + + + steeringPos + + + en + Vehicle steering pos + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.vehicle.product_description:3.0.0#steeringPos + + + + xs:string + + + + emptyWeight + + + en + Vehicle empty weight + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.vehicle.product_description:3.0.0#emptyWeight + + + + xs:double + + + + driveType + + + en + Drive type + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.vehicle.product_description:3.0.0#driveType + + + + xs:string + + + + systemPower + + + en + Complete system power + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.vehicle.product_description:3.0.0#systemPower + + + + xs:integer + + + + hybridizationType + + + en + Hybridization + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.vehicle.product_description:3.0.0#hybridizationType + + + + xs:string + + + + softwareCategory + + + en + Software category + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.vehicle.product_description:3.0.0#softwareCategory + + + + xs:string + + + + softwareVersion + + + en + Software version + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.vehicle.product_description:3.0.0#softwareVersion + + + + xs:string + + + + OriginalEquipmentManufacturer + + + en + OEM + + + + + en + Describes one original eequipment manufacturer (OEM) to which this vehicle belongs to. + + + + + wmiCode + + + en + WMI Code + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.vehicle.product_description:3.0.0#wmiCode + + + + + + ExternalReference + + + GlobalReference + https://vpic.nhtsa.dot.gov/ + + + + + xs:string + + + + wmiDescription + + + en + OEM name + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.vehicle.product_description:3.0.0#wmiDescription + + + + + + ExternalReference + + + GlobalReference + https://vpic.nhtsa.dot.gov/ + + + + + xs:string + + + + cxBPN + + + en + CX Business partner number + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.vehicle.product_description:3.0.0#cxBPN + + + + xs:string + + + + + + Body + + + en + Body + + + + + en + All vhicel body-related data. + + + + + numberOfDoors + + + en + Number of doors + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.vehicle.product_description:3.0.0#numberOfDoors + + + + xs:positiveInteger + + + + colorId + + + en + Color identifier + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.vehicle.product_description:3.0.0#colorId + + + + xs:string + + + + colorDescription + + + en + Color description + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.vehicle.product_description:3.0.0#colorDescription + + + + xs:string + + + + kbaBody + + + en + Body variant(KBA) + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.vehicle.product_description:3.0.0#kbaBody + + + + xs:string + + + + nhtsaBody + + + en + Body variant(NHTSA) + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.vehicle.product_description:3.0.0#nhtsaBody + + + + xs:string + + + + + + equipments + + + en + Equipments + + + + + en + Equipments. + + + true + DataElement + + + Equipment + + + en + Equipment + + + + + en + One equipment of the vehicle. + + + + + equipmentIdentifier + + + en + Equipment Id + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.vehicle.product_description:3.0.0#equipmentIdentifier + + + + xs:string + + + + equipmentDescription + + + en + Equipment description + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.vehicle.product_description:3.0.0#equipmentDescription + + + + xs:string + + + + group + + + en + Equipment group + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.vehicle.product_description:3.0.0#group + + + + xs:string + + + + + + + + Production + + + en + Production + + + + + en + Entity to bundle all production-related data. + + + + + productionDate + + + en + Vehicle production Date + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.vehicle.product_description:3.0.0#productionDate + + + + xs:dateTime + + + + plantIdentifier + + + en + Production plant id + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.vehicle.product_description:3.0.0#plantIdentifier + + + + xs:string + + + + plantDescription + + + en + Vehicle production plant name + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.vehicle.product_description:3.0.0#plantDescription + + + + xs:string + + + + + + Sale + + + en + Sale + + + + + en + Bundels all sale-related data + + + + + soldDate + + + en + Vehicle sold date: + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.vehicle.product_description:3.0.0#soldDate + + + + xs:dateTime + + + + countryCode + + + en + Vehicle sold country + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.vehicle.product_description:3.0.0#countryCode + + + + xs:string + + + + countryGroup + + + en + Vehicle sold region + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.vehicle.product_description:3.0.0#countryGroup + + + + xs:string + + + + + + engines + + + en + Engines + + + + + en + List of installed engines in the vehicle. + + + true + DataElement + + + Engine + + + en + Engine Entity + + + + + en + Describing one installed engine + + + + + engineId + + + en + Engine ID: + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.vehicle.product_description:3.0.0#engineId + + + + xs:string + + + + engineDescription + + + en + Engine Description + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.vehicle.product_description:3.0.0#engineDescription + + + + xs:string + + + + engineSeries + + + en + Vehicle engine series + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.vehicle.product_description:3.0.0#engineSeries + + + + xs:string + + + + serialNumber + + + en + Engine serial number + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.vehicle.product_description:3.0.0#serialNumber + + + + xs:string + + + + size + + + en + Engine size + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.vehicle.product_description:3.0.0#size + + + + xs:integer + + + + power + + + en + Engine power + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.vehicle.product_description:3.0.0#power + + + + xs:integer + + + + engineProductionDate + + + en + Engine production date + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.vehicle.product_description:3.0.0#engineProductionDate + + + + xs:dateTime + + + + installDate + + + en + Engine install date + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.vehicle.product_description:3.0.0#installDate + + + + xs:dateTime + + + + + + + + Fuel + + + en + Fuel + + + + + en + Bundels all fuel-related data. + + + + + kbaFuelType + + + en + Fuel type(KBA) + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.vehicle.product_description:3.0.0#kbaFuelType + + + + xs:string + + + + nhtsaFuelType + + + en + Fuel type(NHTSA) + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.vehicle.product_description:3.0.0#nhtsaFuelType + + + + xs:string + + + + + + + + + + + + + + APPLICATION_CLASS + Vehicles + + + en + Vehicles + + + + + en + Fleet of vehicles. This model is a shell around io.catenax.vehicle.product_description 3.0.0 +It allows to send multiple io.catenax.vehicle.product_description. + + + urn:samm:io.catenax.fleet.vehicles:1.0.0#Vehicles + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Vehicles + + + + + en + Vehicles + + + + + en + Fleet of vehicles. This model is a shell around io.catenax.vehicle.product_description 3.0.0 +It allows to send multiple io.catenax.vehicle.product_description. + + + + + + + + + anonymizedVin + + + en + Anonymized VIN + + + urn:samm:io.catenax.vehicle.product_description:3.0.0#anonymizedVin + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Anonymized VIN + + + + + en + anonymizedVin + + + STRING + + + en + OEM-specific hashed VIN; link to car data over pseydomized/hashed VIN or Catena-X unique digital twin identifier. + + + + + + + + + catenaXId + + + en + Vehicle Catena-X Identifier + + + urn:samm:io.catenax.vehicle.product_description:3.0.0#catenaXId + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Vehicle Catena-X Identifier + + + + + en + catenaXId + + + STRING + + + en + A fully anonymous Catena-X identifier that is registered in C-X Digital twin registry. Can be used for vehicles, parts, workshops, ..... + + + + + + + + + vehicleSeries + + + en + Vehicle series + + + urn:samm:io.catenax.vehicle.product_description:3.0.0#vehicleSeries + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Vehicle series + + + + + en + vehicleSeries + + + STRING + + + en + vehicle series, normally one level above model. E.g. vehicle series ="Golf", vehicle model="Golf VIII" + + + + + + + + + modelDescription + + + en + Vehicle model + + + urn:samm:io.catenax.vehicle.product_description:3.0.0#modelDescription + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Vehicle model + + + + + en + modelDescription + + + STRING + + + en + Detail vehicle model like "Golf VIII" + + + + + + + + + modelIdentifier + + + en + Model identifier + + + urn:samm:io.catenax.vehicle.product_description:3.0.0#modelIdentifier + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Model identifier + + + + + en + modelIdentifier + + + STRING + + + en + OEM-specific model identifier or OEM-specific project name. + + + + + + + + + class + + + en + Vehicle class + + + urn:samm:io.catenax.vehicle.product_description:3.0.0#class + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Vehicle class + + + + + en + class + + + STRING + + + en + Class of the vehicle. + + + + + + + + + steeringPos + + + en + Vehicle steering pos + + + urn:samm:io.catenax.vehicle.product_description:3.0.0#steeringPos + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Vehicle steering pos + + + + + en + steeringPos + + + STRING + + + en + Position of vehicle steering wheel, Left or right. + + + + + + Left-Hand Drive + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#VehicleSteeringPos:Left-Hand Drive + + + + + + Right-Hand Drive + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#VehicleSteeringPos:Right-Hand Drive + + + + + + + + + + + + + emptyWeight + + + en + Vehicle empty weight + + + urn:samm:io.catenax.vehicle.product_description:3.0.0#emptyWeight + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Vehicle empty weight + + + + + en + emptyWeight + + + kilogram + REAL_MEASURE + + + en + The empty weight of the vehicle in kg as specified. + + + + + + + + + driveType + + + en + Drive type + + + urn:samm:io.catenax.vehicle.product_description:3.0.0#driveType + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Drive type + + + + + en + driveType + + + STRING + + + en + Drive type of a vehicle according enumeration. + + + + + + All-Wheel Drive + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#DriveTypeNHTSA:All-Wheel Drive + + + + + + Front-Wheel Drive + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#DriveTypeNHTSA:Front-Wheel Drive + + + + + + Rear-Wheel Drive + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#DriveTypeNHTSA:Rear-Wheel Drive + + + + + + + + + + + + + systemPower + + + en + Complete system power + + + urn:samm:io.catenax.vehicle.product_description:3.0.0#systemPower + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Complete system power + + + + + en + systemPower + + + kilowatt + INTEGER_MEASURE + + + en + Complete power of this vehicle in KW. + + + + + + + + + hybridizationType + + + en + Hybridization + + + urn:samm:io.catenax.vehicle.product_description:3.0.0#hybridizationType + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Hybridization + + + + + en + hybridizationType + + + STRING + + + en + Degree of hybridization in this vehicle. + + + + + + battery electric vehicle + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#Hybridization:battery electric vehicle + + + + + + hybrid electric vehicle + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#Hybridization:hybrid electric vehicle + + + + + + no hybrid + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#Hybridization:no hybrid + + + + + + plugin hybrid electric vehicle + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#Hybridization:plugin hybrid electric vehicle + + + + + + range extender + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#Hybridization:range extender + + + + + + + + + + + + + softwareCategory + + + en + Software category + + + urn:samm:io.catenax.vehicle.product_description:3.0.0#softwareCategory + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Software category + + + + + en + softwareCategory + + + STRING + + + en + Some OEMs bring in the software as complete package for all systems: +To identify this software: software category and software version is needed. +Software category when this car was built. + + + + + + + + + softwareVersion + + + en + Software version + + + urn:samm:io.catenax.vehicle.product_description:3.0.0#softwareVersion + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Software version + + + + + en + softwareVersion + + + STRING + + + en + Some OEMs brings in the software as complete package for all systems: +To identify this software: software category and software version is needed. +Software version when this car was built +. + + + + + + + + + wmiCode + + + en + WMI Code + + + urn:samm:io.catenax.vehicle.product_description:3.0.0#wmiCode + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + WMI Code + + + + + en + wmiCode + + + STRING + + + en + Short name/code of vehicle manufacturer according to world manufacturer information(wmi). The wmiCode are the first 3 chars of the vehicle identification number. +A list of in NHTSA registered wmiCodes can be found in attribute Wmi in table [vPICList_lite].[dbo].[Wmi] + + + + + + + + + wmiDescription + + + en + OEM name + + + urn:samm:io.catenax.vehicle.product_description:3.0.0#wmiDescription + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + OEM name + + + + + en + wmiDescription + + + STRING + + + en + Name of OEM according NHTSA or other authorities. Has to be compliant with/linked wmiCode attribute. +For NHTSA: name of table [vPICList_lite].[dbo].[Manufacturer] + + + + + + + + + cxBPN + + + en + CX Business partner number + + + urn:samm:io.catenax.vehicle.product_description:3.0.0#cxBPN + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + CX Business partner number + + + + + en + cxBPN + + + STRING + + + en + Catena-X business partner number of this company. + + + + + + + + + oem + + + en + OEM + + + urn:samm:io.catenax.vehicle.product_description:3.0.0#oem + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + OEM + + + + + en + oem + + + STRING + + + en + Original equipment manufacturer. + + + + + + + + + numberOfDoors + + + en + Number of doors + + + urn:samm:io.catenax.vehicle.product_description:3.0.0#numberOfDoors + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Number of doors + + + + + en + numberOfDoors + + + INTEGER_COUNT + + + en + Describes the number of doors of a vehicle. + + + + + + + + + colorId + + + en + Color identifier + + + urn:samm:io.catenax.vehicle.product_description:3.0.0#colorId + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Color identifier + + + + + en + colorId + + + STRING + + + en + Colour code describes the code of a specific colour of a vehicle. + + + + + + + + + colorDescription + + + en + Color description + + + urn:samm:io.catenax.vehicle.product_description:3.0.0#colorDescription + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Color description + + + + + en + colorDescription + + + STRING + + + en + Colour name describes the colour of the colour code as a written word. + + + + + + + + + kbaBody + + + en + Body variant(KBA) + + + urn:samm:io.catenax.vehicle.product_description:3.0.0#kbaBody + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Body variant(KBA) + + + + + en + kbaBody + + + STRING + + + en + Vehicle variant - Body shapes according German KBA + + + + + + Limousine + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#KbaVariant:Limousine + + + + + + Kombilimousine + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#KbaVariant:Kombilimousine + + + + + + Kabrio-Limousine + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#KbaVariant:Kabrio-Limousine + + + + + + Cabrio-Limousine + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#KbaVariant:Cabrio-Limousine + + + + + + Mehrzweckfahrzeug + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#KbaVariant:Mehrzweckfahrzeug + + + + + + Pkw-Pick-up + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#KbaVariant:Pkw-Pick-up + + + + + + Van + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#KbaVariant:Van + + + + + + Pick-up + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#KbaVariant:Pick-up + + + + + + Coupe + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#KbaVariant:Coupe + + + + + + Schraeghecklimousine + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#KbaVariant:Schraeghecklimousine + + + + + + + + + + + + + nhtsaBody + + + en + Body variant(NHTSA) + + + urn:samm:io.catenax.vehicle.product_description:3.0.0#nhtsaBody + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Body variant(NHTSA) + + + + + en + nhtsaBody + + + STRING + + + en + Vehicle variant - Body shapes according US NHTSA + + + + + + Cargo Van + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#NhtsaVariant:Cargo Van + + + + + + Convertible + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#NhtsaVariant:Convertible + + + + + + Cabriolet + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#NhtsaVariant:Cabriolet + + + + + + Coupe + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#NhtsaVariant:Coupe + + + + + + Crossover Utility Vehicle(CUV) + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#NhtsaVariant:Crossover Utility Vehicle(CUV) + + + + + + Hatchback + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#NhtsaVariant:Hatchback + + + + + + Liftback + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#NhtsaVariant:Liftback + + + + + + Notchback + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#NhtsaVariant:Notchback + + + + + + Limousine + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#NhtsaVariant:Limousine + + + + + + Low Speed Vehicle(LSV) + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#NhtsaVariant:Low Speed Vehicle(LSV) + + + + + + Neighborhood Electric Vehicle(NEV) + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#NhtsaVariant:Neighborhood Electric Vehicle(NEV) + + + + + + Minivan + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#NhtsaVariant:Minivan + + + + + + Pickup + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#NhtsaVariant:Pickup + + + + + + Roadster + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#NhtsaVariant:Roadster + + + + + + Sedan + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#NhtsaVariant:Sedan + + + + + + Saloon + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#NhtsaVariant:Saloon + + + + + + Sport Utility Truck(SUT) + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#NhtsaVariant:Sport Utility Truck(SUT) + + + + + + Sport Utility Vehicle(SUV) + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#NhtsaVariant:Sport Utility Vehicle(SUV) + + + + + + Multi-Purpose Vehicle(MPV) + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#NhtsaVariant:Multi-Purpose Vehicle(MPV) + + + + + + Van + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#NhtsaVariant:Van + + + + + + Wagon + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#NhtsaVariant:Wagon + + + + + + + + + + + + + body + + + en + Vehicle body + + + urn:samm:io.catenax.vehicle.product_description:3.0.0#body + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Vehicle body + + + + + en + body + + + STRING + + + en + Vehicle body. + + + + + + + + + equipmentIdentifier + + + en + Equipment Id + + + urn:samm:io.catenax.vehicle.product_description:3.0.0#equipmentIdentifier + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Equipment Id + + + + + en + equipmentIdentifier + + + STRING + + + en + The identifier of a specific equipment. + + + + + + + + + equipmentDescription + + + en + Equipment description + + + urn:samm:io.catenax.vehicle.product_description:3.0.0#equipmentDescription + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Equipment description + + + + + en + equipmentDescription + + + STRING + + + en + The equipment variants description. + + + + + + + + + group + + + en + Equipment group + + + urn:samm:io.catenax.vehicle.product_description:3.0.0#group + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Equipment group + + + + + en + group + + + STRING + + + en + Bundels all equipment-oriented information into categories like Interior + + + + + + + + + equipments + + + en + Equipments + + + urn:samm:io.catenax.vehicle.product_description:3.0.0#equipments + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Equipments + + + + + en + equipments + + + STRING + + + en + Equipments. + + + + + + + + + productionDate + + + en + Vehicle production Date + + + urn:samm:io.catenax.vehicle.product_description:3.0.0#productionDate + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Vehicle production Date + + + + + en + productionDate + + + STRING + + + en + Production date of the vehicle + + + + + + + + + plantIdentifier + + + en + Production plant id + + + urn:samm:io.catenax.vehicle.product_description:3.0.0#plantIdentifier + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Production plant id + + + + + en + plantIdentifier + + + STRING + + + en + Plant id of the final assembly of the vehicle + + + + + + + + + plantDescription + + + en + Vehicle production plant name + + + urn:samm:io.catenax.vehicle.product_description:3.0.0#plantDescription + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Vehicle production plant name + + + + + en + plantDescription + + + STRING + + + en + Long name of the production plant of the vehicle + + + + + + + + + production + + + en + Production + + + urn:samm:io.catenax.vehicle.product_description:3.0.0#production + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Production + + + + + en + production + + + STRING + + + en + This property bundles production-related information. + + + + + + + + + soldDate + + + en + Vehicle sold date: + + + urn:samm:io.catenax.vehicle.product_description:3.0.0#soldDate + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Vehicle sold date: + + + + + en + soldDate + + + STRING + + + en + Sold date of the vehicle = warranty start date for this vehicle + + + + + + + + + countryCode + + + en + Vehicle sold country + + + urn:samm:io.catenax.vehicle.product_description:3.0.0#countryCode + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Vehicle sold country + + + + + en + countryCode + + + STRING + + + en + Vehicle sold country in ISO 8601 alpha 3 + + + + + + + + + countryGroup + + + en + Vehicle sold region + + + urn:samm:io.catenax.vehicle.product_description:3.0.0#countryGroup + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Vehicle sold region + + + + + en + countryGroup + + + STRING + + + en + Region where this car was sold + + + + + + + + + sale + + + en + Sale + + + urn:samm:io.catenax.vehicle.product_description:3.0.0#sale + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Sale + + + + + en + sale + + + STRING + + + en + This property bundles all sales related information. + + + + + + + + + engineId + + + en + Engine ID: + + + urn:samm:io.catenax.vehicle.product_description:3.0.0#engineId + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Engine ID: + + + + + en + engineId + + + STRING + + + en + OEM-specific identifier/type of the installed engine + + + + + + + + + engineDescription + + + en + Engine Description + + + urn:samm:io.catenax.vehicle.product_description:3.0.0#engineDescription + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Engine Description + + + + + en + engineDescription + + + STRING + + + en + Description of the engine + + + + + + + + + engineSeries + + + en + Vehicle engine series + + + urn:samm:io.catenax.vehicle.product_description:3.0.0#engineSeries + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Vehicle engine series + + + + + en + engineSeries + + + STRING + + + en + Engine series as defined by OEM + + + + + + + + + serialNumber + + + en + Engine serial number + + + urn:samm:io.catenax.vehicle.product_description:3.0.0#serialNumber + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Engine serial number + + + + + en + serialNumber + + + STRING + + + en + Serial number of the installed engine + + + + + + + + + size + + + en + Engine size + + + urn:samm:io.catenax.vehicle.product_description:3.0.0#size + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Engine size + + + + + en + size + + + cubicCentimetre + INTEGER_MEASURE + + + en + Cubic capacity in a combustion engine - not available in battery-electric vehicles + + + + + + + + + power + + + en + Engine power + + + urn:samm:io.catenax.vehicle.product_description:3.0.0#power + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Engine power + + + + + en + power + + + kilowatt + INTEGER_MEASURE + + + en + Engine power is the power that an engine can put out + + + + + + + + + engineProductionDate + + + en + Engine production date + + + urn:samm:io.catenax.vehicle.product_description:3.0.0#engineProductionDate + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Engine production date + + + + + en + engineProductionDate + + + STRING + + + en + Date when the engine was produced + + + + + + + + + installDate + + + en + Engine install date + + + urn:samm:io.catenax.vehicle.product_description:3.0.0#installDate + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Engine install date + + + + + en + installDate + + + STRING + + + en + Date when the engine was installed + + + + + + + + + engines + + + en + Engines + + + urn:samm:io.catenax.vehicle.product_description:3.0.0#engines + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Engines + + + + + en + engines + + + STRING + + + en + List of installed engines in the vehicle. + + + + + + + + + kbaFuelType + + + en + Fuel type(KBA) + + + urn:samm:io.catenax.vehicle.product_description:3.0.0#kbaFuelType + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Fuel type(KBA) + + + + + en + kbaFuelType + + + STRING + + + en + Description of the fuel according german KBA + + + + + + Unbekannt + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#FuelKBA:Unbekannt + + + + + + Diesel + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#FuelKBA:Diesel + + + + + + Benzin + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#FuelKBA:Benzin + + + + + + Vielstoff + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#FuelKBA:Vielstoff + + + + + + Elektro + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#FuelKBA:Elektro + + + + + + Benzin/Fl?ssiggas + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#FuelKBA:Benzin/Fl?ssiggas + + + + + + Benzin/komp.Erdgas + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#FuelKBA:Benzin/komp.Erdgas + + + + + + Hybr.Benzin/E + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#FuelKBA:Hybr.Benzin/E + + + + + + Erdgas NG + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#FuelKBA:Erdgas NG + + + + + + Hybr.Diesel/E + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#FuelKBA:Hybr.Diesel/E + + + + + + Wasserstoff + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#FuelKBA:Wasserstoff + + + + + + Hybr.Wasserst./E + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#FuelKBA:Hybr.Wasserst./E + + + + + + Wasserstoff/Benzin + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#FuelKBA:Wasserstoff/Benzin + + + + + + Wasserst./Benzin/E + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#FuelKBA:Wasserst./Benzin/E + + + + + + BZ/Wasserstoff + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#FuelKBA:BZ/Wasserstoff + + + + + + BZ/Benzin + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#FuelKBA:BZ/Benzin + + + + + + BZ/Methanol + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#FuelKBA:BZ/Methanol + + + + + + BZ/Ethanol + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#FuelKBA:BZ/Ethanol + + + + + + Hybr.Vielstoff/E + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#FuelKBA:Hybr.Vielstoff/E + + + + + + Methan + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#FuelKBA:Methan + + + + + + Benzin/Methan + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#FuelKBA:Benzin/Methan + + + + + + Hybr.Erdgas/E + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#FuelKBA:Hybr.Erdgas/E + + + + + + Benzin/Ethanol + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#FuelKBA:Benzin/Ethanol + + + + + + Hybr.B/E ext.aufl. + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#FuelKBA:Hybr.B/E ext.aufl. + + + + + + Hybr.D/E ext.aufl. + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#FuelKBA:Hybr.D/E ext.aufl. + + + + + + Hybr.LPG/E ext.aufl. + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#FuelKBA:Hybr.LPG/E ext.aufl. + + + + + + Hybr.W/E ext.aufl. + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#FuelKBA:Hybr.W/E ext.aufl. + + + + + + Hybr.V/E ext.aufl. + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#FuelKBA:Hybr.V/E ext.aufl. + + + + + + Hybr.NG/E ext.aufl. + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#FuelKBA:Hybr.NG/E ext.aufl. + + + + + + Hybr.Wod.B/Eext.aufl + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#FuelKBA:Hybr.Wod.B/Eext.aufl + + + + + + Wasserstoff/NG + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#FuelKBA:Wasserstoff/NG + + + + + + Hybr.W/NG/E ext.aufl + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#FuelKBA:Hybr.W/NG/E ext.aufl + + + + + + Ethanol + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#FuelKBA:Ethanol + + + + + + Hybr.BZ/W/E + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#FuelKBA:Hybr.BZ/W/E + + + + + + Hybr.BZ/W/E ext. aufl. + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#FuelKBA:Hybr.BZ/W/E ext. aufl. + + + + + + Zweistoff LNG/Diesel + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#FuelKBA:Zweistoff LNG/Diesel + + + + + + Andere + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#FuelKBA:Andere + + + + + + Fluessiggas + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#FuelKBA:Fluessiggas + + + + + + Hybr.Fluessiggas/E + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#FuelKBA:Hybr.Fluessiggas/E + + + + + + Verfluessigtes Erdgas(LNG) + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#FuelKBA:Verfluessigtes Erdgas(LNG) + + + + + + + + + + + + + nhtsaFuelType + + + en + Fuel type(NHTSA) + + + urn:samm:io.catenax.vehicle.product_description:3.0.0#nhtsaFuelType + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Fuel type(NHTSA) + + + + + en + nhtsaFuelType + + + STRING + + + en + Description of the fuel according US NHTSA + + + + + + Compressed Hydrogen/Hydrogen + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#FuelNHTSA:Compressed Hydrogen/Hydrogen + + + + + + Compressed Natural Gas(CNG) + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#FuelNHTSA:Compressed Natural Gas(CNG) + + + + + + Diesel + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#FuelNHTSA:Diesel + + + + + + Electric + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#FuelNHTSA:Electric + + + + + + Ethanol(E85) + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#FuelNHTSA:Ethanol(E85) + + + + + + Flexible Fuel Vehicle(FFV) + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#FuelNHTSA:Flexible Fuel Vehicle(FFV) + + + + + + Fuel Cell + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#FuelNHTSA:Fuel Cell + + + + + + Gasoline + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#FuelNHTSA:Gasoline + + + + + + Liquefied Natural Gas(LNG) + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#FuelNHTSA:Liquefied Natural Gas(LNG) + + + + + + Liquefied Petroleum Gas(propane or LPG) + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#FuelNHTSA:Liquefied Petroleum Gas(propane or LPG) + + + + + + Methanol(M85) + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#FuelNHTSA:Methanol(M85) + + + + + + Natural Gas + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#FuelNHTSA:Natural Gas + + + + + + Neat Ethanol(E100) + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#FuelNHTSA:Neat Ethanol(E100) + + + + + + Neat Methanol(M100) + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#FuelNHTSA:Neat Methanol(M100) + + + + + + Unknown + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#FuelNHTSA:Unknown + + + + + + + + + + + + + fuel + + + en + Fuel + + + urn:samm:io.catenax.vehicle.product_description:3.0.0#fuel + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Fuel + + + + + en + fuel + + + STRING + + + en + The fuel type of the vehicle. + + + + + + + + + listOfVehicles + + + en + listOfVehicles + + + urn:samm:io.catenax.fleet.vehicles:1.0.0#listOfVehicles + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + listOfVehicles + + + + + en + listOfVehicles + + + STRING + + + en + List of Vehicle.ProductDescription + + + + + + + + + diff --git a/io.catenax.fleet.vehicles/1.0.0/gen/Vehicles-schema.json b/io.catenax.fleet.vehicles/1.0.0/gen/Vehicles-schema.json new file mode 100644 index 00000000..6d9c055c --- /dev/null +++ b/io.catenax.fleet.vehicles/1.0.0/gen/Vehicles-schema.json @@ -0,0 +1,360 @@ +{ + "$schema" : "http://json-schema.org/draft-04/schema", + "description" : "Fleet of vehicles. This model is a shell around io.catenax.vehicle.product_description 3.0.0\nIt allows to send multiple io.catenax.vehicle.product_description.", + "type" : "object", + "components" : { + "schemas" : { + "urn_samm_io.catenax.vehicle.product_description_3.0.0_UniqueID" : { + "type" : "string", + "description" : "Characteristic for a unique id: every linked property to this characteristic is a unique ID." + }, + "urn_samm_io.catenax.vehicle.product_description_3.0.0_CatenaXIdTrait" : { + "type" : "string", + "description" : "The provided regular expression ensures that the UUID is composed of five groups of characters separated by hyphens, in the form 8-4-4-4-12 for a total of 36 characters (32 hexadecimal characters and 4 hyphens), prefixed by \"urn:uuid:\" to make it an IRI.", + "pattern" : "(^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$)|(^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$)" + }, + "urn_samm_org.eclipse.esmf.samm_characteristic_2.1.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_samm_io.catenax.vehicle.product_description_3.0.0_VehicleSteeringPos" : { + "type" : "string", + "description" : "Vehicle steering position enumeration from NHTSA, see table [vPICList_lite].[dbo].[Steering]", + "enum" : [ "Left-Hand Drive", "Right-Hand Drive" ] + }, + "urn_samm_io.catenax.vehicle.product_description_3.0.0_Weight" : { + "type" : "number", + "description" : "Weight of an object." + }, + "urn_samm_io.catenax.vehicle.product_description_3.0.0_DriveTypeNHTSA" : { + "type" : "string", + "description" : "Enumeration of drive type according NHTSA, table [vPICList_lite].[dbo].[DriveType]", + "enum" : [ "All-Wheel Drive", "Front-Wheel Drive", "Rear-Wheel Drive" ] + }, + "urn_samm_io.catenax.vehicle.product_description_3.0.0_EnginePower" : { + "type" : "number", + "description" : "Engine power expressed in kilowatt." + }, + "urn_samm_io.catenax.vehicle.product_description_3.0.0_Hybridization" : { + "type" : "string", + "description" : "Enumeration of possible hybridization values", + "enum" : [ "battery electric vehicle", "hybrid electric vehicle", "no hybrid", "plugin hybrid electric vehicle", "range extender" ] + }, + "urn_samm_io.catenax.vehicle.product_description_3.0.0_OemShortNameTrait" : { + "type" : "string", + "description" : "Restricts the length of wmiCode to exactly 3 chars", + "maxLength" : 3, + "minLength" : 3 + }, + "urn_samm_io.catenax.vehicle.product_description_3.0.0_OEMCharacteristic" : { + "description" : "OEM characteristic describes an original eequipment manufacturer(OEM).", + "type" : "object", + "properties" : { + "wmiCode" : { + "description" : "Short name/code of vehicle manufacturer according to world manufacturer information(wmi). The wmiCode are the first 3 chars of the vehicle identification number.\nA list of in NHTSA registered wmiCodes can be found in attribute Wmi in table [vPICList_lite].[dbo].[Wmi] ", + "$ref" : "#/components/schemas/urn_samm_io.catenax.vehicle.product_description_3.0.0_OemShortNameTrait" + }, + "wmiDescription" : { + "description" : "Name of OEM according NHTSA or other authorities. Has to be compliant with/linked wmiCode attribute.\nFor NHTSA: name of table [vPICList_lite].[dbo].[Manufacturer]", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "cxBPN" : { + "description" : "Catena-X business partner number of this company.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + } + }, + "required" : [ "wmiCode", "wmiDescription", "cxBPN" ] + }, + "urn_samm_io.catenax.vehicle.product_description_3.0.0_PositiveNumber" : { + "type" : "number", + "minimum" : 1 + }, + "urn_samm_io.catenax.vehicle.product_description_3.0.0_KbaVariant" : { + "type" : "string", + "description" : "Current version of the Enumeration is sub-set of list defined from the German Federal Office for motor vehicles. ", + "enum" : [ "Limousine", "Kombilimousine", "Kabrio-Limousine", "Cabrio-Limousine", "Mehrzweckfahrzeug", "Pkw-Pick-up", "Van", "Pick-up", "Coupe", "Schraeghecklimousine" ] + }, + "urn_samm_io.catenax.vehicle.product_description_3.0.0_NhtsaVariant" : { + "type" : "string", + "description" : "Enumeration comming from NHTSA offline database vpic, table [vPICList_lite].[dbo].[BodyStyle]", + "enum" : [ "Cargo Van", "Convertible", "Cabriolet", "Coupe", "Crossover Utility Vehicle(CUV)", "Hatchback", "Liftback", "Notchback", "Limousine", "Low Speed Vehicle(LSV)", "Neighborhood Electric Vehicle(NEV)", "Minivan", "Pickup", "Roadster", "Sedan", "Saloon", "Sport Utility Truck(SUT)", "Sport Utility Vehicle(SUV)", "Multi-Purpose Vehicle(MPV)", "Van", "Wagon" ] + }, + "urn_samm_io.catenax.vehicle.product_description_3.0.0_BodyCharacteristic" : { + "description" : "Bundles all body-related information.", + "type" : "object", + "properties" : { + "numberOfDoors" : { + "description" : "Describes the number of doors of a vehicle.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.vehicle.product_description_3.0.0_PositiveNumber" + }, + "colorId" : { + "description" : "Colour code describes the code of a specific colour of a vehicle.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "colorDescription" : { + "description" : "Colour name describes the colour of the colour code as a written word.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "kbaBody" : { + "description" : "Vehicle variant - Body shapes according German KBA", + "$ref" : "#/components/schemas/urn_samm_io.catenax.vehicle.product_description_3.0.0_KbaVariant" + }, + "nhtsaBody" : { + "description" : "Vehicle variant - Body shapes according US NHTSA", + "$ref" : "#/components/schemas/urn_samm_io.catenax.vehicle.product_description_3.0.0_NhtsaVariant" + } + }, + "required" : [ "numberOfDoors", "colorId", "colorDescription" ] + }, + "urn_samm_io.catenax.vehicle.product_description_3.0.0_Equipment" : { + "description" : "One equipment of the vehicle.", + "type" : "object", + "properties" : { + "equipmentIdentifier" : { + "description" : "The identifier of a specific equipment.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "equipmentDescription" : { + "description" : "The equipment variants description.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "group" : { + "description" : "Bundels all equipment-oriented information into categories like Interior", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + } + }, + "required" : [ "equipmentIdentifier", "equipmentDescription", "group" ] + }, + "urn_samm_io.catenax.vehicle.product_description_3.0.0_Equipments" : { + "description" : "List of equipments installed in the vehicle.", + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/urn_samm_io.catenax.vehicle.product_description_3.0.0_Equipment" + } + }, + "urn_samm_org.eclipse.esmf.samm_characteristic_2.1.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_samm_io.catenax.vehicle.product_description_3.0.0_ProductionCharacteristic" : { + "description" : "Production Characteristic", + "type" : "object", + "properties" : { + "productionDate" : { + "description" : "Production date of the vehicle", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Timestamp" + }, + "plantIdentifier" : { + "description" : "Plant id of the final assembly of the vehicle", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "plantDescription" : { + "description" : "Long name of the production plant of the vehicle", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + } + }, + "required" : [ "productionDate", "plantIdentifier", "plantDescription" ] + }, + "urn_samm_io.catenax.vehicle.product_description_3.0.0_CountryCodeTrait" : { + "type" : "string", + "description" : "Regular Expression that ensures a three-letter code ", + "pattern" : "^[A-Z][A-Z][A-Z]$" + }, + "urn_samm_io.catenax.vehicle.product_description_3.0.0_SaleCharacteristic" : { + "description" : "Characteristic for sale-oriented information.", + "type" : "object", + "properties" : { + "soldDate" : { + "description" : "Sold date of the vehicle = warranty start date for this vehicle", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Timestamp" + }, + "countryCode" : { + "description" : "Vehicle sold country in ISO 8601 alpha 3", + "$ref" : "#/components/schemas/urn_samm_io.catenax.vehicle.product_description_3.0.0_CountryCodeTrait" + }, + "countryGroup" : { + "description" : "Region where this car was sold", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + } + }, + "required" : [ "soldDate", "countryCode", "countryGroup" ] + }, + "urn_samm_io.catenax.vehicle.product_description_3.0.0_CubicCapacity" : { + "type" : "number", + "description" : "Cubic capacity of the engine" + }, + "urn_samm_io.catenax.vehicle.product_description_3.0.0_Engine" : { + "description" : "Describing one installed engine", + "type" : "object", + "properties" : { + "engineId" : { + "description" : "OEM-specific identifier/type of the installed engine", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "engineDescription" : { + "description" : "Description of the engine", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "engineSeries" : { + "description" : "Engine series as defined by OEM", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "serialNumber" : { + "description" : "Serial number of the installed engine", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "size" : { + "description" : "Cubic capacity in a combustion engine - not available in battery-electric vehicles", + "$ref" : "#/components/schemas/urn_samm_io.catenax.vehicle.product_description_3.0.0_CubicCapacity" + }, + "power" : { + "description" : "Engine power is the power that an engine can put out", + "$ref" : "#/components/schemas/urn_samm_io.catenax.vehicle.product_description_3.0.0_EnginePower" + }, + "engineProductionDate" : { + "description" : "Date when the engine was produced", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Timestamp" + }, + "installDate" : { + "description" : "Date when the engine was installed", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Timestamp" + } + }, + "required" : [ "engineId", "engineDescription", "engineSeries", "serialNumber", "power" ] + }, + "urn_samm_io.catenax.vehicle.product_description_3.0.0_Engines" : { + "description" : "A list of all installed engines in the vehicle", + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/urn_samm_io.catenax.vehicle.product_description_3.0.0_Engine" + } + }, + "urn_samm_io.catenax.vehicle.product_description_3.0.0_FuelKBA" : { + "type" : "string", + "description" : "Enumeration of possible fuel types of a vehicle according german KBA", + "enum" : [ "Unbekannt", "Diesel", "Benzin", "Vielstoff", "Elektro", "Benzin/Fl?ssiggas", "Benzin/komp.Erdgas", "Hybr.Benzin/E", "Erdgas NG", "Hybr.Diesel/E", "Wasserstoff", "Hybr.Wasserst./E", "Wasserstoff/Benzin", "Wasserst./Benzin/E", "BZ/Wasserstoff", "BZ/Benzin", "BZ/Methanol", "BZ/Ethanol", "Hybr.Vielstoff/E", "Methan", "Benzin/Methan", "Hybr.Erdgas/E", "Benzin/Ethanol", "Hybr.B/E ext.aufl.", "Hybr.D/E ext.aufl.", "Hybr.LPG/E ext.aufl.", "Hybr.W/E ext.aufl.", "Hybr.V/E ext.aufl.", "Hybr.NG/E ext.aufl.", "Hybr.Wod.B/Eext.aufl", "Wasserstoff/NG", "Hybr.W/NG/E ext.aufl", "Ethanol", "Hybr.BZ/W/E", "Hybr.BZ/W/E ext. aufl.", "Zweistoff LNG/Diesel", "Andere", "Fluessiggas", "Hybr.Fluessiggas/E", "Verfluessigtes Erdgas(LNG)" ] + }, + "urn_samm_io.catenax.vehicle.product_description_3.0.0_FuelNHTSA" : { + "type" : "string", + "description" : "Enumeration from NHTSA vpic database, table [vPICList_lite].[dbo].[FuelType]", + "enum" : [ "Compressed Hydrogen/Hydrogen", "Compressed Natural Gas(CNG)", "Diesel", "Electric", "Ethanol(E85)", "Flexible Fuel Vehicle(FFV)", "Fuel Cell", "Gasoline", "Liquefied Natural Gas(LNG)", "Liquefied Petroleum Gas(propane or LPG)", "Methanol(M85)", "Natural Gas", "Neat Ethanol(E100)", "Neat Methanol(M100)", "Unknown" ] + }, + "urn_samm_io.catenax.vehicle.product_description_3.0.0_FuelCharacteristic" : { + "description" : "Characteristic for the fuel used in the vehicle.", + "type" : "object", + "properties" : { + "kbaFuelType" : { + "description" : "Description of the fuel according german KBA", + "$ref" : "#/components/schemas/urn_samm_io.catenax.vehicle.product_description_3.0.0_FuelKBA" + }, + "nhtsaFuelType" : { + "description" : "Description of the fuel according US NHTSA", + "$ref" : "#/components/schemas/urn_samm_io.catenax.vehicle.product_description_3.0.0_FuelNHTSA" + } + } + }, + "urn_samm_io.catenax.vehicle.product_description_3.0.0_Vehicle" : { + "description" : "Vehicle data that does not fit into one of the other entities.", + "type" : "object", + "properties" : { + "anonymizedVin" : { + "description" : "OEM-specific hashed VIN; link to car data over pseydomized/hashed VIN or Catena-X unique digital twin identifier.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.vehicle.product_description_3.0.0_UniqueID" + }, + "catenaXId" : { + "description" : "A fully anonymous Catena-X identifier that is registered in C-X Digital twin registry. Can be used for vehicles, parts, workshops, .....", + "$ref" : "#/components/schemas/urn_samm_io.catenax.vehicle.product_description_3.0.0_CatenaXIdTrait" + }, + "vehicleSeries" : { + "description" : "vehicle series, normally one level above model. E.g. vehicle series =\"Golf\", vehicle model=\"Golf VIII\"", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "modelDescription" : { + "description" : "Detail vehicle model like \"Golf VIII\"", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "modelIdentifier" : { + "description" : "OEM-specific model identifier or OEM-specific project name.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "class" : { + "description" : "Class of the vehicle.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "steeringPos" : { + "description" : "Position of vehicle steering wheel, Left or right.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.vehicle.product_description_3.0.0_VehicleSteeringPos" + }, + "emptyWeight" : { + "description" : "The empty weight of the vehicle in kg as specified.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.vehicle.product_description_3.0.0_Weight" + }, + "driveType" : { + "description" : "Drive type of a vehicle according enumeration.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.vehicle.product_description_3.0.0_DriveTypeNHTSA" + }, + "systemPower" : { + "description" : "Complete power of this vehicle in KW.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.vehicle.product_description_3.0.0_EnginePower" + }, + "hybridizationType" : { + "description" : "Degree of hybridization in this vehicle.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.vehicle.product_description_3.0.0_Hybridization" + }, + "softwareCategory" : { + "description" : "Some OEMs bring in the software as complete package for all systems:\nTo identify this software: software category and software version is needed.\nSoftware category when this car was built.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "softwareVersion" : { + "description" : "Some OEMs brings in the software as complete package for all systems:\nTo identify this software: software category and software version is needed.\nSoftware version when this car was built\n.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "oem" : { + "description" : "Original equipment manufacturer.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.vehicle.product_description_3.0.0_OEMCharacteristic" + }, + "body" : { + "description" : "Vehicle body.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.vehicle.product_description_3.0.0_BodyCharacteristic" + }, + "equipments" : { + "description" : "Equipments.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.vehicle.product_description_3.0.0_Equipments" + }, + "production" : { + "description" : "This property bundles production-related information.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.vehicle.product_description_3.0.0_ProductionCharacteristic" + }, + "sale" : { + "description" : "This property bundles all sales related information.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.vehicle.product_description_3.0.0_SaleCharacteristic" + }, + "engines" : { + "description" : "List of installed engines in the vehicle.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.vehicle.product_description_3.0.0_Engines" + }, + "fuel" : { + "description" : "The fuel type of the vehicle.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.vehicle.product_description_3.0.0_FuelCharacteristic" + } + }, + "required" : [ "anonymizedVin", "vehicleSeries", "modelDescription", "modelIdentifier", "class", "steeringPos", "emptyWeight", "driveType", "systemPower", "oem", "body", "equipments", "production", "sale", "engines", "fuel" ] + }, + "urn_samm_io.catenax.fleet.vehicles_1.0.0_ListOfVehicles" : { + "description" : "List of vehicles", + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/urn_samm_io.catenax.vehicle.product_description_3.0.0_Vehicle" + } + } + } + }, + "properties" : { + "listOfVehicles" : { + "description" : "List of Vehicle.ProductDescription", + "$ref" : "#/components/schemas/urn_samm_io.catenax.fleet.vehicles_1.0.0_ListOfVehicles" + } + }, + "required" : [ "listOfVehicles" ] +} \ No newline at end of file diff --git a/io.catenax.fleet.vehicles/1.0.0/gen/Vehicles.aasx b/io.catenax.fleet.vehicles/1.0.0/gen/Vehicles.aasx new file mode 100644 index 0000000000000000000000000000000000000000..f5158be38b84ecdb93e6c4fd7d68c514217018cc GIT binary patch literal 10659 zcmaKS1yo#3wl(e=q;YqGdvJFT?(PtrV2uXX1b252?(PuWg1bAx`I~Rvtoh#jGw<~3 zyZZL3b8gkHQ+4;bcPq(4LScfz!NGx%7{+OW{mn2yzjZ_%>|M<4T?{^d{bJ^<$LL{a z8>KvM-OG&RiebmNXEM%G>mlve71Ng{l2En?tYL|hVkkRvf0!vJ5xpd?js8f7Wux&o{ehgmb?ood8#dz znOGFM;9O-CmV{qE&$jVfK=2Z&QsQ?0pS3ACi;) zjx1gMO}0JV2}Mzxnr#ZAFroPKz0Qg&>(+V+Q^f`LD@Pi|MuxWJVJM_Aj@x$RqS%Q8mi6OB}*}GzX_Q)X^`K zc@;P-pli$^JWX4Ay;|hD6b;k6fLSZWgZhe3wGV(?Z&Y0J--z_>VenwRp!hcW%fPBv zSHZ(IPTa_YvwDv}@P~2hbhK`;R0p@S6z?9{OfK0nFJr!f>uTvu7Pw^LeJYY+QHd2b z{|MW7p7#Q`>?*r<=74sih4o%EdnkTkaIJrQf$c?#cjbs~q(y$GI``>>tiII>9RQO| zFdErcBc5DKNwf+D6@}>?=iyEai&4;sssB%$-x2!@XVBVZGWo}HeqYC@dUg&g+$}F_ z2Et>$$tcV51x3hR$N1g``8pL$_ zK8~zhR?@zfqCZj%`j0WgS#zC*4gx4E`JHyUcknAVD#WKbMZX1_B9?n{3d1gm+doD* zDM14#NYXs9q0!a#dm_krytZ%Ff5xTmE?Gg|WO#6gjw{`G!yNbu^HZ$E+zT?tFCiHv zRS+T;WZHQ28}72&@ZY}4ap1qu5nV;l6C16VesyO$Tb&SwQxD zkc&WeZ_~Jcp4ei6e9(c#wb|aj&1;+UhFF}%HL>7?Ode~;KrRt5enqEk*8hi+3g(bR zk&3NF5S60r7lQ=}4w?^rBRc3XAsxj1OOi8^dN7~zW41`c#4zuiz5wzA`9$6Cbkgu6 z;zfSL?P>SDh}mBC!T(uyUofgJ0WKV#2W~W4`bsq}IMl@S0;!b~=o8u#6rR{kiC9*s zW}dgFM&(GezVGYxS&g$XZMnYeR|WiAYV113UxeIUd zoe&s+CfhR#;aQ=4Q7DH!`Vr6C@$*MA!hP#-31-!E`BoXl7{C$mt9Q;0_w}kJ+*^L+ z?7$&MW2jO6v-86^b!DJCG9qiz9xU7ggm~w<1(VYPKqu-$o(CiH{yO_ddP4`z9DCcG z2dxO{IN_;3QUXs7ZEdEarFI1+l$JhLiUGtCkTv@0Fq**j+GX54Wd*`v`*a_1jl`j3 zHW^*G#oA>>%xc^g;p%yWd9-yFN2}o>@#fiCzgra_Kb*M*-&~xzYNV~7>ggk!I%hTY z9G_?Ey3tCOL0%=EnIJFJ`Eom3o$@uPnLmcUQK$VH2Lwt#_`R=s@A zo7ou_(ws+-oun3Hzlg5q9}vA%^rkpn*YQJ$#Q`&|XlisN)Vp+~S*FVSnK! z-H}~0s@7VKybg7wgl%(e*d%h*34CKKeliCgs2kt7WI1L;5ZTWEmdy z7{TnTGJU1oA<62?L7}X{r{p3uW(pF`MU z2Kuei8xjXpq%p)S6uB^w=z{*|*2O9m{yCzqzRLc=0A2h*GHHU=VtUuWrsc!JnxO@M zuPX4g!S&12<<%bhrB2JZ7^K*e`gbZnI0zS!HbWEX`+RiLsXB?#*T# zVTd~sQ8`ARbKz@J*Z{n|vW>Y1)eNgjY~_9{4!m35Mf&~0WK<4`E`7ab)a~1d?kaqY zS{ZvIl=YckybHYH4D2hFrqj0e$*M}bpYpwf*EFW9@>jjAG`+v3L>C|?B=G1?Zg~;p zS|MP_*2}4DR9eWy85dM#+c>Vb-CAQ=A~XzMQc@m_mi>gqv6MZV3<}pR9{J|twYFlb z(#mnk5Kx3eh<^1mcgDZ&f}gKCSunY-$f!R=@6b`>>xOblh9ae@M7yM~AG8V+Q=_o- z(+Jy(zOj-;jhlD-aB5cq0Z$v_uOQnTH%pOrwbfen*l#DuLU=-WPJhZMk!Ktn&g@%r z;PR>t#+UO@F8O};RGwdeXVvK|xOLto`~i>p^>Zf(FV48of7(!HOe0ydjK$e)Lv97% zy#B^cefp|nvRH4C({rmv+LnDYJH1&f{l;uqRIi1Z1)HX4a7kz2_p0o}_NY8|ht3kE zV|jFf3&L!rnsrf5!C`5mG12WIMssN!A6?*V$w#KT6rD}JZU!WT@(q52y)h2cgE zv}StqaK6Oo^J!2*+|tjX2=dC?WL)QTVc&2N{2fEOa~-UWc7>}g@+<3$1h1E8hYF{F z1c|or;`FruBirfuQ=41BV3>K04e?;rozY5P&GQI@yL{P#Cn}}^R=;$lJC_UhOonRd z`NWXQqb@_s4_Oqggk7{BX~`ag$WWrZQbN7>>?^XFMObW<0+fPlw*VR zy3#a{M}(SMP?SeR!FJJMRjr3T$sZSKx}&qhbwlT?`Ak`M0Yr+CZ>Dc(73{%qxIzo@ zs^(yXJo1X*3_3kzEN8#t)uK@0Siw)W7O<>k8U1$4tiNm5X*oxpu972>OAbqqJ_!i; z_Dc5m-R)E_ZWq%)ZlOem@SE$b;=@Pihf#}72;bEPYm<1<(aI;a&LabhY)|jc8hDEU zbVkH?C=h}=#nAp)CWVJJ>$Q#!q32H{OvNi$kBlk367upncVe$kc;}f<_>Y6cyXq@l zn`8Z2hNlEu`i1!Gf0Qddej79JxbkJixIA2NdN({X)ng|UTlB3oMiG8^vOjSC1;G5s z#@)`E)>cQ(XJz2cqfJns71i(4Wz)NcveXdlx|6@+O-6#!9F=wb)c^RYoLCFa5-Kf7rrjL zXh_x-i*@8IpkkE9icyqxit}7^Sga4b!9f*v$DJWXmr5FHg+lDT$3In*}&N}}i%ipbHTUbTD)xo@?dEbhysav$#fwKUH z5xf#=L@Uwtj_nEm-*f9U`0FKhS`w!wUX7EkzjEofW0v=$OQ`!PtR%|Lx4?+eX2M!dJDWk4CP64ci zf7^J#$Gv^j@kcmU+ZI^%I&oQ9hS&^L0b&4E-^e1Qm5O+#B^rOd;Vm!%_nxBVUjp8;=~9W*k@o4Ir^@ikjNwMgaF6(gD{^_SK3TBr4lJn1?2 zu*U8M+C3~V$hatjX?yXrpP+AJy$?d)Ajutso5%+lw_gd=WLc%CQUDqq%-6QtVc(hf zdzcI=?Xv!&bJ`1?qlbW&r&zh=NFEGsG5O00V4O6oEcdR2DGzC)cpo}~M;n>yr@Uu# zY3>uoWG^yxt*~~Aa;1jw0=kmj_HimKGu8xqKu71*M2M&@Ly0rhFk7~5^6?A5R%PG) z#ORxgc;Vaq?gFq44@B>q^g8T>5l{<8K-^ilTte@XYCml={3L(Kgc>*uwMEk zF)}Rbxj5`Dk5pD_(PKuCz>fS~1{sl~zPQooE=xHi(Uwf% z$QvKPPld`f_U?EJU;s|rFcXDh@)fW&`xTSOC|vJB1g?g9D>p&10sDJ4 z>i6l;W=jgyKT8@v-3|XY;|>RPl|o zM{-995*3^%x7-q+Uu<0I^X5rR&d?47Ge&(oU227$R|JH`z`TA>Qy(}9(BFq8igbeG z#v^*0C_pC&o#}@26gMDi_0(^@PZ%R$o`{KOTb(==@PJ!UeSH14#QY~NuyyN=AoR^| zkUMb@E{BOnX2Vn<&tvi}tUMT-z8YZ2G!ovhq<Mp5SU~Z*qIwrR#ryb#YQm7CROZC zXz9kfLZV|4YeOS~7zv3JQk!eXi4x3G46#VOo~;OBNO-h$pLn0VTzWvBCh!4jh6*JVGy-_#pXP#(rB zVslJh{;|YlJDG~1k<#YL>5|Bz^ycxUHWv_fuy!CXbGvn{V7lm+xO-hZu$(GH(h!CD zxMi}GUv_mQeXqEB-&2^r-7{t|JzKbgA3~`+J*PhNPlUK9w=ApjA&eY_)1{~yez^nZ z#r8a&E?NzVrbs&DrWD(=XwF-m{L3mo#SVijB3nwD8gc^ubUc<1`CQl~6;Ho)d96NNP zT`rE}sSSV2kuNoqh%9CI=q^T(Py=N%U+MB+EFP{Mr9xlAAvXR)Hg~v%AB z+cx6Z8u2*O#|Dff?Hk@`Ft%O}Zz--(l13#sfCtP4()*@>>jsm9Uoq$<3@dhY}tHHYRu*N;wfWxlUAUGFr z0a=(JGz&Fz7p%oufFb6rnSA80J+4yrsk-(`A=b*QYX3K#&=p}MAJ{y4aCN;SfgTpOs80BH8`hMWesdEm3a8i~2;fZAGY`2``O?Hz+UB2W2A|0YB@1hg2x|GbQYj7n9|1zC!cl&n+KHtwGLBclaZ4 zzZ;yu;V5%yti5*Z*K3@mTpLk;Ijt8Kb*xY93+PtyRilSk;{Hj==9H{? zdP>DqQ2RMF4lsb43KQH7#+L=oY#(PB8&Q5`##8hYqFNt~PuPL4JDU5m@JR}-UqK-3 zHcksBVr*{JFc^V^#^jeFyK$0 zo-wTB9e?9q5!=EcN=av-EERx1k)riP{0mB{dd*w%Mu?x?{+x0G$8o=yYS)g5>zm;y ze7(QIS5uTiRe4LZ+tm%s%%&e1!tv9F&fH~30rdF4;Ps>YG=dii#>$pAMqpe5G`LJR zeb-|Tw~?-av9|=Fb0jrKdGtEJ;LTV0?I+F-ZZ2)xArv@wD5Kp!k&Od;F&68 z@tI|07^3dv5Kx5d=dA5!qw7?4d2m^`(Ua2IoI(W-%mhaadv_C(j`3Pu@FXjFfq%p| zLhB5d=>cRQ++8wwPtLmET(wbsUz^_VQn5!oKdb|Edp$OE7BQg+V-38vl}zq{d1wI3 z-EXr7yZwD$yj2Bz&eBPfo2|OG*1|*O^)){CtIgZR*72L3obsVB6k*(tInCIX`j?lt z<9o+fJ=<IVc~n7(@#QK11zT zC+ddyGvLp{&--+}y0CQ5NRnvgL6t?9mA7K(wiL1v7YC&ls+eh-&1D!)GX$3ZfGhx~ zQyWy9UxjDv4$wlTiOMf%=+NW$leG;Tpcg4$WYmx8PUDgB zh13{#u-cr37`B0G{qi%V2FGEY8$6m1-*7)8t7=sV6VTDYw=&$eGEfiL{)}|nltXZ1 zrTpVDPnd|Ys0*J)&)e4Qq_J3Xe`}#(rpIR}T9B!F!4Q~d<^CLYST^Q9p}?@4blF&S zn}y38_akWodIV)eAH>E+I_MG9o*(m0f~~-UIv9WaL5zPKGT&PXVVN)lk9Gi$d^$3U z_ZfS>GQxG*faya1fo0c-@5e-94Nj*3w}E(f3C)r@)hwf*`gH?7dJle&F(MHw%>+Uv zidEzlD^}=S_#Cv0=$s>pDh5{z${66I#oj@+aoG%#HH1{#QGWmq=#IRFXoh}b+ha7F zy#PKTh5g_I2zm__#z5&^8Z(;J7wQVV{Yk~RKw<;W6n@Ntg_i?M_N&dU-~?a(r8;#S z^J-y2EZ6ng7U1|i<-&)_^vYHhk({$TH4>d~M`M+a-cu=w+(+2g4r1c{?GhhLmF^@D zU5CMDI~c>=;k!M0!#u{%ncxtdS#bRFaKTX09c`XeOk+<)XY(n2p=14@1E1eF(q|1M zF{}Y1=}txrzqB#hkVaNdj8jl&&cL6z%q?qp`}CHif)Z1N2-ObJI91~M7aAZFE++K2wbqX%1f^7)F@&bYj%s#u^@_1E98ncx9ZV+{68cZ{Qie@0> z^}zZW{pFgt%2#+%pMm)i>*w3h^4nTE{~H3eE-RPKqd^EDR4^2%H8mdrbi^!WzEgNw z@0A97GP#$oMXi-974p>>;r@rrjLd5}!I8EhckerB0hJWjU`7lcN#{AB3~0>au; zxv8Y-R)x*!@+%t{|OK-+k-3!Q{!bdUmw*z*& zh^mv(FU-_)zKdP3RM~=5hLagqFU*kDcISp9s%R2aVEJ!6`9QfoqapKR-^3A+w4esowkb1@?gwvaSyxmVsap^P`=LD2nzmb#&_Z&{L#{{F2OD+MCNZ z^toUbN_Tb5priBoW`BIQ|NgpYl(WS@?tmwC3oBE_z<#dRawPG4J+%Q;(6!|A zJ-jNuqU|Q&7t|9Ut^H)Ed|_MnjHM2+;t=No#kH+B+zu&?S*m^r?oT!e)E)SVsMZwr zN=Q$W>g90^uozjY4rU8fjPyd+NKTNBi;1;wqd1#_I#*MPOBEM$#Uwgj_Nq)Z_ zg!gTvYVaFDvI0~Hi+s|5z1-WP4#dVqAq14l)fpFGW;- z^a*o0>oCGDNo-NoI0_;&$ZryB0VgXlST>c;txTB91UD1x#_k^Z>Y`7mqE(?U2C5{p zr9qV>GpLemu3?H=Q`tht=bpt3q1&Q8K7sOIL)+(d^%IguFDA>ZolrnK@c*!Ky<`hR zU>zwqda#SbWx(8@Fyz)b-7Krb4H5Yq=m{6+- zjZ())8d&EN_kh7CZ_#IHH=J@wt9Ypd;RG!AV40+@{Eu|7Y$bG{`?CU?G>Yx^E~a5O zekN=2KQ4&yfmNx5mQJltb$$sRA~;ZeLm4|+0vqEdT7eY{wu(-86HmQqqgG9sgh152}Dq5Z6ok9gD<+OjU<@i-3#h1i=t3+-bG!dShp-aO*pp*B`%$AP@N*ErH=bHYu$ z1`4<}l&DCPjWIO|lARTK*k!tW)xsV{!c3d7w3W5bk}02EF)^RcFF z88V1wQ4hgX3D<@ajFhdlKW+#qHg75Vi;c$>v%Yh+Uo@J0*H>3rK-dhMcp29(@6alo z+g?Q}*aqxeJdlE&?6$h23RS`kyMm3>Qm$sF9z2CE8s?>%s+)n>T?WYqVjy$cr|QUj zVIsAG&+{wrczQFP^QIDPkUAdn5qOmI;54I&E|J#meeNmp^Rn=euwQ}+1Ck>u&;8s7 zH&=~fN6lRWf~LOKGdUO@EYi#!fz#8UL*=Nz6CTVGWE^#YRuxPN+?_HX{Pk#=Mr>~C z&SxJNGel5|P)I{IDqa6Bg|D&|p&q(j`s%U>gU!t@Ra_c7VvS6utSqfLRAw+ludWE~ z&SvytFXfCee^ThLd5yJ3F|HJGAE3avplmVGHJ16r#ws@ z*jXy`+6jIYyxCVdCIJ-4A0Z?bMbT`7q+Uv>haJ z;-E@#2lgKxP%#T?qzp*|-4nQoj4m6>JC>6L4378#yFngH0UrdSPzd`qwtv7~9^)AY zdt)HSMoweol7wnQ2~!yw1IPr(Y??_O(rhEk zbxe?cXy`8u5jX@UNMZF)G2q_?Z|`Ej|84(48mJ`uzXSYT2==av`Yuzv48jeyDsWo5%w>u`=|GR)`$IjpugwayNv2zHVFBjMOFVE;qUOi e=jFewiRwROsgf)-%zG0U&?f){5hBg|+5ZE(0NlX< literal 0 HcmV?d00001 diff --git a/io.catenax.fleet.vehicles/1.0.0/gen/Vehicles.html b/io.catenax.fleet.vehicles/1.0.0/gen/Vehicles.html new file mode 100644 index 00000000..b3bf33d8 --- /dev/null +++ b/io.catenax.fleet.vehicles/1.0.0/gen/Vehicles.html @@ -0,0 +1,3535 @@ + + + + + + + + + + + + + + Documentation Vehicles + + +
+
+
+
+

Aspect Model Vehicles

+
urn:samm:io.catenax.fleet.vehicles:1.0.0#Vehicles
+
+
+
+
+
+
+
+ +
+ + +
+ Fleet of vehicles. This model is a shell around io.catenax.vehicle.product_description 3.0.0 +It allows to send multiple io.catenax.vehicle.product_description. +
+ + +
+

Overview

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

Properties

+
+ +
+ +
+

listOfVehicles

+
+ +List of Vehicle.ProductDescription + +
+
Name
+
listOfVehicles
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.vehicle.product_description:3.0.0#Vehicle + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
listOfVehicles
+
+ + +
+
+ + + +
+
+

Entities

+
+ +
+
+

Body

+
+
+ All vhicel body-related data. +
+ +
+

Properties

+
+
+ +
+
Number of doors
+
+ +Describes the number of doors of a vehicle. + +
+
Name
+
numberOfDoors
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#positiveInteger + +
+
+
+
+
+ +
+
Example
+
5
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
numberOfDoors
+
+ + +
+
+ +
+
Color identifier
+
+ +Colour code describes the code of a specific colour of a vehicle. + +
+
Name
+
colorId
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
LY7W
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
colorId
+
+ + +
+
+ +
+
Color description
+
+ +Colour name describes the colour of the colour code as a written word. + +
+
Name
+
colorDescription
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Light grey
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
colorDescription
+
+ + +
+
+ +
+
Body variant(KBA)
+
+ +Vehicle variant - Body shapes according German KBA + +
+
Name
+
kbaBody
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • Limousine
    • +
  • Kombilimousine
    • +
  • Kabrio-Limousine
    • +
  • Cabrio-Limousine
    • +
  • Mehrzweckfahrzeug
    • +
  • Pkw-Pick-up
    • +
  • Van
    • +
  • Pick-up
    • +
  • Coupe
    • +
  • Schraeghecklimousine
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
SUV
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
kbaBody
+
+ + +
+
+ +
+
Body variant(NHTSA)
+
+ +Vehicle variant - Body shapes according US NHTSA + +
+
Name
+
nhtsaBody
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • Cargo Van
    • +
  • Convertible
    • +
  • Cabriolet
    • +
  • Coupe
    • +
  • Crossover Utility Vehicle(CUV)
    • +
  • Hatchback
    • +
  • Liftback
    • +
  • Notchback
    • +
  • Limousine
    • +
  • Low Speed Vehicle(LSV)
    • +
  • Neighborhood Electric Vehicle(NEV)
    • +
  • Minivan
    • +
  • Pickup
    • +
  • Roadster
    • +
  • Sedan
    • +
  • Saloon
    • +
  • Sport Utility Truck(SUT)
    • +
  • Sport Utility Vehicle(SUV)
    • +
  • Multi-Purpose Vehicle(MPV)
    • +
  • Van
    • +
  • Wagon
    • +
+
+
+
+
+ Reference +
+
    +
  • https://vpic.nhtsa.dot.gov/api/
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Sedan
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
nhtsaBody
+
+ + +
+
+
+
+

Engine Entity

+
+
+ Describing one installed engine +
+ +
+

Properties

+
+
+ +
+
Engine ID:
+
+ +OEM-specific identifier/type of the installed engine + +
+
Name
+
engineId
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
CKBY
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
engineId
+
+ + +
+
+ +
+
Engine Description
+
+ +Description of the engine + +
+
Name
+
engineDescription
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
2.0 TDI
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
engineDescription
+
+ + +
+
+ +
+
Vehicle engine series
+
+ +Engine series as defined by OEM + +
+
Name
+
engineSeries
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
EA189
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
engineSeries
+
+ + +
+
+ +
+
Engine serial number
+
+ +Serial number of the installed engine + +
+
Name
+
serialNumber
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
3434937GJJG3738
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
serialNumber
+
+ + +
+
+ +
+
Engine size
+
+ +Cubic capacity in a combustion engine - not available in battery-electric vehicles + +
+
Name
+
size
+
+ + + +
+
Characteristic
+
+
+
+
Measurement
+
+
+
Cubic capacity of the engine
+
+
+
Unit
+
+
+
+
    +
  • + cubic centimetre +
    • +
  • + Symbol cm³ +
    • +
  • + Code CMQ +
    • +
  • + Conversion factor 10⁻⁶ m³ +
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#integer + +
+
+
+
+
+ +
+
Example
+
1968
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
size
+
+ + +
+
+ +
+
Engine power
+
+ +Engine power is the power that an engine can put out + +
+
Name
+
power
+
+ + + +
+
Characteristic
+
+
+
+
Measurement
+
+
+
Engine power expressed in kilowatt.
+
+
+
Unit
+
+
+
+
    +
  • + kilowatt +
    • +
  • + Symbol kW +
    • +
  • + Code KWT +
    • +
  • + Conversion factor 10³ W +
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#integer + +
+
+
+
+
+ +
+
Example
+
110
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
power
+
+ + +
+
+ +
+
Engine production date
+
+ +Date when the engine was produced + +
+
Name
+
engineProductionDate
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#dateTime + +
+
+
+
+
+ +
+
Example
+
2017-10-20T00:00:00
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
engineProductionDate
+
+ + +
+
+ +
+
Engine install date
+
+ +Date when the engine was installed + +
+
Name
+
installDate
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#dateTime + +
+
+
+
+
+ +
+
Example
+
2018-01-10T00:00:00
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
installDate
+
+ + +
+
+
+
+

Equipment

+
+
+ One equipment of the vehicle. +
+ +
+

Properties

+
+
+ +
+
Equipment Id
+
+ +The identifier of a specific equipment. + +
+
Name
+
equipmentIdentifier
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
S248A
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
equipmentIdentifier
+
+ + +
+
+ +
+
Equipment description
+
+ +The equipment variants description. + +
+
Name
+
equipmentDescription
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Seat heating front
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
equipmentDescription
+
+ + +
+
+ +
+
Equipment group
+
+ +Bundels all equipment-oriented information into categories like Interior + +
+
Name
+
group
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Interior
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
group
+
+ + +
+
+
+
+

Fuel

+
+
+ Bundels all fuel-related data. +
+ +
+

Properties

+
+
+ +
+
Fuel type(KBA)
+
+ +Description of the fuel according german KBA + +
+
Name
+
kbaFuelType
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • Unbekannt
    • +
  • Diesel
    • +
  • Benzin
    • +
  • Vielstoff
    • +
  • Elektro
    • +
  • Benzin/Fl?ssiggas
    • +
  • Benzin/komp.Erdgas
    • +
  • Hybr.Benzin/E
    • +
  • Erdgas NG
    • +
  • Hybr.Diesel/E
    • +
  • Wasserstoff
    • +
  • Hybr.Wasserst./E
    • +
  • Wasserstoff/Benzin
    • +
  • Wasserst./Benzin/E
    • +
  • BZ/Wasserstoff
    • +
  • BZ/Benzin
    • +
  • BZ/Methanol
    • +
  • BZ/Ethanol
    • +
  • Hybr.Vielstoff/E
    • +
  • Methan
    • +
  • Benzin/Methan
    • +
  • Hybr.Erdgas/E
    • +
  • Benzin/Ethanol
    • +
  • Hybr.B/E ext.aufl.
    • +
  • Hybr.D/E ext.aufl.
    • +
  • Hybr.LPG/E ext.aufl.
    • +
  • Hybr.W/E ext.aufl.
    • +
  • Hybr.V/E ext.aufl.
    • +
  • Hybr.NG/E ext.aufl.
    • +
  • Hybr.Wod.B/Eext.aufl
    • +
  • Wasserstoff/NG
    • +
  • Hybr.W/NG/E ext.aufl
    • +
  • Ethanol
    • +
  • Hybr.BZ/W/E
    • +
  • Hybr.BZ/W/E ext. aufl.
    • +
  • Zweistoff LNG/Diesel
    • +
  • Andere
    • +
  • Fluessiggas
    • +
  • Hybr.Fluessiggas/E
    • +
  • Verfluessigtes Erdgas(LNG)
    • +
+
+
+
+
+ Reference +
+
    +
  • https://www.kba.de/SharedDocs/Downloads/DE/SV/sv221_m1_schad_pdf.pdf
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Diesel
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
kbaFuelType
+
+ + +
+
+ +
+
Fuel type(NHTSA)
+
+ +Description of the fuel according US NHTSA + +
+
Name
+
nhtsaFuelType
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • Compressed Hydrogen/Hydrogen
    • +
  • Compressed Natural Gas(CNG)
    • +
  • Diesel
    • +
  • Electric
    • +
  • Ethanol(E85)
    • +
  • Flexible Fuel Vehicle(FFV)
    • +
  • Fuel Cell
    • +
  • Gasoline
    • +
  • Liquefied Natural Gas(LNG)
    • +
  • Liquefied Petroleum Gas(propane or LPG)
    • +
  • Methanol(M85)
    • +
  • Natural Gas
    • +
  • Neat Ethanol(E100)
    • +
  • Neat Methanol(M100)
    • +
  • Unknown
    • +
+
+
+
+
+ Reference +
+
    +
  • https://vpic.nhtsa.dot.gov/api/
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Diesel
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
nhtsaFuelType
+
+ + +
+
+
+
+

OEM

+
+
+ Describes one original eequipment manufacturer (OEM) to which this vehicle belongs to. +
+ +
+

Properties

+
+
+ +
+
WMI Code
+
+ +Short name/code of vehicle manufacturer according to world manufacturer information(wmi). The wmiCode are the first 3 chars of the vehicle identification number. +A list of in NHTSA registered wmiCodes can be found in attribute Wmi in table [vPICList_lite].[dbo].[Wmi] + +
+
Name
+
wmiCode
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
WBA
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
wmiCode
+
+ +
+
Reference
+
+
    +
  • https://vpic.nhtsa.dot.gov/
    • +
+
+
+ +
+
Constraints
+
+
    +
  • +
    + +
    + WorldManufacturerInformationCodeLength +
    + +
    +
    Description
    +
    Restricts the length of wmiCode to exactly 3 chars
    +
    + +
    +
    Reference
    +
    +
    +
      +
    • https://vpic.nhtsa.dot.gov/
      • +
    +
    +
    +
    + +
    +
    Min. Length
    +
    3
    +
    +
    +
    Max. length
    +
    3
    +
    + +
    • +
+
+
+
+
+ +
+
OEM name
+
+ +Name of OEM according NHTSA or other authorities. Has to be compliant with/linked wmiCode attribute. +For NHTSA: name of table [vPICList_lite].[dbo].[Manufacturer] + +
+
Name
+
wmiDescription
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
BMW AG
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
wmiDescription
+
+ +
+
Reference
+
+
    +
  • https://vpic.nhtsa.dot.gov/
    • +
+
+
+ +
+
+ +
+
CX Business partner number
+
+ +Catena-X business partner number of this company. + +
+
Name
+
cxBPN
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
BPN-811
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
cxBPN
+
+ + +
+
+
+
+

Production

+
+
+ Entity to bundle all production-related data. +
+ +
+

Properties

+
+
+ +
+
Vehicle production Date
+
+ +Production date of the vehicle + +
+
Name
+
productionDate
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#dateTime + +
+
+
+
+
+ +
+
Example
+
2018-01-15T00:00:00
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
productionDate
+
+ + +
+
+ +
+
Production plant id
+
+ +Plant id of the final assembly of the vehicle + +
+
Name
+
plantIdentifier
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
4711
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
plantIdentifier
+
+ + +
+
+ +
+
Vehicle production plant name
+
+ +Long name of the production plant of the vehicle + +
+
Name
+
plantDescription
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Wolfsburg
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
plantDescription
+
+ + +
+
+
+
+

Sale

+
+
+ Bundels all sale-related data +
+ +
+

Properties

+
+
+ +
+
Vehicle sold date:
+
+ +Sold date of the vehicle = warranty start date for this vehicle + +
+
Name
+
soldDate
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#dateTime + +
+
+
+
+
+ +
+
Example
+
2018-02-03T00:00:00
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
soldDate
+
+ + +
+
+ +
+
Vehicle sold country
+
+ +Vehicle sold country in ISO 8601 alpha 3 + +
+
Name
+
countryCode
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
DEU
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
countryCode
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + Country Code Regular Expression +
    + +
    +
    Description
    +
    Regular Expression that ensures a three-letter code
    +
    + +
    +
    Reference
    +
    +
    +
      +
    • https://www.iso.org/iso-3166-country-codes.html
      • +
    +
    +
    +
    + +
    +
    Regular expression
    +
    ^[A-Z][A-Z][A-Z]$
    +
    + +
    • +
+
+
+
+
+ +
+
Vehicle sold region
+
+ +Region where this car was sold + +
+
Name
+
countryGroup
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Europe
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
countryGroup
+
+ + +
+
+
+
+

Vehicle

+
+
+ Vehicle data that does not fit into one of the other entities. +
+ +
+

Properties

+
+
+ +
+
Anonymized VIN
+
+ +OEM-specific hashed VIN; link to car data over pseydomized/hashed VIN or Catena-X unique digital twin identifier. + +
+
Name
+
anonymizedVin
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
3747429FGH382923974682
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
anonymizedVin
+
+ + +
+
+ +
+
Vehicle Catena-X Identifier
+
+ +A fully anonymous Catena-X identifier that is registered in C-X Digital twin registry. Can be used for vehicles, parts, workshops, ..... + +
+
Name
+
catenaXId
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
580d3adf-1981-44a0-a214-13d6ceed9379
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
catenaXId
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + Catena-X Id Regular Expression +
    + +
    +
    Description
    +
    The provided regular expression ensures that the UUID is composed of five groups of characters separated by hyphens, in the form 8-4-4-4-12 for a total of 36 characters (32 hexadecimal characters and 4 hyphens), prefixed by "urn:uuid:" to make it an IRI.
    +
    + +
    +
    Reference
    +
    +
    +
      +
    • https://datatracker.ietf.org/doc/html/rfc4122
      • +
    +
    +
    +
    + +
    +
    Regular expression
    +
    (^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$)|(^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$)
    +
    + +
    • +
+
+
+
+
+ +
+
Vehicle series
+
+ +vehicle series, normally one level above model. E.g. vehicle series ="Golf", vehicle model="Golf VIII" + +
+
Name
+
vehicleSeries
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Golf
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
vehicleSeries
+
+ + +
+
+ +
+
Vehicle model
+
+ +Detail vehicle model like "Golf VIII" + +
+
Name
+
modelDescription
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Golf VIII
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
modelDescription
+
+ + +
+
+ +
+
Model identifier
+
+ +OEM-specific model identifier or OEM-specific project name. + +
+
Name
+
modelIdentifier
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
689-G8
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
modelIdentifier
+
+ + +
+
+ +
+
Vehicle class
+
+ +Class of the vehicle. + +
+
Name
+
class
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
A
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
class
+
+ + +
+
+ +
+
Vehicle steering pos
+
+ +Position of vehicle steering wheel, Left or right. + +
+
Name
+
steeringPos
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • Left-Hand Drive
    • +
  • Right-Hand Drive
    • +
+
+
+
+
+ Reference +
+
    +
  • https://vpic.nhtsa.dot.gov/api/
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Left-Hand Drive
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
steeringPos
+
+ + +
+
+ +
+
Vehicle empty weight
+
+ +The empty weight of the vehicle in kg as specified. + +
+
Name
+
emptyWeight
+
+ + + +
+
Characteristic
+
+
+
+
Measurement
+
+
+
Weight of an object.
+
+
+
Unit
+
+
+
+
    +
  • + kilogram +
    • +
  • + Symbol kg +
    • +
  • + Code KGM +
    • +
  • + Conversion factor kg +
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#double + +
+
+
+
+
+ +
+
Example
+
2000.0
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
emptyWeight
+
+ + +
+
+ +
+
Drive type
+
+ +Drive type of a vehicle according enumeration. + +
+
Name
+
driveType
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • All-Wheel Drive
    • +
  • Front-Wheel Drive
    • +
  • Rear-Wheel Drive
    • +
+
+
+
+
+ Reference +
+
    +
  • https://vpic.nhtsa.dot.gov/api/
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Front-Wheel Drive
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
driveType
+
+ + +
+
+ +
+
Complete system power
+
+ +Complete power of this vehicle in KW. + +
+
Name
+
systemPower
+
+ + + +
+
Characteristic
+
+
+
+
Measurement
+
+
+
Engine power expressed in kilowatt.
+
+
+
Unit
+
+
+
+
    +
  • + kilowatt +
    • +
  • + Symbol kW +
    • +
  • + Code KWT +
    • +
  • + Conversion factor 10³ W +
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#integer + +
+
+
+
+
+ +
+
Example
+
110
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
systemPower
+
+ + +
+
+ +
+
Hybridization
+
+ +Degree of hybridization in this vehicle. + +
+
Name
+
hybridizationType
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • battery electric vehicle
    • +
  • hybrid electric vehicle
    • +
  • no hybrid
    • +
  • plugin hybrid electric vehicle
    • +
  • range extender
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
no hybrid
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
hybridizationType
+
+ + +
+
+ +
+
Software category
+
+ +Some OEMs bring in the software as complete package for all systems: +To identify this software: software category and software version is needed. +Software category when this car was built. + +
+
Name
+
softwareCategory
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
TZGH64738
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
softwareCategory
+
+ + +
+
+ +
+
Software version
+
+ +Some OEMs brings in the software as complete package for all systems: +To identify this software: software category and software version is needed. +Software version when this car was built +. + +
+
Name
+
softwareVersion
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
3.4.9837.567
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
softwareVersion
+
+ + +
+
+ +
+
OEM
+
+ +Original equipment manufacturer. + +
+
Name
+
oem
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.vehicle.product_description:3.0.0#OriginalEquipmentManufacturer + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
oem
+
+ + +
+
+ +
+
Vehicle body
+
+ +Vehicle body. + +
+
Name
+
body
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.vehicle.product_description:3.0.0#Body + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
body
+
+ + +
+
+ +
+
Equipments
+
+ +Equipments. + +
+
Name
+
equipments
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.vehicle.product_description:3.0.0#Equipment + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
equipments
+
+ + +
+
+ +
+
Production
+
+ +This property bundles production-related information. + +
+
Name
+
production
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.vehicle.product_description:3.0.0#Production + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
production
+
+ + +
+
+ +
+
Sale
+
+ +This property bundles all sales related information. + +
+
Name
+
sale
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.vehicle.product_description:3.0.0#Sale + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
sale
+
+ + +
+
+ +
+
Engines
+
+ +List of installed engines in the vehicle. + +
+
Name
+
engines
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.vehicle.product_description:3.0.0#Engine + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
engines
+
+ + +
+
+ +
+
Fuel
+
+ +The fuel type of the vehicle. + +
+
Name
+
fuel
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.vehicle.product_description:3.0.0#Fuel + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
fuel
+
+ + +
+
+
+ +
+ Third party licenses + +
+ +
+ + +
+ + + \ No newline at end of file diff --git a/io.catenax.fleet.vehicles/1.0.0/gen/Vehicles.json b/io.catenax.fleet.vehicles/1.0.0/gen/Vehicles.json new file mode 100644 index 00000000..84447f35 --- /dev/null +++ b/io.catenax.fleet.vehicles/1.0.0/gen/Vehicles.json @@ -0,0 +1,58 @@ +{ + "listOfVehicles" : [ { + "catenaXId" : "580d3adf-1981-44a0-a214-13d6ceed9379", + "modelIdentifier" : "689-G8", + "emptyWeight" : 2000.0, + "production" : { + "plantIdentifier" : "4711", + "productionDate" : "2018-01-15T00:00:00", + "plantDescription" : "Wolfsburg" + }, + "driveType" : "All-Wheel Drive", + "fuel" : { + "kbaFuelType" : "Unbekannt", + "nhtsaFuelType" : "Compressed Hydrogen/Hydrogen" + }, + "steeringPos" : "Left-Hand Drive", + "hybridizationType" : "battery electric vehicle", + "body" : { + "numberOfDoors" : 5, + "kbaBody" : "Limousine", + "nhtsaBody" : "Cargo Van", + "colorId" : "LY7W ", + "colorDescription" : "Light grey" + }, + "anonymizedVin" : "3747429FGH382923974682", + "modelDescription" : "Golf VIII", + "equipments" : [ { + "equipmentIdentifier" : "S248A", + "equipmentDescription" : "Seat heating front", + "group" : "Interior" + } ], + "sale" : { + "soldDate" : "2018-02-03T00:00:00", + "countryCode" : "DEU", + "countryGroup" : "Europe" + }, + "vehicleSeries" : "Golf", + "softwareCategory" : "TZGH64738", + "oem" : { + "wmiCode" : "WBA", + "cxBPN" : "BPN-811", + "wmiDescription" : "BMW AG" + }, + "engines" : [ { + "serialNumber" : "3434937GJJG3738", + "size" : 1968, + "installDate" : "2018-01-10T00:00:00", + "engineDescription" : "2.0 TDI", + "power" : 110, + "engineId" : "CKBY", + "engineSeries" : "EA189", + "engineProductionDate" : "2017-10-20T00:00:00" + } ], + "systemPower" : 110, + "class" : "A", + "softwareVersion" : "3.4.9837.567" + } ] +} \ No newline at end of file diff --git a/io.catenax.fleet.vehicles/1.0.0/gen/Vehicles.yml b/io.catenax.fleet.vehicles/1.0.0/gen/Vehicles.yml new file mode 100644 index 00000000..2b2cb77a --- /dev/null +++ b/io.catenax.fleet.vehicles/1.0.0/gen/Vehicles.yml @@ -0,0 +1,553 @@ +--- +openapi: 3.0.3 +info: + title: Vehicles + version: v1 +servers: +- url: catenax.io/api/v1 + variables: + api-version: + default: v1 +paths: + /{tenant-id}/vehicles: + get: + tags: + - Vehicles + operationId: getVehicles + 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/Vehicles' + "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/Vehicles' + totalItems: + type: number + totalPages: + type: number + pageSize: + type: number + currentPage: + type: number + urn_samm_io.catenax.vehicle.product_description_3.0.0_UniqueID: + type: string + description: "Characteristic for a unique id: every linked property to this\ + \ characteristic is a unique ID." + urn_samm_io.catenax.vehicle.product_description_3.0.0_CatenaXIdTrait: + type: string + description: "The provided regular expression ensures that the UUID is composed\ + \ of five groups of characters separated by hyphens, in the form 8-4-4-4-12\ + \ for a total of 36 characters (32 hexadecimal characters and 4 hyphens),\ + \ prefixed by \"urn:uuid:\" to make it an IRI." + pattern: "(^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$)|(^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$)" + urn_samm_org.eclipse.esmf.samm_characteristic_2.1.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_samm_io.catenax.vehicle.product_description_3.0.0_VehicleSteeringPos: + type: string + description: "Vehicle steering position enumeration from NHTSA, see table [vPICList_lite].[dbo].[Steering]" + enum: + - Left-Hand Drive + - Right-Hand Drive + urn_samm_io.catenax.vehicle.product_description_3.0.0_Weight: + type: number + description: Weight of an object. + urn_samm_io.catenax.vehicle.product_description_3.0.0_DriveTypeNHTSA: + type: string + description: "Enumeration of drive type according NHTSA, table [vPICList_lite].[dbo].[DriveType]" + enum: + - All-Wheel Drive + - Front-Wheel Drive + - Rear-Wheel Drive + urn_samm_io.catenax.vehicle.product_description_3.0.0_EnginePower: + type: number + description: Engine power expressed in kilowatt. + urn_samm_io.catenax.vehicle.product_description_3.0.0_Hybridization: + type: string + description: Enumeration of possible hybridization values + enum: + - battery electric vehicle + - hybrid electric vehicle + - no hybrid + - plugin hybrid electric vehicle + - range extender + urn_samm_io.catenax.vehicle.product_description_3.0.0_OemShortNameTrait: + type: string + description: Restricts the length of wmiCode to exactly 3 chars + maxLength: 3 + minLength: 3 + urn_samm_io.catenax.vehicle.product_description_3.0.0_OEMCharacteristic: + description: OEM characteristic describes an original eequipment manufacturer(OEM). + type: object + properties: + wmiCode: + description: "Short name/code of vehicle manufacturer according to world\ + \ manufacturer information(wmi). The wmiCode are the first 3 chars of\ + \ the vehicle identification number.\nA list of in NHTSA registered wmiCodes\ + \ can be found in attribute Wmi in table [vPICList_lite].[dbo].[Wmi] " + $ref: '#/components/schemas/urn_samm_io.catenax.vehicle.product_description_3.0.0_OemShortNameTrait' + wmiDescription: + description: |- + Name of OEM according NHTSA or other authorities. Has to be compliant with/linked wmiCode attribute. + For NHTSA: name of table [vPICList_lite].[dbo].[Manufacturer] + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + cxBPN: + description: Catena-X business partner number of this company. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + required: + - wmiCode + - wmiDescription + - cxBPN + urn_samm_io.catenax.vehicle.product_description_3.0.0_PositiveNumber: + type: number + minimum: 1 + urn_samm_io.catenax.vehicle.product_description_3.0.0_KbaVariant: + type: string + description: 'Current version of the Enumeration is sub-set of list defined + from the German Federal Office for motor vehicles. ' + enum: + - Limousine + - Kombilimousine + - Kabrio-Limousine + - Cabrio-Limousine + - Mehrzweckfahrzeug + - Pkw-Pick-up + - Van + - Pick-up + - Coupe + - Schraeghecklimousine + urn_samm_io.catenax.vehicle.product_description_3.0.0_NhtsaVariant: + type: string + description: "Enumeration comming from NHTSA offline database vpic, table [vPICList_lite].[dbo].[BodyStyle]" + enum: + - Cargo Van + - Convertible + - Cabriolet + - Coupe + - Crossover Utility Vehicle(CUV) + - Hatchback + - Liftback + - Notchback + - Limousine + - Low Speed Vehicle(LSV) + - Neighborhood Electric Vehicle(NEV) + - Minivan + - Pickup + - Roadster + - Sedan + - Saloon + - Sport Utility Truck(SUT) + - Sport Utility Vehicle(SUV) + - Multi-Purpose Vehicle(MPV) + - Van + - Wagon + urn_samm_io.catenax.vehicle.product_description_3.0.0_BodyCharacteristic: + description: Bundles all body-related information. + type: object + properties: + numberOfDoors: + description: Describes the number of doors of a vehicle. + $ref: '#/components/schemas/urn_samm_io.catenax.vehicle.product_description_3.0.0_PositiveNumber' + colorId: + description: Colour code describes the code of a specific colour of a vehicle. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + colorDescription: + description: Colour name describes the colour of the colour code as a written + word. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + kbaBody: + description: Vehicle variant - Body shapes according German KBA + $ref: '#/components/schemas/urn_samm_io.catenax.vehicle.product_description_3.0.0_KbaVariant' + nhtsaBody: + description: Vehicle variant - Body shapes according US NHTSA + $ref: '#/components/schemas/urn_samm_io.catenax.vehicle.product_description_3.0.0_NhtsaVariant' + required: + - numberOfDoors + - colorId + - colorDescription + urn_samm_io.catenax.vehicle.product_description_3.0.0_Equipment: + description: One equipment of the vehicle. + type: object + properties: + equipmentIdentifier: + description: The identifier of a specific equipment. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + equipmentDescription: + description: The equipment variants description. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + group: + description: Bundels all equipment-oriented information into categories + like Interior + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + required: + - equipmentIdentifier + - equipmentDescription + - group + urn_samm_io.catenax.vehicle.product_description_3.0.0_Equipments: + description: List of equipments installed in the vehicle. + type: array + items: + $ref: '#/components/schemas/urn_samm_io.catenax.vehicle.product_description_3.0.0_Equipment' + urn_samm_org.eclipse.esmf.samm_characteristic_2.1.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_samm_io.catenax.vehicle.product_description_3.0.0_ProductionCharacteristic: + description: Production Characteristic + type: object + properties: + productionDate: + description: Production date of the vehicle + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Timestamp' + plantIdentifier: + description: Plant id of the final assembly of the vehicle + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + plantDescription: + description: Long name of the production plant of the vehicle + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + required: + - productionDate + - plantIdentifier + - plantDescription + urn_samm_io.catenax.vehicle.product_description_3.0.0_CountryCodeTrait: + type: string + description: 'Regular Expression that ensures a three-letter code ' + pattern: "^[A-Z][A-Z][A-Z]$" + urn_samm_io.catenax.vehicle.product_description_3.0.0_SaleCharacteristic: + description: Characteristic for sale-oriented information. + type: object + properties: + soldDate: + description: Sold date of the vehicle = warranty start date for this vehicle + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Timestamp' + countryCode: + description: Vehicle sold country in ISO 8601 alpha 3 + $ref: '#/components/schemas/urn_samm_io.catenax.vehicle.product_description_3.0.0_CountryCodeTrait' + countryGroup: + description: Region where this car was sold + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + required: + - soldDate + - countryCode + - countryGroup + urn_samm_io.catenax.vehicle.product_description_3.0.0_CubicCapacity: + type: number + description: Cubic capacity of the engine + urn_samm_io.catenax.vehicle.product_description_3.0.0_Engine: + description: Describing one installed engine + type: object + properties: + engineId: + description: OEM-specific identifier/type of the installed engine + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + engineDescription: + description: Description of the engine + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + engineSeries: + description: Engine series as defined by OEM + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + serialNumber: + description: Serial number of the installed engine + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + size: + description: Cubic capacity in a combustion engine - not available in battery-electric + vehicles + $ref: '#/components/schemas/urn_samm_io.catenax.vehicle.product_description_3.0.0_CubicCapacity' + power: + description: Engine power is the power that an engine can put out + $ref: '#/components/schemas/urn_samm_io.catenax.vehicle.product_description_3.0.0_EnginePower' + engineProductionDate: + description: Date when the engine was produced + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Timestamp' + installDate: + description: Date when the engine was installed + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Timestamp' + required: + - engineId + - engineDescription + - engineSeries + - serialNumber + - power + urn_samm_io.catenax.vehicle.product_description_3.0.0_Engines: + description: A list of all installed engines in the vehicle + type: array + items: + $ref: '#/components/schemas/urn_samm_io.catenax.vehicle.product_description_3.0.0_Engine' + urn_samm_io.catenax.vehicle.product_description_3.0.0_FuelKBA: + type: string + description: Enumeration of possible fuel types of a vehicle according german + KBA + enum: + - Unbekannt + - Diesel + - Benzin + - Vielstoff + - Elektro + - Benzin/Fl?ssiggas + - Benzin/komp.Erdgas + - Hybr.Benzin/E + - Erdgas NG + - Hybr.Diesel/E + - Wasserstoff + - Hybr.Wasserst./E + - Wasserstoff/Benzin + - Wasserst./Benzin/E + - BZ/Wasserstoff + - BZ/Benzin + - BZ/Methanol + - BZ/Ethanol + - Hybr.Vielstoff/E + - Methan + - Benzin/Methan + - Hybr.Erdgas/E + - Benzin/Ethanol + - Hybr.B/E ext.aufl. + - Hybr.D/E ext.aufl. + - Hybr.LPG/E ext.aufl. + - Hybr.W/E ext.aufl. + - Hybr.V/E ext.aufl. + - Hybr.NG/E ext.aufl. + - Hybr.Wod.B/Eext.aufl + - Wasserstoff/NG + - Hybr.W/NG/E ext.aufl + - Ethanol + - Hybr.BZ/W/E + - Hybr.BZ/W/E ext. aufl. + - Zweistoff LNG/Diesel + - Andere + - Fluessiggas + - Hybr.Fluessiggas/E + - Verfluessigtes Erdgas(LNG) + urn_samm_io.catenax.vehicle.product_description_3.0.0_FuelNHTSA: + type: string + description: "Enumeration from NHTSA vpic database, table [vPICList_lite].[dbo].[FuelType]" + enum: + - Compressed Hydrogen/Hydrogen + - Compressed Natural Gas(CNG) + - Diesel + - Electric + - Ethanol(E85) + - Flexible Fuel Vehicle(FFV) + - Fuel Cell + - Gasoline + - Liquefied Natural Gas(LNG) + - Liquefied Petroleum Gas(propane or LPG) + - Methanol(M85) + - Natural Gas + - Neat Ethanol(E100) + - Neat Methanol(M100) + - Unknown + urn_samm_io.catenax.vehicle.product_description_3.0.0_FuelCharacteristic: + description: Characteristic for the fuel used in the vehicle. + type: object + properties: + kbaFuelType: + description: Description of the fuel according german KBA + $ref: '#/components/schemas/urn_samm_io.catenax.vehicle.product_description_3.0.0_FuelKBA' + nhtsaFuelType: + description: Description of the fuel according US NHTSA + $ref: '#/components/schemas/urn_samm_io.catenax.vehicle.product_description_3.0.0_FuelNHTSA' + urn_samm_io.catenax.vehicle.product_description_3.0.0_Vehicle: + description: Vehicle data that does not fit into one of the other entities. + type: object + properties: + anonymizedVin: + description: OEM-specific hashed VIN; link to car data over pseydomized/hashed + VIN or Catena-X unique digital twin identifier. + $ref: '#/components/schemas/urn_samm_io.catenax.vehicle.product_description_3.0.0_UniqueID' + catenaXId: + description: "A fully anonymous Catena-X identifier that is registered in\ + \ C-X Digital twin registry. Can be used for vehicles, parts, workshops,\ + \ ....." + $ref: '#/components/schemas/urn_samm_io.catenax.vehicle.product_description_3.0.0_CatenaXIdTrait' + vehicleSeries: + description: "vehicle series, normally one level above model. E.g. vehicle\ + \ series =\"Golf\", vehicle model=\"Golf VIII\"" + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + modelDescription: + description: Detail vehicle model like "Golf VIII" + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + modelIdentifier: + description: OEM-specific model identifier or OEM-specific project name. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + class: + description: Class of the vehicle. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + steeringPos: + description: "Position of vehicle steering wheel, Left or right." + $ref: '#/components/schemas/urn_samm_io.catenax.vehicle.product_description_3.0.0_VehicleSteeringPos' + emptyWeight: + description: The empty weight of the vehicle in kg as specified. + $ref: '#/components/schemas/urn_samm_io.catenax.vehicle.product_description_3.0.0_Weight' + driveType: + description: Drive type of a vehicle according enumeration. + $ref: '#/components/schemas/urn_samm_io.catenax.vehicle.product_description_3.0.0_DriveTypeNHTSA' + systemPower: + description: Complete power of this vehicle in KW. + $ref: '#/components/schemas/urn_samm_io.catenax.vehicle.product_description_3.0.0_EnginePower' + hybridizationType: + description: Degree of hybridization in this vehicle. + $ref: '#/components/schemas/urn_samm_io.catenax.vehicle.product_description_3.0.0_Hybridization' + softwareCategory: + description: |- + Some OEMs bring in the software as complete package for all systems: + To identify this software: software category and software version is needed. + Software category when this car was built. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + softwareVersion: + description: |- + Some OEMs brings in the software as complete package for all systems: + To identify this software: software category and software version is needed. + Software version when this car was built + . + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + oem: + description: Original equipment manufacturer. + $ref: '#/components/schemas/urn_samm_io.catenax.vehicle.product_description_3.0.0_OEMCharacteristic' + body: + description: Vehicle body. + $ref: '#/components/schemas/urn_samm_io.catenax.vehicle.product_description_3.0.0_BodyCharacteristic' + equipments: + description: Equipments. + $ref: '#/components/schemas/urn_samm_io.catenax.vehicle.product_description_3.0.0_Equipments' + production: + description: This property bundles production-related information. + $ref: '#/components/schemas/urn_samm_io.catenax.vehicle.product_description_3.0.0_ProductionCharacteristic' + sale: + description: This property bundles all sales related information. + $ref: '#/components/schemas/urn_samm_io.catenax.vehicle.product_description_3.0.0_SaleCharacteristic' + engines: + description: List of installed engines in the vehicle. + $ref: '#/components/schemas/urn_samm_io.catenax.vehicle.product_description_3.0.0_Engines' + fuel: + description: The fuel type of the vehicle. + $ref: '#/components/schemas/urn_samm_io.catenax.vehicle.product_description_3.0.0_FuelCharacteristic' + required: + - anonymizedVin + - vehicleSeries + - modelDescription + - modelIdentifier + - class + - steeringPos + - emptyWeight + - driveType + - systemPower + - oem + - body + - equipments + - production + - sale + - engines + - fuel + urn_samm_io.catenax.fleet.vehicles_1.0.0_ListOfVehicles: + description: List of vehicles + type: array + items: + $ref: '#/components/schemas/urn_samm_io.catenax.vehicle.product_description_3.0.0_Vehicle' + Vehicles: + description: |- + Fleet of vehicles. This model is a shell around io.catenax.vehicle.product_description 3.0.0 + It allows to send multiple io.catenax.vehicle.product_description. + type: object + properties: + listOfVehicles: + description: List of Vehicle.ProductDescription + $ref: '#/components/schemas/urn_samm_io.catenax.fleet.vehicles_1.0.0_ListOfVehicles' + required: + - listOfVehicles + 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' + Vehicles: + content: + application/json: + schema: + $ref: '#/components/schemas/PagingSchema' + description: The request was successful. + requestBodies: + Vehicles: + content: + application/json: + schema: + $ref: '#/components/schemas/Vehicles' diff --git a/io.catenax.parts_analyses/2.0.0/gen/PartsAnalyses-aas.xml b/io.catenax.parts_analyses/2.0.0/gen/PartsAnalyses-aas.xml new file mode 100644 index 00000000..eb1ea0ab --- /dev/null +++ b/io.catenax.parts_analyses/2.0.0/gen/PartsAnalyses-aas.xml @@ -0,0 +1,1268 @@ + + + + + defaultAdminShell + + + en + defaultAdminShell + + + + urn:samm:io.catenax.parts_analyses:2.0.0#PartsAnalyses + + Type + + + + ModelReference + + + Submodel + urn:samm:io.catenax.parts_analyses:2.0.0#PartsAnalyses/submodel + + + + + + + + + PartsAnalyses + + + en + Parts analysis that are related to one quality task + + + + urn:samm:io.catenax.parts_analyses:2.0.0#PartsAnalyses/submodel + Template + + ModelReference + + + ConceptDescription + urn:samm:io.catenax.parts_analyses:2.0.0#PartsAnalyses + + + + + + listOfPartAnalyses + + + en + List Of several Part Analyses + + + + + en + A list of several part analyses + + + true + DataElement + + + PartAnalysis + + + en + Part Analysis + + + + + en + The analysis results of ONE part + + + + + manufacturerAnalysisID + + + en + Manufacturer Analysis ID + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.parts_analyses:2.0.0#manufacturerAnalysisID + + + + xs:string + + + + qualityTaskId + + + en + Quality Task ID + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.parts_analyses:2.0.0#qualityTaskId + + + + xs:string + + + + anonymizedVin + + + en + Anonymized VIN + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.parts_analyses:2.0.0#anonymizedVin + + + + xs:string + + + + status + + + en + Status + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.parts_analyses:2.0.0#status + + + + xs:string + + + + isDefect + + + en + Part defect flag + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.parts_analyses:2.0.0#isDefect + + + + xs:boolean + + + + resultsDescription + + + en + Several results of analysis + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.parts_analyses:2.0.0#resultsDescription + + + + xs:string + + + + manufacturerSerialPartNumber + + + en + Manufacturer serial part number + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.parts_analyses:2.0.0#manufacturerSerialPartNumber + + + + xs:string + + + + manufacturerPartNumber + + + en + Manufacturer Part Number + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.parts_analyses:2.0.0#manufacturerPartNumber + + + + xs:string + + + + manufacturerPartName + + + en + Manufacturer part name + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.parts_analyses:2.0.0#manufacturerPartName + + + + xs:string + + + + catenaXPartId + + + en + Catena-X Part ID + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.parts_analyses:2.0.0#catenaXPartId + + + + xs:string + + + + customerAnalysisID + + + en + Customer Analysis ID + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.parts_analyses:2.0.0#customerAnalysisID + + + + xs:string + + + + customerPartNumber + + + en + Customer part number + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.parts_analyses:2.0.0#customerPartNumber + + + + xs:string + + + + AdditionalInformation + + + en + Additional information + + + + + en + Additional information is stored as list of keys and list of values + + + + + keys + + + en + Keys + + + + + en + a list of keys + + + true + DataElement + + + keys + + + en + Keys + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.parts_analyses:2.0.0#keys + + + + xs:string + + + + + + values + + + en + Values + + + + + en + Values for the keys defined + + + true + DataElement + + + values + + + en + Values + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.parts_analyses:2.0.0#values + + + + xs:string + + + + + + + + + + + + + + + + APPLICATION_CLASS + PartsAnalyses + + + en + Parts Analysis + + + + + en + Parts analysis that are related to one quality task + + + urn:samm:io.catenax.parts_analyses:2.0.0#PartsAnalyses + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Parts Analysis + + + + + en + PartsAnalyses + + + + + en + Parts analysis that are related to one quality task + + + + + + + + + manufacturerAnalysisID + + + en + Manufacturer Analysis ID + + + urn:samm:io.catenax.parts_analyses:2.0.0#manufacturerAnalysisID + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Manufacturer Analysis ID + + + + + en + manufacturerAnalysisID + + + STRING + + + en + Internal identifier for this analysis at manufacturer. + + + + + + + + + qualityTaskId + + + en + Quality Task ID + + + urn:samm:io.catenax.parts_analyses:2.0.0#qualityTaskId + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Quality Task ID + + + + + en + qualityTaskId + + + STRING + + + en + A unique quality task identifier where these list of parts analysis belong to. + + + + + + + + + anonymizedVin + + + en + Anonymized VIN + + + urn:samm:io.catenax.parts_analyses:2.0.0#anonymizedVin + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Anonymized VIN + + + + + en + anonymizedVin + + + STRING + + + en + Reference to vehicle. OEM-specific hashed VIN. This property is the link to the vehicle from which the analyzed part came from. + + + + + + + + + status + + + en + Status + + + urn:samm:io.catenax.parts_analyses:2.0.0#status + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Status + + + + + en + status + + + STRING + + + en + Status of this part analysis + + + + + + new + + ModelReference + + + DataElement + urn:samm:io.catenax.parts_analyses:2.0.0#StatusCharacteristic:new + + + + + + in progress + + ModelReference + + + DataElement + urn:samm:io.catenax.parts_analyses:2.0.0#StatusCharacteristic:in progress + + + + + + completed + + ModelReference + + + DataElement + urn:samm:io.catenax.parts_analyses:2.0.0#StatusCharacteristic:completed + + + + + + closed + + ModelReference + + + DataElement + urn:samm:io.catenax.parts_analyses:2.0.0#StatusCharacteristic:closed + + + + + + + + + + + + + isDefect + + + en + Part defect flag + + + urn:samm:io.catenax.parts_analyses:2.0.0#isDefect + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Part defect flag + + + + + en + isDefect + + + BOOLEAN + + + en + True: Analysis turned out that analyzed part is defect accroding part's specification. + + + + + + + + + resultsDescription + + + en + Several results of analysis + + + urn:samm:io.catenax.parts_analyses:2.0.0#resultsDescription + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Several results of analysis + + + + + en + resultsDescription + + + STRING + + + en + Detailed description of part analysis results. + + + + + + + + + manufacturerSerialPartNumber + + + en + Manufacturer serial part number + + + urn:samm:io.catenax.parts_analyses:2.0.0#manufacturerSerialPartNumber + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Manufacturer serial part number + + + + + en + manufacturerSerialPartNumber + + + STRING + + + en + Serial Part Number of the analyzed part as assigned by the manufacturer of the part. The serial part number is unique for each serial part. Not available for all kinds of parts. + + + + + + + + + manufacturerPartNumber + + + en + Manufacturer Part Number + + + urn:samm:io.catenax.parts_analyses:2.0.0#manufacturerPartNumber + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Manufacturer Part Number + + + + + en + manufacturerPartNumber + + + STRING + + + en + Part number property for parts. This part number is not unique. Same parts have normally same part number. + + + + + + + + + manufacturerPartName + + + en + Manufacturer part name + + + urn:samm:io.catenax.parts_analyses:2.0.0#manufacturerPartName + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Manufacturer part name + + + + + en + manufacturerPartName + + + STRING + + + en + Name of the analyzed part as assigned by the manufacturer of the part. + + + + + + + + + catenaXPartId + + + en + Catena-X Part ID + + + urn:samm:io.catenax.parts_analyses:2.0.0#catenaXPartId + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Catena-X Part ID + + + + + en + catenaXPartId + + + STRING + + + en + The fully anonymous Catena-X ID of the analyzed part - only available after digital twin registry is fully operational. + + + + + + + + + customerAnalysisID + + + en + Customer Analysis ID + + + urn:samm:io.catenax.parts_analyses:2.0.0#customerAnalysisID + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Customer Analysis ID + + + + + en + customerAnalysisID + + + STRING + + + en + Internal identifier for this analysis at customer. + + + + + + + + + customerPartNumber + + + en + Customer part number + + + urn:samm:io.catenax.parts_analyses:2.0.0#customerPartNumber + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Customer part number + + + + + en + customerPartNumber + + + STRING + + + en + Part number from original manufacturer equipment (OEM). This part number is normally not unique. + + + + + + + + + keys + + + en + Keys + + + urn:samm:io.catenax.parts_analyses:2.0.0#keys + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Keys + + + + + en + keys + + + STRING + + + en + a list of keys + + + + + + + + + values + + + en + Values + + + urn:samm:io.catenax.parts_analyses:2.0.0#values + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Values + + + + + en + values + + + STRING + + + en + Values for the keys defined + + + + + + + + + addtionalInformation + + + en + Additional information + + + urn:samm:io.catenax.parts_analyses:2.0.0#addtionalInformation + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Additional information + + + + + en + addtionalInformation + + + STRING + + + en + You can use this key:value list for additional properties that were not defined in this aspect model. + + + + + + + + + listOfPartAnalyses + + + en + List Of several Part Analyses + + + urn:samm:io.catenax.parts_analyses:2.0.0#listOfPartAnalyses + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + List Of several Part Analyses + + + + + en + listOfPartAnalyses + + + STRING + + + en + A list of several part analyses + + + + + + + + + diff --git a/io.catenax.parts_analyses/2.0.0/gen/PartsAnalyses-schema.json b/io.catenax.parts_analyses/2.0.0/gen/PartsAnalyses-schema.json new file mode 100644 index 00000000..578b0dec --- /dev/null +++ b/io.catenax.parts_analyses/2.0.0/gen/PartsAnalyses-schema.json @@ -0,0 +1,133 @@ +{ + "$schema" : "http://json-schema.org/draft-04/schema", + "description" : "Parts analysis that are related to one quality task", + "type" : "object", + "components" : { + "schemas" : { + "urn_samm_io.catenax.parts_analyses_2.0.0_UniqueID" : { + "type" : "string", + "description" : "Characteristic for a unique id: every linked property to this characteristic is a unique ID" + }, + "urn_samm_org.eclipse.esmf.samm_characteristic_2.1.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_samm_io.catenax.parts_analyses_2.0.0_StatusCharacteristic" : { + "type" : "string", + "description" : "Enumeration of the different status values", + "enum" : [ "new", "in progress", "completed", "closed" ] + }, + "urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Boolean" : { + "type" : "boolean", + "description" : "Represents a boolean value (i.e. a \"flag\")." + }, + "urn_samm_io.catenax.parts_analyses_2.0.0_CatenaXIdTrait" : { + "type" : "string", + "description" : "The provided regular expression ensures that the UUID is composed of five groups of characters separated by hyphens, in the form 8-4-4-4-12 for a total of 36 characters (32 hexadecimal characters and 4 hyphens), optionally prefixed by \"urn:uuid:\" to make it an IRI.", + "pattern" : "(^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$)|(^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$)" + }, + "urn_samm_io.catenax.parts_analyses_2.0.0_Keys" : { + "description" : "A list of additional keys. Togther with the values list this list forms the additional data information.", + "type" : "array", + "items" : { + "type" : "string" + } + }, + "urn_samm_io.catenax.parts_analyses_2.0.0_Values" : { + "description" : "A list of additional values that forms the additional data. Togther with the keys list this list forms the additional data information.", + "type" : "array", + "items" : { + "type" : "string" + } + }, + "urn_samm_io.catenax.parts_analyses_2.0.0_Text" : { + "description" : "Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc.", + "type" : "object", + "properties" : { + "keys" : { + "description" : "a list of keys", + "$ref" : "#/components/schemas/urn_samm_io.catenax.parts_analyses_2.0.0_Keys" + }, + "values" : { + "description" : "Values for the keys defined", + "$ref" : "#/components/schemas/urn_samm_io.catenax.parts_analyses_2.0.0_Values" + } + }, + "required" : [ "keys", "values" ] + }, + "urn_samm_io.catenax.parts_analyses_2.0.0_PartAnalysis" : { + "description" : "The analysis results of ONE part", + "type" : "object", + "properties" : { + "manufacturerAnalysisID" : { + "description" : "Internal identifier for this analysis at manufacturer.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.parts_analyses_2.0.0_UniqueID" + }, + "qualityTaskId" : { + "description" : "A unique quality task identifier where these list of parts analysis belong to.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "anonymizedVin" : { + "description" : "Reference to vehicle. OEM-specific hashed VIN. This property is the link to the vehicle from which the analyzed part came from.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "status" : { + "description" : "Status of this part analysis", + "$ref" : "#/components/schemas/urn_samm_io.catenax.parts_analyses_2.0.0_StatusCharacteristic" + }, + "isDefect" : { + "description" : "True: Analysis turned out that analyzed part is defect accroding part's specification.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Boolean" + }, + "resultsDescription" : { + "description" : "Detailed description of part analysis results.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "manufacturerSerialPartNumber" : { + "description" : "Serial Part Number of the analyzed part as assigned by the manufacturer of the part. The serial part number is unique for each serial part. Not available for all kinds of parts.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "manufacturerPartNumber" : { + "description" : "Part number property for parts. This part number is not unique. Same parts have normally same part number.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "manufacturerPartName" : { + "description" : "Name of the analyzed part as assigned by the manufacturer of the part.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "catenaXPartId" : { + "description" : "The fully anonymous Catena-X ID of the analyzed part - only available after digital twin registry is fully operational.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.parts_analyses_2.0.0_CatenaXIdTrait" + }, + "customerAnalysisID" : { + "description" : "Internal identifier for this analysis at customer.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "customerPartNumber" : { + "description" : "Part number from original manufacturer equipment (OEM). This part number is normally not unique.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "addtionalInformation" : { + "description" : "You can use this key:value list for additional properties that were not defined in this aspect model.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.parts_analyses_2.0.0_Text" + } + }, + "required" : [ "manufacturerAnalysisID", "qualityTaskId", "anonymizedVin", "status", "isDefect", "resultsDescription", "manufacturerSerialPartNumber", "manufacturerPartNumber", "manufacturerPartName" ] + }, + "urn_samm_io.catenax.parts_analyses_2.0.0_ListOfPartsAnalyses" : { + "description" : "A list for multiple part analyses", + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/urn_samm_io.catenax.parts_analyses_2.0.0_PartAnalysis" + } + } + } + }, + "properties" : { + "listOfPartAnalyses" : { + "description" : "A list of several part analyses", + "$ref" : "#/components/schemas/urn_samm_io.catenax.parts_analyses_2.0.0_ListOfPartsAnalyses" + } + }, + "required" : [ "listOfPartAnalyses" ] +} \ No newline at end of file diff --git a/io.catenax.parts_analyses/2.0.0/gen/PartsAnalyses.aasx b/io.catenax.parts_analyses/2.0.0/gen/PartsAnalyses.aasx new file mode 100644 index 0000000000000000000000000000000000000000..6f5af3f325a210005c94f5f32052d62d3d3d7b90 GIT binary patch literal 5075 zcmaKw1yoeq8pnt38d4a60fYgDp}V`KM1i5ZLt0`;5s^@kZlt?YI;4kE5a|I0q*Vk2 z9^AL?y1x7Fd*4}Sud~0WcJbk@LQ1Ie8c74T)k{u zz04l?yW4o0!2DdCV|B(I`*;Y0DGPR0GWU1}RX+9w$H7UKFmRPMHOLnYj8s>G)zbSO z(tNW_=w#SV+}#r(-cm>lA|(2hLP>)UYm)LJ3fxNao7yru1-Aag>pOT$3ePAYi|3kM>TUNfaon>p4b4t#_FMzf> z4({v*9qIQQCi7^3oBsczMsPF2?6HlrCpYZ2&C(us?PI*5)t@CZ4T~+BUS|C+q`8FA zvU;xslQg$9=%Q89YqVhomJCH8u9_}Jzb>$Cty>~HTqx{lG#X$p(z_VU`nwHFNufV! zv`;vxI#*m)kn;D`(u_G?2*^zZmI+F#8;(WrC$X{;dYwJneEik%#UrA}gZNY&pY#=(FvjL| zwkcF#Mk_&Rx1dIB$-NJ6Fm(K1P^32_EG#_zxNjRSx5o~44z4F-oT}rT!()@`W5cBn zRK~d=rL!1+z^7F)Po=ti`Z}@b7=KS{w{FeET!_befb-gKF1%%=%Y}Dh$ECg!D ziELDn4#~5JmvG_bYqKECyxDhRhcH&|4((d4%nI8b@fwH-azThGvPfbgCl@p5WmJ1s z-D5(zBn(%@Vi`ItO4;hpS<3jr3=Gs&s|Rr_I|>ANJxV4(Cvk-%9jOuDA_+38T)0`U z?Ydu&4J^K`New9xjWtUDd3^C~$aHS+98N(5=#-sgP`}Gh&0dd^P(T zsQS`}3oaNV)v&&{cNq9Nu&AVu1kq7}ei&gHR&cnn=vy$;42U#EZMYvD?IHHBy^k*z zr6&+)0I;b18hKoSdt@&r(g-YCpe5aD$U2;!89RhDTRV(^>X5#07bvpXINg{LZv8^g zlLmPm7#vJ5*~OrEWch1%d%OLpdGZ6lTlB+2%qW)7yeNCFut{8m-(7zmi-O%Rcp9wr zQv^pVnb+t51|Am7d*rMyRDmZ-wiQ4N;9b5n6*+^uG>0RE@@T2J%g^a|#V1GZ z^-avO*xP?XPWaPC*w7f4)!kssfok zPYzFT5Q$%>OtO!sM)c+(Ca`lFwI#{7@*Sg_<)@?cQ3btJBcFNG3sRY6@*RsRCMzaV zG!H%JLhM&Eu?BT>o^97I;ZiV4Fg#LgSh>WT!QUz7Id9w-KP}TBK}x- zEb$n!UVR<3$Y4~BV!2?3t*fs0>~Z58dTEUs;qP>#=D5=AKT*i?^taFKopw=my07uW z;27GW;&?kBQ%CdWrV{{R<$zk;rEgBL>rQRQTtt*Dxb|y%nMClIjJoW2Jd^1UbS>ayQ=;W@~K1M#vOuWd2|d~{Uf2PNPg)>iU|w0@229Ly;dZ6nCNN2bP?>7iDeMx*cH(GppC zkMthhX}8|t2w(BpIaPn4I7UM@;)@sFvo}r|6%s3ylsgN~1;zE_j@EgDDs?g&L`>PW z4QRaAwn0x+X$x8mklTgt@kfOkk|AGO7iqCPHf-3PJc1Ba-mR>=7zPohH51y0pmuzH(NLFNA}m8(VjdRoY(%5~{4h z>w^TEtX+ezIfe6B88@XRuh!!F;H&a|%=$>|@SmT{+p$ArIty39Eb z3`zaL+O`u>94(m=UUy|wDp|>Jys2Am=)xmt9vPM^I6acCWY1Z+N6Pk~zNxgXiSpQw zOZ}U^H({eiKiz<+b3a2QtCvI_`~1CT$!dy^wWyTWuYE!o59B7Ha7!buG@kJvpDOMY zD@ZEw?_1`2vzxTg!v}UN^8>PK2_-ubf|h0-6H`h*HIzeu@C2yNpm~tM5ct@n<&jW( zqPrW~+q!*i^iELVt~sor?Zb1TbL_ddA*go= z!Gf0^djsjP_-zh#amve5q{F}T@R+{`RWfm!JN-~xXP<_pGaWSh9w5YR954mW!RE5=8 z#hi#$BYnGzg@#O4zFv)f+nO9Hv!S~irAk(0vDE?i!CnRND_OG_a?e0dbc*05%L zEU}7lNC8HZ8uTqr0Q+G?@;m_&_mgRm6j=0eH&B{Sl3Vnkio7sms7{lo~yNlpo} ze3mVEzkQ?Sux~oT`B02OfGW$ z1dCa;nTjU%NEz5t%CcH?BRlGg`Iw>jONAI9Q+qNdkhD{SboZHs9Pe*Qwn^bI-_-+>1**(Y*0qs!;isKgP zysZNn_nnjESML0D6xviO1m-%H~hNJUE&rVy-TqNbEeE z2Wnq4TX8;ZE~e+#^uV-%yDZP)Dx8twZ(!fK`>yLgnW2(Ow8Ef(lKEh#_;9Cue7 zH9-W#3N#}7HRAiZEmA=TnE5S37v|G0<${~35mrF4DOo-|`CrjbB$$Nq4zc5Ozd{Fm z@*WRi`%GXH??L6aV~MxE78>cr5s3)hoPYqG`w+D7T*n_{2)jwNy*trLiPzLzi6nxW z;7h>s56}RtpBH;`pAjV!0;tbaj!|?V-+4-3^UiNP^S#B7SuQMbyiG);R)2=v_j(p6 z6Un3FHbj2S!1aBNDY#JFz%<9AT#-7*Wu5=@DGo5N>-}I|H4WEJpP~bGp?ALgi)qKC z=ydUHkxT1JGV0QdA4zT#%=A@g3@mkGT5G*cn)6RPbMA(vKJ{$M>ACWxkqunG5TT>( z9*S1WGJfU@Hof_Qk-Ejn>Ld=4AJ5VEkOAN(SHfzcIPwX=q_^3{JmcM2mrp;R z;c&!^bxHO=v-ZD}vk;r+%q_)6G;4j*{0mBEh5iuA*|eCqa_6{ zA4f?azFdw1{gc5yHjwh#bCQGWTYZEtOv$rM2moZR{XfY_cB7B1-K?}9ySaPb=%dFr zx8lep!9=}}hbHn`?OjktL%EpxB6vhWM`&K*2*z6NQhUZ2?Q?lrf2r#I9qmf0CLv{O^G&l zOW;xfS{XD_QE-1_W7EA4Eou(wiUKjO>Ln#7wR#Pus8NrCF@u*HE30Hfvr4!z+HiLT zLYgw@8t`T!`4;wQa+a{p>Vv=I-9k+sJ*cO;5uES-5S?h~6gP_ePxI(^gXGpc`p@_W zD@j}ZKNI|J9NhXSe}&M^a=*DMf1mifJ8t + + + + + + + + + + + + Documentation Parts Analysis + + +
+
+
+
+

Aspect Model Parts Analysis

+
urn:samm:io.catenax.parts_analyses:2.0.0#PartsAnalyses
+
+
+
+
+
+
+
+ +
+ + +
+ Parts analysis that are related to one quality task +
+ + +
+

Overview

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

Properties

+
+ +
+ +
+

List Of several Part Analyses

+
+ +A list of several part analyses + +
+
Name
+
listOfPartAnalyses
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.parts_analyses:2.0.0#PartAnalysis + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
listOfPartAnalyses
+
+ + +
+
+ + + +
+
+

Entities

+
+ +
+
+

Additional information

+
+
+ Additional information is stored as list of keys and list of values +
+ +
+

Properties

+
+
+ +
+
Keys
+
+ +a list of keys + +
+
Name
+
keys
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Steel quality
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
keys
+
+ + +
+
+ +
+
Values
+
+ +Values for the keys defined + +
+
Name
+
values
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Stainless steel
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
values
+
+ + +
+
+
+
+

Part Analysis

+
+
+ The analysis results of ONE part +
+ +
+

Properties

+
+
+ +
+
Manufacturer Analysis ID
+
+ +Internal identifier for this analysis at manufacturer. + +
+
Name
+
manufacturerAnalysisID
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
TIER-647439403403
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
manufacturerAnalysisID
+
+ + +
+
+ +
+
Quality Task ID
+
+ +A unique quality task identifier where these list of parts analysis belong to. + +
+
Name
+
qualityTaskId
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
BPN-811_2022_000001
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
qualityTaskId
+
+ + +
+
+ +
+
Anonymized VIN
+
+ +Reference to vehicle. OEM-specific hashed VIN. This property is the link to the vehicle from which the analyzed part came from. + +
+
Name
+
anonymizedVin
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
3747429FGH382923974682
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
anonymizedVin
+
+ + +
+
+ +
+
Status
+
+ +Status of this part analysis + +
+
Name
+
status
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • new
    • +
  • in progress
    • +
  • completed
    • +
  • closed
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
new
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
status
+
+ + +
+
+ +
+
Part defect flag
+
+ +True: Analysis turned out that analyzed part is defect accroding part's specification. + +
+
Name
+
isDefect
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#boolean + +
+
+
+
+
+ +
+
Example
+
true
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
isDefect
+
+ + +
+
+ +
+
Several results of analysis
+
+ +Detailed description of part analysis results. + +
+
Name
+
resultsDescription
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Corrossion on component xyz in steering motor
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
resultsDescription
+
+ + +
+
+ +
+
Manufacturer serial part number
+
+ +Serial Part Number of the analyzed part as assigned by the manufacturer of the part. The serial part number is unique for each serial part. Not available for all kinds of parts. + +
+
Name
+
manufacturerSerialPartNumber
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
436347347.4343884384.FTG.538348
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
manufacturerSerialPartNumber
+
+ + +
+
+ +
+
Manufacturer Part Number
+
+ +Part number property for parts. This part number is not unique. Same parts have normally same part number. + +
+
Name
+
manufacturerPartNumber
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
123-0.740-3434-A
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
manufacturerPartNumber
+
+ + +
+
+ +
+
Manufacturer part name
+
+ +Name of the analyzed part as assigned by the manufacturer of the part. + +
+
Name
+
manufacturerPartName
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Steering assembly
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
manufacturerPartName
+
+ + +
+
+ +
+
Catena-X Part ID
+
+ +The fully anonymous Catena-X ID of the analyzed part - only available after digital twin registry is fully operational. + +
+
Name
+
catenaXPartId
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
urn:uuid:580d3adf-1981-44a0-a214-13d6ceed9000
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
catenaXPartId
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + Catena-X Id Regular Expression +
    + +
    +
    Description
    +
    The provided regular expression ensures that the UUID is composed of five groups of characters separated by hyphens, in the form 8-4-4-4-12 for a total of 36 characters (32 hexadecimal characters and 4 hyphens), optionally prefixed by "urn:uuid:" to make it an IRI.
    +
    + +
    +
    Reference
    +
    +
    +
      +
    • https://datatracker.ietf.org/doc/html/rfc4122
      • +
    +
    +
    +
    + +
    +
    Regular expression
    +
    (^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$)|(^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$)
    +
    + +
    • +
+
+
+
+
+ +
+
Customer Analysis ID
+
+ +Internal identifier for this analysis at customer. + +
+
Name
+
customerAnalysisID
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
OE-43673473438
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
customerAnalysisID
+
+ + +
+
+ +
+
Customer part number
+
+ +Part number from original manufacturer equipment (OEM). This part number is normally not unique. + +
+
Name
+
customerPartNumber
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
OE-PRT-12345
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
customerPartNumber
+
+ + +
+
+ +
+
Additional information
+
+ +You can use this key:value list for additional properties that were not defined in this aspect model. + +
+
Name
+
addtionalInformation
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.parts_analyses:2.0.0#AdditionalInformation + +
+
+
+
+
+ + +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
addtionalInformation
+
+ + +
+
+
+ +
+ Third party licenses + +
+ +
+ + +
+ + + \ No newline at end of file diff --git a/io.catenax.parts_analyses/2.0.0/gen/PartsAnalyses.json b/io.catenax.parts_analyses/2.0.0/gen/PartsAnalyses.json new file mode 100644 index 00000000..0812aaa5 --- /dev/null +++ b/io.catenax.parts_analyses/2.0.0/gen/PartsAnalyses.json @@ -0,0 +1,20 @@ +{ + "listOfPartAnalyses" : [ { + "catenaXPartId" : "urn:uuid:580d3adf-1981-44a0-a214-13d6ceed9000", + "resultsDescription" : "Corrossion on component xyz in steering motor", + "customerPartNumber" : "OE-PRT-12345", + "qualityTaskId" : "BPN-811_2022_000001", + "manufacturerSerialPartNumber" : "436347347.4343884384.FTG.538348", + "isDefect" : true, + "manufacturerAnalysisID" : "TIER-647439403403", + "anonymizedVin" : "3747429FGH382923974682", + "manufacturerPartNumber" : "123-0.740-3434-A", + "customerAnalysisID" : "OE-43673473438", + "manufacturerPartName" : "Steering assembly", + "addtionalInformation" : { + "keys" : [ "Steel quality" ], + "values" : [ "Stainless steel" ] + }, + "status" : "new" + } ] +} \ No newline at end of file diff --git a/io.catenax.parts_analyses/2.0.0/gen/PartsAnalyses.yml b/io.catenax.parts_analyses/2.0.0/gen/PartsAnalyses.yml new file mode 100644 index 00000000..72267a60 --- /dev/null +++ b/io.catenax.parts_analyses/2.0.0/gen/PartsAnalyses.yml @@ -0,0 +1,254 @@ +--- +openapi: 3.0.3 +info: + title: Parts Analysis + version: v2 +servers: +- url: catenax.io/api/v2 + variables: + api-version: + default: v2 +paths: + /{tenant-id}/parts-analyses: + get: + tags: + - PartsAnalyses + operationId: getPartsAnalyses + 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/PartsAnalyses' + "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/PartsAnalyses' + totalItems: + type: number + totalPages: + type: number + pageSize: + type: number + currentPage: + type: number + urn_samm_io.catenax.parts_analyses_2.0.0_UniqueID: + type: string + description: "Characteristic for a unique id: every linked property to this\ + \ characteristic is a unique ID" + urn_samm_org.eclipse.esmf.samm_characteristic_2.1.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_samm_io.catenax.parts_analyses_2.0.0_StatusCharacteristic: + type: string + description: Enumeration of the different status values + enum: + - new + - in progress + - completed + - closed + urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Boolean: + type: boolean + description: Represents a boolean value (i.e. a "flag"). + urn_samm_io.catenax.parts_analyses_2.0.0_CatenaXIdTrait: + type: string + description: "The provided regular expression ensures that the UUID is composed\ + \ of five groups of characters separated by hyphens, in the form 8-4-4-4-12\ + \ for a total of 36 characters (32 hexadecimal characters and 4 hyphens),\ + \ optionally prefixed by \"urn:uuid:\" to make it an IRI." + pattern: "(^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$)|(^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$)" + urn_samm_io.catenax.parts_analyses_2.0.0_Keys: + description: A list of additional keys. Togther with the values list this list + forms the additional data information. + type: array + items: + type: string + urn_samm_io.catenax.parts_analyses_2.0.0_Values: + description: A list of additional values that forms the additional data. Togther + with the keys list this list forms the additional data information. + type: array + items: + type: string + urn_samm_io.catenax.parts_analyses_2.0.0_Text: + description: "Describes a Property which contains plain text. This is intended\ + \ exclusively for human readable strings, not for identifiers, measurement\ + \ values, etc." + type: object + properties: + keys: + description: a list of keys + $ref: '#/components/schemas/urn_samm_io.catenax.parts_analyses_2.0.0_Keys' + values: + description: Values for the keys defined + $ref: '#/components/schemas/urn_samm_io.catenax.parts_analyses_2.0.0_Values' + required: + - keys + - values + urn_samm_io.catenax.parts_analyses_2.0.0_PartAnalysis: + description: The analysis results of ONE part + type: object + properties: + manufacturerAnalysisID: + description: Internal identifier for this analysis at manufacturer. + $ref: '#/components/schemas/urn_samm_io.catenax.parts_analyses_2.0.0_UniqueID' + qualityTaskId: + description: A unique quality task identifier where these list of parts + analysis belong to. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + anonymizedVin: + description: Reference to vehicle. OEM-specific hashed VIN. This property + is the link to the vehicle from which the analyzed part came from. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + status: + description: Status of this part analysis + $ref: '#/components/schemas/urn_samm_io.catenax.parts_analyses_2.0.0_StatusCharacteristic' + isDefect: + description: "True: Analysis turned out that analyzed part is defect accroding\ + \ part's specification." + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Boolean' + resultsDescription: + description: Detailed description of part analysis results. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + manufacturerSerialPartNumber: + description: Serial Part Number of the analyzed part as assigned by the + manufacturer of the part. The serial part number is unique for each serial + part. Not available for all kinds of parts. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + manufacturerPartNumber: + description: Part number property for parts. This part number is not unique. + Same parts have normally same part number. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + manufacturerPartName: + description: Name of the analyzed part as assigned by the manufacturer of + the part. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + catenaXPartId: + description: The fully anonymous Catena-X ID of the analyzed part - only + available after digital twin registry is fully operational. + $ref: '#/components/schemas/urn_samm_io.catenax.parts_analyses_2.0.0_CatenaXIdTrait' + customerAnalysisID: + description: Internal identifier for this analysis at customer. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + customerPartNumber: + description: Part number from original manufacturer equipment (OEM). This + part number is normally not unique. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + addtionalInformation: + description: You can use this key:value list for additional properties that + were not defined in this aspect model. + $ref: '#/components/schemas/urn_samm_io.catenax.parts_analyses_2.0.0_Text' + required: + - manufacturerAnalysisID + - qualityTaskId + - anonymizedVin + - status + - isDefect + - resultsDescription + - manufacturerSerialPartNumber + - manufacturerPartNumber + - manufacturerPartName + urn_samm_io.catenax.parts_analyses_2.0.0_ListOfPartsAnalyses: + description: A list for multiple part analyses + type: array + items: + $ref: '#/components/schemas/urn_samm_io.catenax.parts_analyses_2.0.0_PartAnalysis' + PartsAnalyses: + description: Parts analysis that are related to one quality task + type: object + properties: + listOfPartAnalyses: + description: A list of several part analyses + $ref: '#/components/schemas/urn_samm_io.catenax.parts_analyses_2.0.0_ListOfPartsAnalyses' + required: + - listOfPartAnalyses + 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' + PartsAnalyses: + content: + application/json: + schema: + $ref: '#/components/schemas/PagingSchema' + description: The request was successful. + requestBodies: + PartsAnalyses: + content: + application/json: + schema: + $ref: '#/components/schemas/PartsAnalyses' diff --git a/io.catenax.quality_task_attachment/1.0.0/gen/QualityTaskAttachment-aas.xml b/io.catenax.quality_task_attachment/1.0.0/gen/QualityTaskAttachment-aas.xml new file mode 100644 index 00000000..d8b1fec7 --- /dev/null +++ b/io.catenax.quality_task_attachment/1.0.0/gen/QualityTaskAttachment-aas.xml @@ -0,0 +1,1282 @@ + + + + + defaultAdminShell + + + en + defaultAdminShell + + + + urn:samm:io.catenax.quality_task_attachment:1.0.0#QualityTaskAttachment + + Type + + + + ModelReference + + + Submodel + urn:samm:io.catenax.quality_task_attachment:1.0.0#QualityTaskAttachment/submodel + + + + + + + + + QualityTaskAttachment + + + en + Additional data for quality task + + + + urn:samm:io.catenax.quality_task_attachment:1.0.0#QualityTaskAttachment/submodel + Template + + ModelReference + + + ConceptDescription + urn:samm:io.catenax.quality_task_attachment:1.0.0#QualityTaskAttachment + + + + + + qualityTaskId + + + en + Quality Task ID + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.quality_task_attachment:1.0.0#qualityTaskId + + + + xs:string + + + + relatedModelType + + + en + relatedModelType + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.quality_task_attachment:1.0.0#relatedModelType + + + + xs:string + + + + files + + + en + files + + + + + en + A list of files within the ZIP-folder, which are needed for a specific quality task + + + true + DataElement + + + File + + + en + File + + + + + en + One file attached to the quality task + + + + + fileName + + + en + file name + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.quality_task_attachment:1.0.0#fileName + + + + xs:string + + + + SchemaDefinition + + + en + Schema + + + + + en + Schema for the file entities + + + + + decimalSeperator + + + en + Decimal Separator Enumeration + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.quality_task_attachment:1.0.0#decimalSeperator + + + + xs:string + + + + delimiter + + + en + Delimiter + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.quality_task_attachment:1.0.0#delimiter + + + + xs:string + + + + variables + + + en + Variables + + + + + en + A list describing the variables contained in the file + + + true + DataElement + + + VariableAttribute + + + en + VariableAttribute + + + + + en + A list describing the variables contained in the file + + + + + variableName + + + en + Variable name + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.quality_task_attachment:1.0.0#variableName + + + + xs:string + + + + dataType + + + en + Variable data type + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.quality_task_attachment:1.0.0#dataType + + + + xs:string + + + + unit + + + en + Unit + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.quality_task_attachment:1.0.0#unit + + + + + + ExternalReference + + + GlobalReference + https://eclipse-esmf.github.io/samm-specification/2.0.0/appendix/unitcatalog.html + + + + + xs:string + + + + variableDescription + + + en + Variable description + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.quality_task_attachment:1.0.0#variableDescription + + + + xs:string + + + + + + + + + + filePath + + + en + File Path + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.quality_task_attachment:1.0.0#filePath + + + + xs:string + + + + sizeInKb + + + en + Size in Kilobyte + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.quality_task_attachment:1.0.0#sizeInKb + + + + xs:positiveInteger + + + + fileDescription + + + en + File Description + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.quality_task_attachment:1.0.0#fileDescription + + + + xs:string + + + + fileExtension + + + en + File Extension + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.quality_task_attachment:1.0.0#fileExtension + + + + xs:string + + + + + + + + + + + + APPLICATION_CLASS + QualityTaskAttachment + + + en + Quality task attachment + + + + + en + Additional data for quality task + + + urn:samm:io.catenax.quality_task_attachment:1.0.0#QualityTaskAttachment + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Quality task attachment + + + + + en + QualityTaskAttachment + + + + + en + Additional data for quality task + + + + + + + + + qualityTaskId + + + en + Quality Task ID + + + urn:samm:io.catenax.quality_task_attachment:1.0.0#qualityTaskId + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Quality Task ID + + + + + en + qualityTaskId + + + STRING + + + en + A unique quality task identifier where these list of parts analysis belong to. + + + + + + + + + relatedModelType + + + en + relatedModelType + + + urn:samm:io.catenax.quality_task_attachment:1.0.0#relatedModelType + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + relatedModelType + + + + + en + relatedModelType + + + STRING + + + en + Indicates which aspect model these additional files are to be added to + + + + + + fleet.claim_data + + ModelReference + + + DataElement + urn:samm:io.catenax.quality_task_attachment:1.0.0#QualityModelType:fleet.claim_data + + + + + + fleet.diagnostic_data + + ModelReference + + + DataElement + urn:samm:io.catenax.quality_task_attachment:1.0.0#QualityModelType:fleet.diagnostic_data + + + + + + manufactured_parts_quality_information + + ModelReference + + + DataElement + urn:samm:io.catenax.quality_task_attachment:1.0.0#QualityModelType:manufactured_parts_quality_information + + + + + + parts_analyses + + ModelReference + + + DataElement + urn:samm:io.catenax.quality_task_attachment:1.0.0#QualityModelType:parts_analyses + + + + + + quality_task + + ModelReference + + + DataElement + urn:samm:io.catenax.quality_task_attachment:1.0.0#QualityModelType:quality_task + + + + + + vehicle.product_description + + ModelReference + + + DataElement + urn:samm:io.catenax.quality_task_attachment:1.0.0#QualityModelType:vehicle.product_description + + + + + + + + + + + + + fileName + + + en + file name + + + urn:samm:io.catenax.quality_task_attachment:1.0.0#fileName + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + file name + + + + + en + fileName + + + STRING + + + en + The name of the described file + + + + + + + + + decimalSeperator + + + en + Decimal Separator Enumeration + + + urn:samm:io.catenax.quality_task_attachment:1.0.0#decimalSeperator + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Decimal Separator Enumeration + + + + + en + decimalSeperator + + + STRING + + + en + Enumeration types to be used for the decimal separators + + + + + + + + + delimiter + + + en + Delimiter + + + urn:samm:io.catenax.quality_task_attachment:1.0.0#delimiter + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Delimiter + + + + + en + delimiter + + + STRING + + + en + Indicates whether a semicolon, comma or tab is used as a delimiter between data points + + + + + + + + + variableName + + + en + Variable name + + + urn:samm:io.catenax.quality_task_attachment:1.0.0#variableName + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Variable name + + + + + en + variableName + + + STRING + + + en + The name of the column + + + + + + + + + dataType + + + en + Variable data type + + + urn:samm:io.catenax.quality_task_attachment:1.0.0#dataType + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Variable data type + + + + + en + dataType + + + STRING + + + en + The data type of the data contained in the column + + + + + + + + + unit + + + en + Unit + + + urn:samm:io.catenax.quality_task_attachment:1.0.0#unit + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Unit + + + + + en + unit + + + STRING + + + en + The unit of the data contained in the column (used for numeric values) + + + + + + + + + variableDescription + + + en + Variable description + + + urn:samm:io.catenax.quality_task_attachment:1.0.0#variableDescription + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Variable description + + + + + en + variableDescription + + + STRING + + + en + A description of the data contained in the column + + + + + + + + + variables + + + en + Variables + + + urn:samm:io.catenax.quality_task_attachment:1.0.0#variables + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Variables + + + + + en + variables + + + STRING + + + en + A list describing the variables contained in the file + + + + + + + + + schema + + + en + schema + + + urn:samm:io.catenax.quality_task_attachment:1.0.0#schema + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + schema + + + + + en + schema + + + STRING + + + en + schema definition for file + + + + + + + + + filePath + + + en + File Path + + + urn:samm:io.catenax.quality_task_attachment:1.0.0#filePath + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + File Path + + + + + en + filePath + + + STRING + + + en + Indicates where the file is located within the ZIP-folder + + + + + + + + + sizeInKb + + + en + Size in Kilobyte + + + urn:samm:io.catenax.quality_task_attachment:1.0.0#sizeInKb + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Size in Kilobyte + + + + + en + sizeInKb + + + kilobyte + INTEGER_COUNT + + + en + Indicates the size of the file + + + + + + + + + fileDescription + + + en + File Description + + + urn:samm:io.catenax.quality_task_attachment:1.0.0#fileDescription + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + File Description + + + + + en + fileDescription + + + STRING + + + en + A description of the file content + + + + + + + + + fileExtension + + + en + File Extension + + + urn:samm:io.catenax.quality_task_attachment:1.0.0#fileExtension + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + File Extension + + + + + en + fileExtension + + + STRING + + + en + Indicates which file format the file has + + + + + + + + + files + + + en + files + + + urn:samm:io.catenax.quality_task_attachment:1.0.0#files + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + files + + + + + en + files + + + STRING + + + en + A list of files within the ZIP-folder, which are needed for a specific quality task + + + + + + + + + diff --git a/io.catenax.quality_task_attachment/1.0.0/gen/QualityTaskAttachment-schema.json b/io.catenax.quality_task_attachment/1.0.0/gen/QualityTaskAttachment-schema.json new file mode 100644 index 00000000..827ac984 --- /dev/null +++ b/io.catenax.quality_task_attachment/1.0.0/gen/QualityTaskAttachment-schema.json @@ -0,0 +1,130 @@ +{ + "$schema" : "http://json-schema.org/draft-04/schema", + "description" : "Additional data for quality task", + "type" : "object", + "components" : { + "schemas" : { + "urn_samm_org.eclipse.esmf.samm_characteristic_2.1.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_samm_io.catenax.quality_task_attachment_1.0.0_QualityModelType" : { + "type" : "string", + "description" : "Enumeration of released quality aspect models", + "enum" : [ "fleet.claim_data", "fleet.diagnostic_data", "manufactured_parts_quality_information", "parts_analyses", "quality_task", "vehicle.product_description" ] + }, + "urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_UnitReference" : { + "type" : "string", + "pattern" : "[a-zA-Z]*:[a-zA-Z]+", + "description" : "Describes a Property containing a reference to one of the units in the Unit Catalog." + }, + "urn_samm_io.catenax.quality_task_attachment_1.0.0_VariableAttribute" : { + "description" : "A list describing the variables contained in the file", + "type" : "object", + "properties" : { + "variableName" : { + "description" : "The name of the column", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "dataType" : { + "description" : "The data type of the data contained in the column", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "unit" : { + "description" : "The unit of the data contained in the column (used for numeric values)", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_UnitReference" + }, + "variableDescription" : { + "description" : "A description of the data contained in the column", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + } + }, + "required" : [ "variableName", "dataType", "unit" ] + }, + "urn_samm_io.catenax.quality_task_attachment_1.0.0_Variables" : { + "description" : "A list describing the variables contained in the file", + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/urn_samm_io.catenax.quality_task_attachment_1.0.0_VariableAttribute" + } + }, + "urn_samm_io.catenax.quality_task_attachment_1.0.0_Schema" : { + "description" : "Describes the schema of the values contained in the file", + "type" : "object", + "properties" : { + "decimalSeperator" : { + "description" : "Enumeration types to be used for the decimal separators", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "delimiter" : { + "description" : "Indicates whether a semicolon, comma or tab is used as a delimiter between data points", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "variables" : { + "description" : "A list describing the variables contained in the file", + "$ref" : "#/components/schemas/urn_samm_io.catenax.quality_task_attachment_1.0.0_Variables" + } + }, + "required" : [ "variables" ] + }, + "urn_samm_io.catenax.quality_task_attachment_1.0.0_SizeInKb" : { + "type" : "number", + "minimum" : 1, + "description" : "Indicates the size of the file" + }, + "urn_samm_io.catenax.quality_task_attachment_1.0.0_File" : { + "description" : "One file attached to the quality task", + "type" : "object", + "properties" : { + "fileName" : { + "description" : "The name of the described file", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "schema" : { + "description" : "schema definition for file", + "$ref" : "#/components/schemas/urn_samm_io.catenax.quality_task_attachment_1.0.0_Schema" + }, + "filePath" : { + "description" : "Indicates where the file is located within the ZIP-folder", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "sizeInKb" : { + "description" : "Indicates the size of the file", + "$ref" : "#/components/schemas/urn_samm_io.catenax.quality_task_attachment_1.0.0_SizeInKb" + }, + "fileDescription" : { + "description" : "A description of the file content", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "fileExtension" : { + "description" : "Indicates which file format the file has", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + } + }, + "required" : [ "fileName", "filePath", "sizeInKb", "fileDescription", "fileExtension" ] + }, + "urn_samm_io.catenax.quality_task_attachment_1.0.0_ListOfFiles" : { + "description" : "List of files attached to a quality task", + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/urn_samm_io.catenax.quality_task_attachment_1.0.0_File" + } + } + } + }, + "properties" : { + "qualityTaskId" : { + "description" : "A unique quality task identifier where these list of parts analysis belong to.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "relatedModelType" : { + "description" : "Indicates which aspect model these additional files are to be added to", + "$ref" : "#/components/schemas/urn_samm_io.catenax.quality_task_attachment_1.0.0_QualityModelType" + }, + "files" : { + "description" : "A list of files within the ZIP-folder, which are needed for a specific quality task", + "$ref" : "#/components/schemas/urn_samm_io.catenax.quality_task_attachment_1.0.0_ListOfFiles" + } + }, + "required" : [ "qualityTaskId", "relatedModelType", "files" ] +} \ No newline at end of file diff --git a/io.catenax.quality_task_attachment/1.0.0/gen/QualityTaskAttachment.aasx b/io.catenax.quality_task_attachment/1.0.0/gen/QualityTaskAttachment.aasx new file mode 100644 index 0000000000000000000000000000000000000000..d199dedc86f73ea5b063f6b7e13b4f3ae224fe33 GIT binary patch literal 5223 zcmaKw1yoeq8plyoIwXfK5oBnPl#q}V31Or`x&?+DTDk?KhH~icP6edPp@)!^p@v4J z9^AL?y1x7Fd*4}Sud~H z9&Gs9%nkW#r*iWGowHe z-kc;?Tt=zc6g*V#tIYEc(t}LliH+4*^AAO<2sDo^^>L-1W2cB2X|#X4(~iNzm2_o0 zkCw;p9s;wO(XcF6j+m$zdnkSk$s+1hefQy()q2G_SR)gM?G zo!~=!db(mlE^&rq!{Q!O5i#Kdx=N#uIl& zYU}_!*0Gc5fC56X6#}!ZPf<{VBBw+5Rl${|gK4e(m!jtYTz*ZwfPkpskeQAjJ8Tfb zG#(*66MFPlZyO>zF-nsMu(-r4StC0hB&NZk>bB&wvBk-(Bo^W4!HvD%T39>e!#M_< zI>na~=+VmiySVgEqii6TZ21tmgPeSoh4aFXCneClVqFB1FO+JR&kUVeX$HU>r1!BA zFe2kyI%+2_Z(ykpq$6dNh{p2)#Sv?(u4Lg8L`&R)wguP!9K4w_%l`#^i|h~3H>a1& zF>+CFk6Lt?q1m?5WqP z$Fa<`%y+M(b&8Kg~>c+OT1xJDD*CrMvU*kBLi5V_|uC7=M}k`*~0Rimug)-fl)}f1)yk7 zQ!0^a9LbbYt6o4YI2<+j$*=yQ@?zl|ji$c2$VjoxXv+^zIyWwvWU*Gj5w?~=(p)r` z9XbhHIB)LXBWe1ihF|Nt@f=vM6*^GE1j1> zn4h*l7a2OrI+cWJjX_6FZtb}r#*Cw*GwA5oYwYytTaDdA$&@E-O?mxfQ^;9n%;_vY zcYGO^&**tL)OVUBzh@#RW}e}DCA6Rs;B0fCDHDbg9(>@cQo`&d@^FuCos`j7V>MeY zRuYQP>cO%Z1(9Syf>Bs6wJ01{uQf*ueVxBMVVYZ}wU}5roiv+zbSe%7tpg@1t_1M! zu0HLl4*n&PJXM>;HTDU;?Jk4Jo|{})WI|Q$&?im2^2ET$oC#u+`_IQrXjmq9_LDHN zwEXy8`NrXIxH}*0uq9dc*+_YhJ_j5YeIk=|EPwn4D5b{u!$hR}5`V}saA1jwQWtKp9a8k-QuXJT90urNkUX>@ zAXM@z_vaU&Ozq8QrsK^5PoAWjeYY&mA$hTez$XadPG-=$_f5#^zO9-x&=N-p@?B9@ z1n-TSdgRyU8jzn0PPo1Q=@^>~(#rx-5LP5&)Lc{lF6<-q$8;pKf~;dayJnQKz}A3< znw(*ny2&`J=5mI4W1RBQrX7Q>6Nab~Xh@>8)h50I))wtg-@#xmFPex+@6uE0Eoqzd zVtA}2YMsN`1@Am<_LTec-Xy=<6su=%HsF7ktRL<_K;bPED#>te6++w9rIpW~Mv>TD_Tycnm< zW^JwdV<%Shg_OVrvdQ@dAn6wFAgrcqNk?#~gIE*1>a6|s+tZVl#0%pQyTa*I`#H*< zZaa~K7IqV)IF$~mtDSI}sUAqY_-yH5Q9b z8apuMYrn3kOA1her40bgO*BALXdD$@MN9sHYp#D-E?$bJFn^#$zG%79*<@x zXnypl*!}tC^MPH?TJehrQg<4iX-a6W`(S=mIlVrv^BRp|F<$?AvrE-xGs-I6R+!s9 z-Ihh2=z=Tt1)W2PLO+F#n6Jjk!|ERq`6o$n(NNL#Jlt~Wm37|7$;*&Qsqoz#vzH;V z>awYY^~&c#SM0HVhS+;32pU9ktSg+aj@&O}6tg^#s|@ z-m~J8?BhNiEBc*+*YjucSNU^1eKvjtO>XLk){btDDgNu6DjAQHK%mS#2d?sbL-ECy zORz9Bw;osq!a1JzROr@=*f6F0(9e1VT7wv&*+lW78eTgD2yEx1i)>!z)U^mxV>^66 zF=cX1rfV8Dj@R>iqZFWCgR*G>6iWXem#ijSov=E$nnx(?)E-p%DkZr|LhUwn2 z?XgL{0o-VL4SHIi(mDPC4!7@&n#vWuyGeLoar-`xzda$?I#O)Hos(C(v!Az z(t5mVnfTd3nt42Sqhhr-c*`8->gG8EHnwrJ=dGxd#CpI5_C^be6lX^1in-d!R)Xu=`B7Vg?ONFylY0&H4Nt zRzM#(6f0ndwk4O~6^rzn9zjk8)=Qx%uVKQrW1FTPpkb7XfAYzQI{KSoiX3Ryfwz&> zpcA@}f^9_O)@l~z#P|Tlz?N)mOMsACyRbTqqDn9_ zbXDL-5WiyTRBc^5SBZdRW2vmo*wYwZR)F`|Oe+j)9TX~pRb(iLtKOYO%DKfb(6h%G zj@6y<9yIiv>OBZV7vV~M|Em#9FnFlvO9rbFOf zh08Mz9cM{*xVFHL3&qa$!)>H;5LHb6^chLRenXhpp!Zbk%6iLuTKx?x=LIdfmb6*Z zdSx%czWE8?sR$B{i~E9$1^kF_37IC7`>%ng=FJglx->Xd&e|xik{;R|gCD{yXDSCT z^Q03l7J9bRbSSg%u{mirHhZvJy4orqL7=USGktkh(Xp_&)dKzu%%y|CA>ff9xThpGeM+?x%z|>HVZbJwS8Xs;y4}k{{v)N6MVXyR0CepSw?&H})Z$;4bmV zESLGsjWP{lH{rWN#we!k`xW7!tBaVgVYw=Y^~Gnid>yW3r%ilKCs})%`9dykn>QO9 z)>Kau;%4pHwz)x&zgCs#d_B`E^s~|3pUYs+ga9)x-Y~7h0n*lH*K;iOUtHO4 z{bIpM^A72E^N~o&DdH;?4zbZ-^dt`O;(l2G&*`c!X4oC!60l?=*d#_6&9NVqa6SF8 z9qw7E@!?!W#gWmF)T0t)cY;T^-VEmzdI@H~xL6bQ<2$07OBsd{Fud&0S2Ws=q= z>MfXpueNv$ju&$iSzefDQkmIWKsRgd(rb%H*`XS;#Ws9?+_it!;6p%Za2l=Qn7{lO z&QR3w!MW;CMXuLuS@enFR&(=FECs{r1yeKqI>>9!56K9Txwi0h5r{!=M}$PHAVtLr zR(!|!f4M^diV`NJOT_$iJn&=|Pu618mWopV>fWNMh|K5uPZ`^t@Ghx* z-$b^$KO2(PrN)|i>U%5Lm={T3IpCq86|Mb075nf;u$elTs5&{kbG{L5PG+}i%`R3~ zsf(K=@LI7K0zIlSkV42Nkjl;km9n;VA5D`X9z7bfzizeC2NpPB@g4G5R2_dpjbZ>0 zY$+?OIRJl>B5Sksl@KT5G-FemBvMpDAa#tU0W1}o`MsY@9CH-+T(p-`m6FmAJ zoG4=~~M`Y*uVU2+SL)SlMuge`!I^}0PI_zIe<}`W>4-Hu^npu1MGHO)(Z^n181Rv5-}o zIh>^6kpFXexHt1S;?*rwm>AbDvKs~5`-cj?bC=}CB>2^q5rcj@b?P8Tmd(TMu={E{{lMwYmoo| literal 0 HcmV?d00001 diff --git a/io.catenax.quality_task_attachment/1.0.0/gen/QualityTaskAttachment.html b/io.catenax.quality_task_attachment/1.0.0/gen/QualityTaskAttachment.html new file mode 100644 index 00000000..0a67875b --- /dev/null +++ b/io.catenax.quality_task_attachment/1.0.0/gen/QualityTaskAttachment.html @@ -0,0 +1,1291 @@ + + + + + + + + + + + + + + Documentation Quality task attachment + + +
+
+
+
+

Aspect Model Quality task attachment

+
urn:samm:io.catenax.quality_task_attachment:1.0.0#QualityTaskAttachment
+
+
+
+
+
+
+
+ +
+ + +
+ Additional data for quality task +
+ + +
+

Overview

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

Properties

+
+ +
+ +
+

Quality Task ID

+
+ +A unique quality task identifier where these list of parts analysis belong to. + +
+
Name
+
qualityTaskId
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
BPN-811_2022_000001
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
qualityTaskId
+
+ + +
+
+ +
+

files

+
+ +A list of files within the ZIP-folder, which are needed for a specific quality task + +
+
Name
+
files
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.quality_task_attachment:1.0.0#File + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
files
+
+ + +
+
+ +
+

relatedModelType

+
+ +Indicates which aspect model these additional files are to be added to + +
+
Name
+
relatedModelType
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • fleet.claim_data
    • +
  • fleet.diagnostic_data
    • +
  • manufactured_parts_quality_information
    • +
  • parts_analyses
    • +
  • quality_task
    • +
  • vehicle.product_description
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
relatedModelType
+
+ + +
+
+ + + +
+
+

Entities

+
+ +
+
+

File

+
+
+ One file attached to the quality task +
+ +
+

Properties

+
+
+ +
+
file name
+
+ +The name of the described file + +
+
Name
+
fileName
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Histogramm_data.csv
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
fileName
+
+ + +
+
+ +
+
schema
+
+ +schema definition for file + +
+
Name
+
schema
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.quality_task_attachment:1.0.0#SchemaDefinition + +
+
+
+
+
+ + +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
schema
+
+ + +
+
+ +
+
File Path
+
+ +Indicates where the file is located within the ZIP-folder + +
+
Name
+
filePath
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
/subfolder/Histogramm_data.csv
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
filePath
+
+ + +
+
+ +
+
Size in Kilobyte
+
+ +Indicates the size of the file + +
+
Name
+
sizeInKb
+
+ + + +
+
Characteristic
+
+
+
+
Measurement
+
+
+
Indicates the size of the file
+
+
+
Unit
+
+
+
+
    +
  • + Kilobyte +
    • +
  • + Symbol kB +
    • +
  • + Code 2P +
    • +
  • + Conversion factor 10³ B +
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#positiveInteger + +
+
+
+
+
+ +
+
Example
+
615
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
sizeInKb
+
+ + +
+
+ +
+
File Description
+
+ +A description of the file content + +
+
Name
+
fileDescription
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Price list for various components
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
fileDescription
+
+ + +
+
+ +
+
File Extension
+
+ +Indicates which file format the file has + +
+
Name
+
fileExtension
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
csv
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
fileExtension
+
+ + +
+
+
+
+

Schema

+
+
+ Schema for the file entities +
+ +
+

Properties

+
+
+ +
+
Decimal Separator Enumeration
+
+ +Enumeration types to be used for the decimal separators + +
+
Name
+
decimalSeperator
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
"comma", "dot"
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
decimalSeperator
+
+ + +
+
+ +
+
Delimiter
+
+ +Indicates whether a semicolon, comma or tab is used as a delimiter between data points + +
+
Name
+
delimiter
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
semicolon
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
delimiter
+
+ + +
+
+ +
+
Variables
+
+ +A list describing the variables contained in the file + +
+
Name
+
variables
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.quality_task_attachment:1.0.0#VariableAttribute + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
variables
+
+ + +
+
+
+
+

VariableAttribute

+
+
+ A list describing the variables contained in the file +
+ +
+

Properties

+
+
+ +
+
Variable name
+
+ +The name of the column + +
+
Name
+
variableName
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Price
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
variableName
+
+ + +
+
+ +
+
Variable data type
+
+ +The data type of the data contained in the column + +
+
Name
+
dataType
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
double
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
dataType
+
+ + +
+
+ +
+
Unit
+
+ +The unit of the data contained in the column (used for numeric values) + +
+
Name
+
unit
+
+ + + +
+
Characteristic
+
+
+
+
+ Type urn:samm:org.eclipse.esmf.samm:meta-model:2.1.0#curie + +
+
+
+
+
+ +
+
Example
+
degreeCelsiusPerHour
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
unit
+
+ +
+
Reference
+
+
    +
  • https://eclipse-esmf.github.io/samm-specification/2.0.0/appendix/unitcatalog.html
    • +
+
+
+ +
+
+ +
+
Variable description
+
+ +A description of the data contained in the column + +
+
Name
+
variableDescription
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
This column contains the hourly temperature of a part
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
variableDescription
+
+ + +
+
+
+ +
+ Third party licenses + +
+ +
+ + +
+ + + \ No newline at end of file diff --git a/io.catenax.quality_task_attachment/1.0.0/gen/QualityTaskAttachment.json b/io.catenax.quality_task_attachment/1.0.0/gen/QualityTaskAttachment.json new file mode 100644 index 00000000..5677b5af --- /dev/null +++ b/io.catenax.quality_task_attachment/1.0.0/gen/QualityTaskAttachment.json @@ -0,0 +1,21 @@ +{ + "relatedModelType" : "fleet.claim_data", + "files" : [ { + "schema" : { + "delimiter" : "semicolon", + "variables" : [ { + "unit" : "degreeCelsiusPerHour", + "variableName" : "Price", + "dataType" : "double", + "variableDescription" : "This column contains the hourly temperature of a part" + } ], + "decimalSeperator" : "\"comma\", \"dot\"" + }, + "fileDescription" : "Price list for various components", + "fileName" : "Histogramm_data.csv", + "sizeInKb" : 615, + "fileExtension" : "csv", + "filePath" : "/subfolder/Histogramm_data.csv" + } ], + "qualityTaskId" : "BPN-811_2022_000001" +} \ No newline at end of file diff --git a/io.catenax.quality_task_attachment/1.0.0/gen/QualityTaskAttachment.yml b/io.catenax.quality_task_attachment/1.0.0/gen/QualityTaskAttachment.yml new file mode 100644 index 00000000..d62ce0e0 --- /dev/null +++ b/io.catenax.quality_task_attachment/1.0.0/gen/QualityTaskAttachment.yml @@ -0,0 +1,242 @@ +--- +openapi: 3.0.3 +info: + title: Quality task attachment + version: v1 +servers: +- url: catenax.io/api/v1 + variables: + api-version: + default: v1 +paths: + /{tenant-id}/quality-task-attachment: + get: + tags: + - QualityTaskAttachment + operationId: getQualityTaskAttachment + 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/QualityTaskAttachment' + "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/QualityTaskAttachment' + totalItems: + type: number + totalPages: + type: number + pageSize: + type: number + currentPage: + type: number + urn_samm_org.eclipse.esmf.samm_characteristic_2.1.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_samm_io.catenax.quality_task_attachment_1.0.0_QualityModelType: + type: string + description: Enumeration of released quality aspect models + enum: + - fleet.claim_data + - fleet.diagnostic_data + - manufactured_parts_quality_information + - parts_analyses + - quality_task + - vehicle.product_description + urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_UnitReference: + type: string + pattern: "[a-zA-Z]*:[a-zA-Z]+" + description: Describes a Property containing a reference to one of the units + in the Unit Catalog. + urn_samm_io.catenax.quality_task_attachment_1.0.0_VariableAttribute: + description: A list describing the variables contained in the file + type: object + properties: + variableName: + description: The name of the column + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + dataType: + description: The data type of the data contained in the column + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + unit: + description: The unit of the data contained in the column (used for numeric + values) + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_UnitReference' + variableDescription: + description: A description of the data contained in the column + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + required: + - variableName + - dataType + - unit + urn_samm_io.catenax.quality_task_attachment_1.0.0_Variables: + description: A list describing the variables contained in the file + type: array + items: + $ref: '#/components/schemas/urn_samm_io.catenax.quality_task_attachment_1.0.0_VariableAttribute' + urn_samm_io.catenax.quality_task_attachment_1.0.0_Schema: + description: Describes the schema of the values contained in the file + type: object + properties: + decimalSeperator: + description: Enumeration types to be used for the decimal separators + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + delimiter: + description: "Indicates whether a semicolon, comma or tab is used as a delimiter\ + \ between data points" + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + variables: + description: A list describing the variables contained in the file + $ref: '#/components/schemas/urn_samm_io.catenax.quality_task_attachment_1.0.0_Variables' + required: + - variables + urn_samm_io.catenax.quality_task_attachment_1.0.0_SizeInKb: + type: number + minimum: 1 + description: Indicates the size of the file + urn_samm_io.catenax.quality_task_attachment_1.0.0_File: + description: One file attached to the quality task + type: object + properties: + fileName: + description: The name of the described file + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + schema: + description: schema definition for file + $ref: '#/components/schemas/urn_samm_io.catenax.quality_task_attachment_1.0.0_Schema' + filePath: + description: Indicates where the file is located within the ZIP-folder + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + sizeInKb: + description: Indicates the size of the file + $ref: '#/components/schemas/urn_samm_io.catenax.quality_task_attachment_1.0.0_SizeInKb' + fileDescription: + description: A description of the file content + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + fileExtension: + description: Indicates which file format the file has + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + required: + - fileName + - filePath + - sizeInKb + - fileDescription + - fileExtension + urn_samm_io.catenax.quality_task_attachment_1.0.0_ListOfFiles: + description: List of files attached to a quality task + type: array + items: + $ref: '#/components/schemas/urn_samm_io.catenax.quality_task_attachment_1.0.0_File' + QualityTaskAttachment: + description: Additional data for quality task + type: object + properties: + qualityTaskId: + description: A unique quality task identifier where these list of parts + analysis belong to. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + relatedModelType: + description: Indicates which aspect model these additional files are to + be added to + $ref: '#/components/schemas/urn_samm_io.catenax.quality_task_attachment_1.0.0_QualityModelType' + files: + description: "A list of files within the ZIP-folder, which are needed for\ + \ a specific quality task" + $ref: '#/components/schemas/urn_samm_io.catenax.quality_task_attachment_1.0.0_ListOfFiles' + required: + - qualityTaskId + - relatedModelType + - files + 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' + QualityTaskAttachment: + content: + application/json: + schema: + $ref: '#/components/schemas/PagingSchema' + description: The request was successful. + requestBodies: + QualityTaskAttachment: + content: + application/json: + schema: + $ref: '#/components/schemas/QualityTaskAttachment' diff --git a/io.catenax.vehicle.product_description/3.0.0/gen/ProductDescription-aas.xml b/io.catenax.vehicle.product_description/3.0.0/gen/ProductDescription-aas.xml new file mode 100644 index 00000000..95c864b1 --- /dev/null +++ b/io.catenax.vehicle.product_description/3.0.0/gen/ProductDescription-aas.xml @@ -0,0 +1,4504 @@ + + + + + defaultAdminShell + + + en + defaultAdminShell + + + + urn:samm:io.catenax.vehicle.product_description:3.0.0#ProductDescription + + Type + + + + ModelReference + + + Submodel + urn:samm:io.catenax.vehicle.product_description:3.0.0#ProductDescription/submodel + + + + + + + + + ProductDescription + + + en + Master data of one vehicle - from an end customer view. So this model represents the vehicle as it was sold to the customer. All entities and properties are immutable over the lifetime of the vehicle. + + + + urn:samm:io.catenax.vehicle.product_description:3.0.0#ProductDescription/submodel + Template + + ModelReference + + + ConceptDescription + urn:samm:io.catenax.vehicle.product_description:3.0.0#ProductDescription + + + + + + Vehicle + + + en + Vehicle + + + + + en + Vehicle data that does not fit into one of the other entities. + + + + + anonymizedVin + + + en + Anonymized VIN + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.vehicle.product_description:3.0.0#anonymizedVin + + + + xs:string + + + + catenaXId + + + en + Vehicle Catena-X Identifier + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.vehicle.product_description:3.0.0#catenaXId + + + + xs:string + + + + vehicleSeries + + + en + Vehicle series + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.vehicle.product_description:3.0.0#vehicleSeries + + + + xs:string + + + + modelDescription + + + en + Vehicle model + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.vehicle.product_description:3.0.0#modelDescription + + + + xs:string + + + + modelIdentifier + + + en + Model identifier + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.vehicle.product_description:3.0.0#modelIdentifier + + + + xs:string + + + + class + + + en + Vehicle class + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.vehicle.product_description:3.0.0#class + + + + xs:string + + + + steeringPos + + + en + Vehicle steering pos + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.vehicle.product_description:3.0.0#steeringPos + + + + xs:string + + + + emptyWeight + + + en + Vehicle empty weight + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.vehicle.product_description:3.0.0#emptyWeight + + + + xs:double + + + + driveType + + + en + Drive type + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.vehicle.product_description:3.0.0#driveType + + + + xs:string + + + + systemPower + + + en + Complete system power + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.vehicle.product_description:3.0.0#systemPower + + + + xs:integer + + + + hybridizationType + + + en + Hybridization + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.vehicle.product_description:3.0.0#hybridizationType + + + + xs:string + + + + softwareCategory + + + en + Software category + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.vehicle.product_description:3.0.0#softwareCategory + + + + xs:string + + + + softwareVersion + + + en + Software version + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.vehicle.product_description:3.0.0#softwareVersion + + + + xs:string + + + + OriginalEquipmentManufacturer + + + en + OEM + + + + + en + Describes one original eequipment manufacturer (OEM) to which this vehicle belongs to. + + + + + wmiCode + + + en + WMI Code + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.vehicle.product_description:3.0.0#wmiCode + + + + + + ExternalReference + + + GlobalReference + https://vpic.nhtsa.dot.gov/ + + + + + xs:string + + + + wmiDescription + + + en + OEM name + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.vehicle.product_description:3.0.0#wmiDescription + + + + + + ExternalReference + + + GlobalReference + https://vpic.nhtsa.dot.gov/ + + + + + xs:string + + + + cxBPN + + + en + CX Business partner number + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.vehicle.product_description:3.0.0#cxBPN + + + + xs:string + + + + + + Body + + + en + Body + + + + + en + All vhicel body-related data. + + + + + numberOfDoors + + + en + Number of doors + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.vehicle.product_description:3.0.0#numberOfDoors + + + + xs:positiveInteger + + + + colorId + + + en + Color identifier + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.vehicle.product_description:3.0.0#colorId + + + + xs:string + + + + colorDescription + + + en + Color description + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.vehicle.product_description:3.0.0#colorDescription + + + + xs:string + + + + kbaBody + + + en + Body variant(KBA) + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.vehicle.product_description:3.0.0#kbaBody + + + + xs:string + + + + nhtsaBody + + + en + Body variant(NHTSA) + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.vehicle.product_description:3.0.0#nhtsaBody + + + + xs:string + + + + + + equipments + + + en + Equipments + + + + + en + Equipments. + + + true + DataElement + + + Equipment + + + en + Equipment + + + + + en + One equipment of the vehicle. + + + + + equipmentIdentifier + + + en + Equipment Id + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.vehicle.product_description:3.0.0#equipmentIdentifier + + + + xs:string + + + + equipmentDescription + + + en + Equipment description + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.vehicle.product_description:3.0.0#equipmentDescription + + + + xs:string + + + + group + + + en + Equipment group + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.vehicle.product_description:3.0.0#group + + + + xs:string + + + + + + + + Production + + + en + Production + + + + + en + Entity to bundle all production-related data. + + + + + productionDate + + + en + Vehicle production Date + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.vehicle.product_description:3.0.0#productionDate + + + + xs:dateTime + + + + plantIdentifier + + + en + Production plant id + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.vehicle.product_description:3.0.0#plantIdentifier + + + + xs:string + + + + plantDescription + + + en + Vehicle production plant name + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.vehicle.product_description:3.0.0#plantDescription + + + + xs:string + + + + + + Sale + + + en + Sale + + + + + en + Bundels all sale-related data + + + + + soldDate + + + en + Vehicle sold date: + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.vehicle.product_description:3.0.0#soldDate + + + + xs:dateTime + + + + countryCode + + + en + Vehicle sold country + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.vehicle.product_description:3.0.0#countryCode + + + + xs:string + + + + countryGroup + + + en + Vehicle sold region + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.vehicle.product_description:3.0.0#countryGroup + + + + xs:string + + + + + + engines + + + en + Engines + + + + + en + List of installed engines in the vehicle. + + + true + DataElement + + + Engine + + + en + Engine Entity + + + + + en + Describing one installed engine + + + + + engineId + + + en + Engine ID: + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.vehicle.product_description:3.0.0#engineId + + + + xs:string + + + + engineDescription + + + en + Engine Description + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.vehicle.product_description:3.0.0#engineDescription + + + + xs:string + + + + engineSeries + + + en + Vehicle engine series + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.vehicle.product_description:3.0.0#engineSeries + + + + xs:string + + + + serialNumber + + + en + Engine serial number + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.vehicle.product_description:3.0.0#serialNumber + + + + xs:string + + + + size + + + en + Engine size + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.vehicle.product_description:3.0.0#size + + + + xs:integer + + + + power + + + en + Engine power + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.vehicle.product_description:3.0.0#power + + + + xs:integer + + + + engineProductionDate + + + en + Engine production date + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.vehicle.product_description:3.0.0#engineProductionDate + + + + xs:dateTime + + + + installDate + + + en + Engine install date + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.vehicle.product_description:3.0.0#installDate + + + + xs:dateTime + + + + + + + + Fuel + + + en + Fuel + + + + + en + Bundels all fuel-related data. + + + + + kbaFuelType + + + en + Fuel type(KBA) + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.vehicle.product_description:3.0.0#kbaFuelType + + + + xs:string + + + + nhtsaFuelType + + + en + Fuel type(NHTSA) + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.vehicle.product_description:3.0.0#nhtsaFuelType + + + + xs:string + + + + + + + + + + + + APPLICATION_CLASS + ProductDescription + + + en + Vehicle master data + + + + + en + Master data of one vehicle - from an end customer view. So this model represents the vehicle as it was sold to the customer. All entities and properties are immutable over the lifetime of the vehicle. + + + urn:samm:io.catenax.vehicle.product_description:3.0.0#ProductDescription + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Vehicle master data + + + + + en + ProductDescription + + + + + en + Master data of one vehicle - from an end customer view. So this model represents the vehicle as it was sold to the customer. All entities and properties are immutable over the lifetime of the vehicle. + + + + + + + + + anonymizedVin + + + en + Anonymized VIN + + + urn:samm:io.catenax.vehicle.product_description:3.0.0#anonymizedVin + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Anonymized VIN + + + + + en + anonymizedVin + + + STRING + + + en + OEM-specific hashed VIN; link to car data over pseydomized/hashed VIN or Catena-X unique digital twin identifier. + + + + + + + + + catenaXId + + + en + Vehicle Catena-X Identifier + + + urn:samm:io.catenax.vehicle.product_description:3.0.0#catenaXId + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Vehicle Catena-X Identifier + + + + + en + catenaXId + + + STRING + + + en + A fully anonymous Catena-X identifier that is registered in C-X Digital twin registry. Can be used for vehicles, parts, workshops, ..... + + + + + + + + + vehicleSeries + + + en + Vehicle series + + + urn:samm:io.catenax.vehicle.product_description:3.0.0#vehicleSeries + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Vehicle series + + + + + en + vehicleSeries + + + STRING + + + en + vehicle series, normally one level above model. E.g. vehicle series ="Golf", vehicle model="Golf VIII" + + + + + + + + + modelDescription + + + en + Vehicle model + + + urn:samm:io.catenax.vehicle.product_description:3.0.0#modelDescription + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Vehicle model + + + + + en + modelDescription + + + STRING + + + en + Detail vehicle model like "Golf VIII" + + + + + + + + + modelIdentifier + + + en + Model identifier + + + urn:samm:io.catenax.vehicle.product_description:3.0.0#modelIdentifier + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Model identifier + + + + + en + modelIdentifier + + + STRING + + + en + OEM-specific model identifier or OEM-specific project name. + + + + + + + + + class + + + en + Vehicle class + + + urn:samm:io.catenax.vehicle.product_description:3.0.0#class + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Vehicle class + + + + + en + class + + + STRING + + + en + Class of the vehicle. + + + + + + + + + steeringPos + + + en + Vehicle steering pos + + + urn:samm:io.catenax.vehicle.product_description:3.0.0#steeringPos + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Vehicle steering pos + + + + + en + steeringPos + + + STRING + + + en + Position of vehicle steering wheel, Left or right. + + + + + + Left-Hand Drive + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#VehicleSteeringPos:Left-Hand Drive + + + + + + Right-Hand Drive + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#VehicleSteeringPos:Right-Hand Drive + + + + + + + + + + + + + emptyWeight + + + en + Vehicle empty weight + + + urn:samm:io.catenax.vehicle.product_description:3.0.0#emptyWeight + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Vehicle empty weight + + + + + en + emptyWeight + + + kilogram + REAL_MEASURE + + + en + The empty weight of the vehicle in kg as specified. + + + + + + + + + driveType + + + en + Drive type + + + urn:samm:io.catenax.vehicle.product_description:3.0.0#driveType + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Drive type + + + + + en + driveType + + + STRING + + + en + Drive type of a vehicle according enumeration. + + + + + + All-Wheel Drive + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#DriveTypeNHTSA:All-Wheel Drive + + + + + + Front-Wheel Drive + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#DriveTypeNHTSA:Front-Wheel Drive + + + + + + Rear-Wheel Drive + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#DriveTypeNHTSA:Rear-Wheel Drive + + + + + + + + + + + + + systemPower + + + en + Complete system power + + + urn:samm:io.catenax.vehicle.product_description:3.0.0#systemPower + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Complete system power + + + + + en + systemPower + + + kilowatt + INTEGER_MEASURE + + + en + Complete power of this vehicle in KW. + + + + + + + + + hybridizationType + + + en + Hybridization + + + urn:samm:io.catenax.vehicle.product_description:3.0.0#hybridizationType + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Hybridization + + + + + en + hybridizationType + + + STRING + + + en + Degree of hybridization in this vehicle. + + + + + + battery electric vehicle + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#Hybridization:battery electric vehicle + + + + + + hybrid electric vehicle + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#Hybridization:hybrid electric vehicle + + + + + + no hybrid + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#Hybridization:no hybrid + + + + + + plugin hybrid electric vehicle + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#Hybridization:plugin hybrid electric vehicle + + + + + + range extender + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#Hybridization:range extender + + + + + + + + + + + + + softwareCategory + + + en + Software category + + + urn:samm:io.catenax.vehicle.product_description:3.0.0#softwareCategory + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Software category + + + + + en + softwareCategory + + + STRING + + + en + Some OEMs bring in the software as complete package for all systems: +To identify this software: software category and software version is needed. +Software category when this car was built. + + + + + + + + + softwareVersion + + + en + Software version + + + urn:samm:io.catenax.vehicle.product_description:3.0.0#softwareVersion + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Software version + + + + + en + softwareVersion + + + STRING + + + en + Some OEMs brings in the software as complete package for all systems: +To identify this software: software category and software version is needed. +Software version when this car was built +. + + + + + + + + + wmiCode + + + en + WMI Code + + + urn:samm:io.catenax.vehicle.product_description:3.0.0#wmiCode + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + WMI Code + + + + + en + wmiCode + + + STRING + + + en + Short name/code of vehicle manufacturer according to world manufacturer information(wmi). The wmiCode are the first 3 chars of the vehicle identification number. +A list of in NHTSA registered wmiCodes can be found in attribute Wmi in table [vPICList_lite].[dbo].[Wmi] + + + + + + + + + wmiDescription + + + en + OEM name + + + urn:samm:io.catenax.vehicle.product_description:3.0.0#wmiDescription + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + OEM name + + + + + en + wmiDescription + + + STRING + + + en + Name of OEM according NHTSA or other authorities. Has to be compliant with/linked wmiCode attribute. +For NHTSA: name of table [vPICList_lite].[dbo].[Manufacturer] + + + + + + + + + cxBPN + + + en + CX Business partner number + + + urn:samm:io.catenax.vehicle.product_description:3.0.0#cxBPN + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + CX Business partner number + + + + + en + cxBPN + + + STRING + + + en + Catena-X business partner number of this company. + + + + + + + + + oem + + + en + OEM + + + urn:samm:io.catenax.vehicle.product_description:3.0.0#oem + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + OEM + + + + + en + oem + + + STRING + + + en + Original equipment manufacturer. + + + + + + + + + numberOfDoors + + + en + Number of doors + + + urn:samm:io.catenax.vehicle.product_description:3.0.0#numberOfDoors + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Number of doors + + + + + en + numberOfDoors + + + INTEGER_COUNT + + + en + Describes the number of doors of a vehicle. + + + + + + + + + colorId + + + en + Color identifier + + + urn:samm:io.catenax.vehicle.product_description:3.0.0#colorId + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Color identifier + + + + + en + colorId + + + STRING + + + en + Colour code describes the code of a specific colour of a vehicle. + + + + + + + + + colorDescription + + + en + Color description + + + urn:samm:io.catenax.vehicle.product_description:3.0.0#colorDescription + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Color description + + + + + en + colorDescription + + + STRING + + + en + Colour name describes the colour of the colour code as a written word. + + + + + + + + + kbaBody + + + en + Body variant(KBA) + + + urn:samm:io.catenax.vehicle.product_description:3.0.0#kbaBody + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Body variant(KBA) + + + + + en + kbaBody + + + STRING + + + en + Vehicle variant - Body shapes according German KBA + + + + + + Limousine + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#KbaVariant:Limousine + + + + + + Kombilimousine + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#KbaVariant:Kombilimousine + + + + + + Kabrio-Limousine + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#KbaVariant:Kabrio-Limousine + + + + + + Cabrio-Limousine + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#KbaVariant:Cabrio-Limousine + + + + + + Mehrzweckfahrzeug + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#KbaVariant:Mehrzweckfahrzeug + + + + + + Pkw-Pick-up + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#KbaVariant:Pkw-Pick-up + + + + + + Van + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#KbaVariant:Van + + + + + + Pick-up + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#KbaVariant:Pick-up + + + + + + Coupe + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#KbaVariant:Coupe + + + + + + Schraeghecklimousine + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#KbaVariant:Schraeghecklimousine + + + + + + + + + + + + + nhtsaBody + + + en + Body variant(NHTSA) + + + urn:samm:io.catenax.vehicle.product_description:3.0.0#nhtsaBody + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Body variant(NHTSA) + + + + + en + nhtsaBody + + + STRING + + + en + Vehicle variant - Body shapes according US NHTSA + + + + + + Cargo Van + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#NhtsaVariant:Cargo Van + + + + + + Convertible + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#NhtsaVariant:Convertible + + + + + + Cabriolet + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#NhtsaVariant:Cabriolet + + + + + + Coupe + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#NhtsaVariant:Coupe + + + + + + Crossover Utility Vehicle(CUV) + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#NhtsaVariant:Crossover Utility Vehicle(CUV) + + + + + + Hatchback + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#NhtsaVariant:Hatchback + + + + + + Liftback + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#NhtsaVariant:Liftback + + + + + + Notchback + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#NhtsaVariant:Notchback + + + + + + Limousine + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#NhtsaVariant:Limousine + + + + + + Low Speed Vehicle(LSV) + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#NhtsaVariant:Low Speed Vehicle(LSV) + + + + + + Neighborhood Electric Vehicle(NEV) + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#NhtsaVariant:Neighborhood Electric Vehicle(NEV) + + + + + + Minivan + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#NhtsaVariant:Minivan + + + + + + Pickup + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#NhtsaVariant:Pickup + + + + + + Roadster + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#NhtsaVariant:Roadster + + + + + + Sedan + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#NhtsaVariant:Sedan + + + + + + Saloon + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#NhtsaVariant:Saloon + + + + + + Sport Utility Truck(SUT) + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#NhtsaVariant:Sport Utility Truck(SUT) + + + + + + Sport Utility Vehicle(SUV) + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#NhtsaVariant:Sport Utility Vehicle(SUV) + + + + + + Multi-Purpose Vehicle(MPV) + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#NhtsaVariant:Multi-Purpose Vehicle(MPV) + + + + + + Van + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#NhtsaVariant:Van + + + + + + Wagon + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#NhtsaVariant:Wagon + + + + + + + + + + + + + body + + + en + Vehicle body + + + urn:samm:io.catenax.vehicle.product_description:3.0.0#body + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Vehicle body + + + + + en + body + + + STRING + + + en + Vehicle body. + + + + + + + + + equipmentIdentifier + + + en + Equipment Id + + + urn:samm:io.catenax.vehicle.product_description:3.0.0#equipmentIdentifier + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Equipment Id + + + + + en + equipmentIdentifier + + + STRING + + + en + The identifier of a specific equipment. + + + + + + + + + equipmentDescription + + + en + Equipment description + + + urn:samm:io.catenax.vehicle.product_description:3.0.0#equipmentDescription + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Equipment description + + + + + en + equipmentDescription + + + STRING + + + en + The equipment variants description. + + + + + + + + + group + + + en + Equipment group + + + urn:samm:io.catenax.vehicle.product_description:3.0.0#group + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Equipment group + + + + + en + group + + + STRING + + + en + Bundels all equipment-oriented information into categories like Interior + + + + + + + + + equipments + + + en + Equipments + + + urn:samm:io.catenax.vehicle.product_description:3.0.0#equipments + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Equipments + + + + + en + equipments + + + STRING + + + en + Equipments. + + + + + + + + + productionDate + + + en + Vehicle production Date + + + urn:samm:io.catenax.vehicle.product_description:3.0.0#productionDate + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Vehicle production Date + + + + + en + productionDate + + + STRING + + + en + Production date of the vehicle + + + + + + + + + plantIdentifier + + + en + Production plant id + + + urn:samm:io.catenax.vehicle.product_description:3.0.0#plantIdentifier + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Production plant id + + + + + en + plantIdentifier + + + STRING + + + en + Plant id of the final assembly of the vehicle + + + + + + + + + plantDescription + + + en + Vehicle production plant name + + + urn:samm:io.catenax.vehicle.product_description:3.0.0#plantDescription + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Vehicle production plant name + + + + + en + plantDescription + + + STRING + + + en + Long name of the production plant of the vehicle + + + + + + + + + production + + + en + Production + + + urn:samm:io.catenax.vehicle.product_description:3.0.0#production + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Production + + + + + en + production + + + STRING + + + en + This property bundles production-related information. + + + + + + + + + soldDate + + + en + Vehicle sold date: + + + urn:samm:io.catenax.vehicle.product_description:3.0.0#soldDate + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Vehicle sold date: + + + + + en + soldDate + + + STRING + + + en + Sold date of the vehicle = warranty start date for this vehicle + + + + + + + + + countryCode + + + en + Vehicle sold country + + + urn:samm:io.catenax.vehicle.product_description:3.0.0#countryCode + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Vehicle sold country + + + + + en + countryCode + + + STRING + + + en + Vehicle sold country in ISO 8601 alpha 3 + + + + + + + + + countryGroup + + + en + Vehicle sold region + + + urn:samm:io.catenax.vehicle.product_description:3.0.0#countryGroup + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Vehicle sold region + + + + + en + countryGroup + + + STRING + + + en + Region where this car was sold + + + + + + + + + sale + + + en + Sale + + + urn:samm:io.catenax.vehicle.product_description:3.0.0#sale + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Sale + + + + + en + sale + + + STRING + + + en + This property bundles all sales related information. + + + + + + + + + engineId + + + en + Engine ID: + + + urn:samm:io.catenax.vehicle.product_description:3.0.0#engineId + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Engine ID: + + + + + en + engineId + + + STRING + + + en + OEM-specific identifier/type of the installed engine + + + + + + + + + engineDescription + + + en + Engine Description + + + urn:samm:io.catenax.vehicle.product_description:3.0.0#engineDescription + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Engine Description + + + + + en + engineDescription + + + STRING + + + en + Description of the engine + + + + + + + + + engineSeries + + + en + Vehicle engine series + + + urn:samm:io.catenax.vehicle.product_description:3.0.0#engineSeries + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Vehicle engine series + + + + + en + engineSeries + + + STRING + + + en + Engine series as defined by OEM + + + + + + + + + serialNumber + + + en + Engine serial number + + + urn:samm:io.catenax.vehicle.product_description:3.0.0#serialNumber + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Engine serial number + + + + + en + serialNumber + + + STRING + + + en + Serial number of the installed engine + + + + + + + + + size + + + en + Engine size + + + urn:samm:io.catenax.vehicle.product_description:3.0.0#size + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Engine size + + + + + en + size + + + cubicCentimetre + INTEGER_MEASURE + + + en + Cubic capacity in a combustion engine - not available in battery-electric vehicles + + + + + + + + + power + + + en + Engine power + + + urn:samm:io.catenax.vehicle.product_description:3.0.0#power + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Engine power + + + + + en + power + + + kilowatt + INTEGER_MEASURE + + + en + Engine power is the power that an engine can put out + + + + + + + + + engineProductionDate + + + en + Engine production date + + + urn:samm:io.catenax.vehicle.product_description:3.0.0#engineProductionDate + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Engine production date + + + + + en + engineProductionDate + + + STRING + + + en + Date when the engine was produced + + + + + + + + + installDate + + + en + Engine install date + + + urn:samm:io.catenax.vehicle.product_description:3.0.0#installDate + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Engine install date + + + + + en + installDate + + + STRING + + + en + Date when the engine was installed + + + + + + + + + engines + + + en + Engines + + + urn:samm:io.catenax.vehicle.product_description:3.0.0#engines + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Engines + + + + + en + engines + + + STRING + + + en + List of installed engines in the vehicle. + + + + + + + + + kbaFuelType + + + en + Fuel type(KBA) + + + urn:samm:io.catenax.vehicle.product_description:3.0.0#kbaFuelType + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Fuel type(KBA) + + + + + en + kbaFuelType + + + STRING + + + en + Description of the fuel according german KBA + + + + + + Unbekannt + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#FuelKBA:Unbekannt + + + + + + Diesel + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#FuelKBA:Diesel + + + + + + Benzin + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#FuelKBA:Benzin + + + + + + Vielstoff + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#FuelKBA:Vielstoff + + + + + + Elektro + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#FuelKBA:Elektro + + + + + + Benzin/Fl?ssiggas + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#FuelKBA:Benzin/Fl?ssiggas + + + + + + Benzin/komp.Erdgas + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#FuelKBA:Benzin/komp.Erdgas + + + + + + Hybr.Benzin/E + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#FuelKBA:Hybr.Benzin/E + + + + + + Erdgas NG + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#FuelKBA:Erdgas NG + + + + + + Hybr.Diesel/E + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#FuelKBA:Hybr.Diesel/E + + + + + + Wasserstoff + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#FuelKBA:Wasserstoff + + + + + + Hybr.Wasserst./E + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#FuelKBA:Hybr.Wasserst./E + + + + + + Wasserstoff/Benzin + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#FuelKBA:Wasserstoff/Benzin + + + + + + Wasserst./Benzin/E + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#FuelKBA:Wasserst./Benzin/E + + + + + + BZ/Wasserstoff + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#FuelKBA:BZ/Wasserstoff + + + + + + BZ/Benzin + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#FuelKBA:BZ/Benzin + + + + + + BZ/Methanol + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#FuelKBA:BZ/Methanol + + + + + + BZ/Ethanol + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#FuelKBA:BZ/Ethanol + + + + + + Hybr.Vielstoff/E + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#FuelKBA:Hybr.Vielstoff/E + + + + + + Methan + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#FuelKBA:Methan + + + + + + Benzin/Methan + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#FuelKBA:Benzin/Methan + + + + + + Hybr.Erdgas/E + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#FuelKBA:Hybr.Erdgas/E + + + + + + Benzin/Ethanol + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#FuelKBA:Benzin/Ethanol + + + + + + Hybr.B/E ext.aufl. + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#FuelKBA:Hybr.B/E ext.aufl. + + + + + + Hybr.D/E ext.aufl. + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#FuelKBA:Hybr.D/E ext.aufl. + + + + + + Hybr.LPG/E ext.aufl. + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#FuelKBA:Hybr.LPG/E ext.aufl. + + + + + + Hybr.W/E ext.aufl. + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#FuelKBA:Hybr.W/E ext.aufl. + + + + + + Hybr.V/E ext.aufl. + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#FuelKBA:Hybr.V/E ext.aufl. + + + + + + Hybr.NG/E ext.aufl. + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#FuelKBA:Hybr.NG/E ext.aufl. + + + + + + Hybr.Wod.B/Eext.aufl + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#FuelKBA:Hybr.Wod.B/Eext.aufl + + + + + + Wasserstoff/NG + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#FuelKBA:Wasserstoff/NG + + + + + + Hybr.W/NG/E ext.aufl + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#FuelKBA:Hybr.W/NG/E ext.aufl + + + + + + Ethanol + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#FuelKBA:Ethanol + + + + + + Hybr.BZ/W/E + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#FuelKBA:Hybr.BZ/W/E + + + + + + Hybr.BZ/W/E ext. aufl. + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#FuelKBA:Hybr.BZ/W/E ext. aufl. + + + + + + Zweistoff LNG/Diesel + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#FuelKBA:Zweistoff LNG/Diesel + + + + + + Andere + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#FuelKBA:Andere + + + + + + Fluessiggas + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#FuelKBA:Fluessiggas + + + + + + Hybr.Fluessiggas/E + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#FuelKBA:Hybr.Fluessiggas/E + + + + + + Verfluessigtes Erdgas(LNG) + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#FuelKBA:Verfluessigtes Erdgas(LNG) + + + + + + + + + + + + + nhtsaFuelType + + + en + Fuel type(NHTSA) + + + urn:samm:io.catenax.vehicle.product_description:3.0.0#nhtsaFuelType + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Fuel type(NHTSA) + + + + + en + nhtsaFuelType + + + STRING + + + en + Description of the fuel according US NHTSA + + + + + + Compressed Hydrogen/Hydrogen + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#FuelNHTSA:Compressed Hydrogen/Hydrogen + + + + + + Compressed Natural Gas(CNG) + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#FuelNHTSA:Compressed Natural Gas(CNG) + + + + + + Diesel + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#FuelNHTSA:Diesel + + + + + + Electric + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#FuelNHTSA:Electric + + + + + + Ethanol(E85) + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#FuelNHTSA:Ethanol(E85) + + + + + + Flexible Fuel Vehicle(FFV) + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#FuelNHTSA:Flexible Fuel Vehicle(FFV) + + + + + + Fuel Cell + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#FuelNHTSA:Fuel Cell + + + + + + Gasoline + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#FuelNHTSA:Gasoline + + + + + + Liquefied Natural Gas(LNG) + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#FuelNHTSA:Liquefied Natural Gas(LNG) + + + + + + Liquefied Petroleum Gas(propane or LPG) + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#FuelNHTSA:Liquefied Petroleum Gas(propane or LPG) + + + + + + Methanol(M85) + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#FuelNHTSA:Methanol(M85) + + + + + + Natural Gas + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#FuelNHTSA:Natural Gas + + + + + + Neat Ethanol(E100) + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#FuelNHTSA:Neat Ethanol(E100) + + + + + + Neat Methanol(M100) + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#FuelNHTSA:Neat Methanol(M100) + + + + + + Unknown + + ModelReference + + + DataElement + urn:samm:io.catenax.vehicle.product_description:3.0.0#FuelNHTSA:Unknown + + + + + + + + + + + + + fuel + + + en + Fuel + + + urn:samm:io.catenax.vehicle.product_description:3.0.0#fuel + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Fuel + + + + + en + fuel + + + STRING + + + en + The fuel type of the vehicle. + + + + + + + + + vehicle + + + en + Vehicle + + + urn:samm:io.catenax.vehicle.product_description:3.0.0#vehicle + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Vehicle + + + + + en + vehicle + + + STRING + + + en + A vehicle can be a car, bus, truck... + + + + + + + + + diff --git a/io.catenax.vehicle.product_description/3.0.0/gen/ProductDescription-schema.json b/io.catenax.vehicle.product_description/3.0.0/gen/ProductDescription-schema.json new file mode 100644 index 00000000..908e3829 --- /dev/null +++ b/io.catenax.vehicle.product_description/3.0.0/gen/ProductDescription-schema.json @@ -0,0 +1,353 @@ +{ + "$schema" : "http://json-schema.org/draft-04/schema", + "description" : "Master data of one vehicle - from an end customer view. So this model represents the vehicle as it was sold to the customer. All entities and properties are immutable over the lifetime of the vehicle.", + "type" : "object", + "components" : { + "schemas" : { + "urn_samm_io.catenax.vehicle.product_description_3.0.0_UniqueID" : { + "type" : "string", + "description" : "Characteristic for a unique id: every linked property to this characteristic is a unique ID." + }, + "urn_samm_io.catenax.vehicle.product_description_3.0.0_CatenaXIdTrait" : { + "type" : "string", + "description" : "The provided regular expression ensures that the UUID is composed of five groups of characters separated by hyphens, in the form 8-4-4-4-12 for a total of 36 characters (32 hexadecimal characters and 4 hyphens), prefixed by \"urn:uuid:\" to make it an IRI.", + "pattern" : "(^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$)|(^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$)" + }, + "urn_samm_org.eclipse.esmf.samm_characteristic_2.1.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_samm_io.catenax.vehicle.product_description_3.0.0_VehicleSteeringPos" : { + "type" : "string", + "description" : "Vehicle steering position enumeration from NHTSA, see table [vPICList_lite].[dbo].[Steering]", + "enum" : [ "Left-Hand Drive", "Right-Hand Drive" ] + }, + "urn_samm_io.catenax.vehicle.product_description_3.0.0_Weight" : { + "type" : "number", + "description" : "Weight of an object." + }, + "urn_samm_io.catenax.vehicle.product_description_3.0.0_DriveTypeNHTSA" : { + "type" : "string", + "description" : "Enumeration of drive type according NHTSA, table [vPICList_lite].[dbo].[DriveType]", + "enum" : [ "All-Wheel Drive", "Front-Wheel Drive", "Rear-Wheel Drive" ] + }, + "urn_samm_io.catenax.vehicle.product_description_3.0.0_EnginePower" : { + "type" : "number", + "description" : "Engine power expressed in kilowatt." + }, + "urn_samm_io.catenax.vehicle.product_description_3.0.0_Hybridization" : { + "type" : "string", + "description" : "Enumeration of possible hybridization values", + "enum" : [ "battery electric vehicle", "hybrid electric vehicle", "no hybrid", "plugin hybrid electric vehicle", "range extender" ] + }, + "urn_samm_io.catenax.vehicle.product_description_3.0.0_OemShortNameTrait" : { + "type" : "string", + "description" : "Restricts the length of wmiCode to exactly 3 chars", + "maxLength" : 3, + "minLength" : 3 + }, + "urn_samm_io.catenax.vehicle.product_description_3.0.0_OEMCharacteristic" : { + "description" : "OEM characteristic describes an original eequipment manufacturer(OEM).", + "type" : "object", + "properties" : { + "wmiCode" : { + "description" : "Short name/code of vehicle manufacturer according to world manufacturer information(wmi). The wmiCode are the first 3 chars of the vehicle identification number.\nA list of in NHTSA registered wmiCodes can be found in attribute Wmi in table [vPICList_lite].[dbo].[Wmi] ", + "$ref" : "#/components/schemas/urn_samm_io.catenax.vehicle.product_description_3.0.0_OemShortNameTrait" + }, + "wmiDescription" : { + "description" : "Name of OEM according NHTSA or other authorities. Has to be compliant with/linked wmiCode attribute.\nFor NHTSA: name of table [vPICList_lite].[dbo].[Manufacturer]", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "cxBPN" : { + "description" : "Catena-X business partner number of this company.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + } + }, + "required" : [ "wmiCode", "wmiDescription", "cxBPN" ] + }, + "urn_samm_io.catenax.vehicle.product_description_3.0.0_PositiveNumber" : { + "type" : "number", + "minimum" : 1 + }, + "urn_samm_io.catenax.vehicle.product_description_3.0.0_KbaVariant" : { + "type" : "string", + "description" : "Current version of the Enumeration is sub-set of list defined from the German Federal Office for motor vehicles. ", + "enum" : [ "Limousine", "Kombilimousine", "Kabrio-Limousine", "Cabrio-Limousine", "Mehrzweckfahrzeug", "Pkw-Pick-up", "Van", "Pick-up", "Coupe", "Schraeghecklimousine" ] + }, + "urn_samm_io.catenax.vehicle.product_description_3.0.0_NhtsaVariant" : { + "type" : "string", + "description" : "Enumeration comming from NHTSA offline database vpic, table [vPICList_lite].[dbo].[BodyStyle]", + "enum" : [ "Cargo Van", "Convertible", "Cabriolet", "Coupe", "Crossover Utility Vehicle(CUV)", "Hatchback", "Liftback", "Notchback", "Limousine", "Low Speed Vehicle(LSV)", "Neighborhood Electric Vehicle(NEV)", "Minivan", "Pickup", "Roadster", "Sedan", "Saloon", "Sport Utility Truck(SUT)", "Sport Utility Vehicle(SUV)", "Multi-Purpose Vehicle(MPV)", "Van", "Wagon" ] + }, + "urn_samm_io.catenax.vehicle.product_description_3.0.0_BodyCharacteristic" : { + "description" : "Bundles all body-related information.", + "type" : "object", + "properties" : { + "numberOfDoors" : { + "description" : "Describes the number of doors of a vehicle.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.vehicle.product_description_3.0.0_PositiveNumber" + }, + "colorId" : { + "description" : "Colour code describes the code of a specific colour of a vehicle.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "colorDescription" : { + "description" : "Colour name describes the colour of the colour code as a written word.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "kbaBody" : { + "description" : "Vehicle variant - Body shapes according German KBA", + "$ref" : "#/components/schemas/urn_samm_io.catenax.vehicle.product_description_3.0.0_KbaVariant" + }, + "nhtsaBody" : { + "description" : "Vehicle variant - Body shapes according US NHTSA", + "$ref" : "#/components/schemas/urn_samm_io.catenax.vehicle.product_description_3.0.0_NhtsaVariant" + } + }, + "required" : [ "numberOfDoors", "colorId", "colorDescription" ] + }, + "urn_samm_io.catenax.vehicle.product_description_3.0.0_Equipment" : { + "description" : "One equipment of the vehicle.", + "type" : "object", + "properties" : { + "equipmentIdentifier" : { + "description" : "The identifier of a specific equipment.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "equipmentDescription" : { + "description" : "The equipment variants description.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "group" : { + "description" : "Bundels all equipment-oriented information into categories like Interior", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + } + }, + "required" : [ "equipmentIdentifier", "equipmentDescription", "group" ] + }, + "urn_samm_io.catenax.vehicle.product_description_3.0.0_Equipments" : { + "description" : "List of equipments installed in the vehicle.", + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/urn_samm_io.catenax.vehicle.product_description_3.0.0_Equipment" + } + }, + "urn_samm_org.eclipse.esmf.samm_characteristic_2.1.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_samm_io.catenax.vehicle.product_description_3.0.0_ProductionCharacteristic" : { + "description" : "Production Characteristic", + "type" : "object", + "properties" : { + "productionDate" : { + "description" : "Production date of the vehicle", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Timestamp" + }, + "plantIdentifier" : { + "description" : "Plant id of the final assembly of the vehicle", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "plantDescription" : { + "description" : "Long name of the production plant of the vehicle", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + } + }, + "required" : [ "productionDate", "plantIdentifier", "plantDescription" ] + }, + "urn_samm_io.catenax.vehicle.product_description_3.0.0_CountryCodeTrait" : { + "type" : "string", + "description" : "Regular Expression that ensures a three-letter code ", + "pattern" : "^[A-Z][A-Z][A-Z]$" + }, + "urn_samm_io.catenax.vehicle.product_description_3.0.0_SaleCharacteristic" : { + "description" : "Characteristic for sale-oriented information.", + "type" : "object", + "properties" : { + "soldDate" : { + "description" : "Sold date of the vehicle = warranty start date for this vehicle", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Timestamp" + }, + "countryCode" : { + "description" : "Vehicle sold country in ISO 8601 alpha 3", + "$ref" : "#/components/schemas/urn_samm_io.catenax.vehicle.product_description_3.0.0_CountryCodeTrait" + }, + "countryGroup" : { + "description" : "Region where this car was sold", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + } + }, + "required" : [ "soldDate", "countryCode", "countryGroup" ] + }, + "urn_samm_io.catenax.vehicle.product_description_3.0.0_CubicCapacity" : { + "type" : "number", + "description" : "Cubic capacity of the engine" + }, + "urn_samm_io.catenax.vehicle.product_description_3.0.0_Engine" : { + "description" : "Describing one installed engine", + "type" : "object", + "properties" : { + "engineId" : { + "description" : "OEM-specific identifier/type of the installed engine", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "engineDescription" : { + "description" : "Description of the engine", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "engineSeries" : { + "description" : "Engine series as defined by OEM", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "serialNumber" : { + "description" : "Serial number of the installed engine", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "size" : { + "description" : "Cubic capacity in a combustion engine - not available in battery-electric vehicles", + "$ref" : "#/components/schemas/urn_samm_io.catenax.vehicle.product_description_3.0.0_CubicCapacity" + }, + "power" : { + "description" : "Engine power is the power that an engine can put out", + "$ref" : "#/components/schemas/urn_samm_io.catenax.vehicle.product_description_3.0.0_EnginePower" + }, + "engineProductionDate" : { + "description" : "Date when the engine was produced", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Timestamp" + }, + "installDate" : { + "description" : "Date when the engine was installed", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Timestamp" + } + }, + "required" : [ "engineId", "engineDescription", "engineSeries", "serialNumber", "power" ] + }, + "urn_samm_io.catenax.vehicle.product_description_3.0.0_Engines" : { + "description" : "A list of all installed engines in the vehicle", + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/urn_samm_io.catenax.vehicle.product_description_3.0.0_Engine" + } + }, + "urn_samm_io.catenax.vehicle.product_description_3.0.0_FuelKBA" : { + "type" : "string", + "description" : "Enumeration of possible fuel types of a vehicle according german KBA", + "enum" : [ "Unbekannt", "Diesel", "Benzin", "Vielstoff", "Elektro", "Benzin/Fl?ssiggas", "Benzin/komp.Erdgas", "Hybr.Benzin/E", "Erdgas NG", "Hybr.Diesel/E", "Wasserstoff", "Hybr.Wasserst./E", "Wasserstoff/Benzin", "Wasserst./Benzin/E", "BZ/Wasserstoff", "BZ/Benzin", "BZ/Methanol", "BZ/Ethanol", "Hybr.Vielstoff/E", "Methan", "Benzin/Methan", "Hybr.Erdgas/E", "Benzin/Ethanol", "Hybr.B/E ext.aufl.", "Hybr.D/E ext.aufl.", "Hybr.LPG/E ext.aufl.", "Hybr.W/E ext.aufl.", "Hybr.V/E ext.aufl.", "Hybr.NG/E ext.aufl.", "Hybr.Wod.B/Eext.aufl", "Wasserstoff/NG", "Hybr.W/NG/E ext.aufl", "Ethanol", "Hybr.BZ/W/E", "Hybr.BZ/W/E ext. aufl.", "Zweistoff LNG/Diesel", "Andere", "Fluessiggas", "Hybr.Fluessiggas/E", "Verfluessigtes Erdgas(LNG)" ] + }, + "urn_samm_io.catenax.vehicle.product_description_3.0.0_FuelNHTSA" : { + "type" : "string", + "description" : "Enumeration from NHTSA vpic database, table [vPICList_lite].[dbo].[FuelType]", + "enum" : [ "Compressed Hydrogen/Hydrogen", "Compressed Natural Gas(CNG)", "Diesel", "Electric", "Ethanol(E85)", "Flexible Fuel Vehicle(FFV)", "Fuel Cell", "Gasoline", "Liquefied Natural Gas(LNG)", "Liquefied Petroleum Gas(propane or LPG)", "Methanol(M85)", "Natural Gas", "Neat Ethanol(E100)", "Neat Methanol(M100)", "Unknown" ] + }, + "urn_samm_io.catenax.vehicle.product_description_3.0.0_FuelCharacteristic" : { + "description" : "Characteristic for the fuel used in the vehicle.", + "type" : "object", + "properties" : { + "kbaFuelType" : { + "description" : "Description of the fuel according german KBA", + "$ref" : "#/components/schemas/urn_samm_io.catenax.vehicle.product_description_3.0.0_FuelKBA" + }, + "nhtsaFuelType" : { + "description" : "Description of the fuel according US NHTSA", + "$ref" : "#/components/schemas/urn_samm_io.catenax.vehicle.product_description_3.0.0_FuelNHTSA" + } + } + }, + "urn_samm_io.catenax.vehicle.product_description_3.0.0_VehicleCharacteristic" : { + "description" : "This chracteristic bundles all general vehicle data.", + "type" : "object", + "properties" : { + "anonymizedVin" : { + "description" : "OEM-specific hashed VIN; link to car data over pseydomized/hashed VIN or Catena-X unique digital twin identifier.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.vehicle.product_description_3.0.0_UniqueID" + }, + "catenaXId" : { + "description" : "A fully anonymous Catena-X identifier that is registered in C-X Digital twin registry. Can be used for vehicles, parts, workshops, .....", + "$ref" : "#/components/schemas/urn_samm_io.catenax.vehicle.product_description_3.0.0_CatenaXIdTrait" + }, + "vehicleSeries" : { + "description" : "vehicle series, normally one level above model. E.g. vehicle series =\"Golf\", vehicle model=\"Golf VIII\"", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "modelDescription" : { + "description" : "Detail vehicle model like \"Golf VIII\"", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "modelIdentifier" : { + "description" : "OEM-specific model identifier or OEM-specific project name.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "class" : { + "description" : "Class of the vehicle.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "steeringPos" : { + "description" : "Position of vehicle steering wheel, Left or right.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.vehicle.product_description_3.0.0_VehicleSteeringPos" + }, + "emptyWeight" : { + "description" : "The empty weight of the vehicle in kg as specified.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.vehicle.product_description_3.0.0_Weight" + }, + "driveType" : { + "description" : "Drive type of a vehicle according enumeration.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.vehicle.product_description_3.0.0_DriveTypeNHTSA" + }, + "systemPower" : { + "description" : "Complete power of this vehicle in KW.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.vehicle.product_description_3.0.0_EnginePower" + }, + "hybridizationType" : { + "description" : "Degree of hybridization in this vehicle.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.vehicle.product_description_3.0.0_Hybridization" + }, + "softwareCategory" : { + "description" : "Some OEMs bring in the software as complete package for all systems:\nTo identify this software: software category and software version is needed.\nSoftware category when this car was built.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "softwareVersion" : { + "description" : "Some OEMs brings in the software as complete package for all systems:\nTo identify this software: software category and software version is needed.\nSoftware version when this car was built\n.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "oem" : { + "description" : "Original equipment manufacturer.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.vehicle.product_description_3.0.0_OEMCharacteristic" + }, + "body" : { + "description" : "Vehicle body.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.vehicle.product_description_3.0.0_BodyCharacteristic" + }, + "equipments" : { + "description" : "Equipments.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.vehicle.product_description_3.0.0_Equipments" + }, + "production" : { + "description" : "This property bundles production-related information.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.vehicle.product_description_3.0.0_ProductionCharacteristic" + }, + "sale" : { + "description" : "This property bundles all sales related information.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.vehicle.product_description_3.0.0_SaleCharacteristic" + }, + "engines" : { + "description" : "List of installed engines in the vehicle.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.vehicle.product_description_3.0.0_Engines" + }, + "fuel" : { + "description" : "The fuel type of the vehicle.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.vehicle.product_description_3.0.0_FuelCharacteristic" + } + }, + "required" : [ "anonymizedVin", "vehicleSeries", "modelDescription", "modelIdentifier", "class", "steeringPos", "emptyWeight", "driveType", "systemPower", "oem", "body", "equipments", "production", "sale", "engines", "fuel" ] + } + } + }, + "properties" : { + "vehicle" : { + "description" : "A vehicle can be a car, bus, truck...", + "$ref" : "#/components/schemas/urn_samm_io.catenax.vehicle.product_description_3.0.0_VehicleCharacteristic" + } + }, + "required" : [ "vehicle" ] +} \ No newline at end of file diff --git a/io.catenax.vehicle.product_description/3.0.0/gen/ProductDescription.aasx b/io.catenax.vehicle.product_description/3.0.0/gen/ProductDescription.aasx new file mode 100644 index 0000000000000000000000000000000000000000..2250edd32a737ff674142ce714a5d5cf3f624de1 GIT binary patch literal 10571 zcmaKy1yo$kvbJ$|cXxMpNN{&|2(G~;NN@}8n&3J}kip$ONU-2Gxa)=Q{O6wUp8woi zvu3Z^Yj^ja{dRR%)y$(J4+(_@1_uWRrfB?42kdW#`Sw{~(#g@?($U>m!`s=?&5*^* z!9G@X+_skuDFD0ZNG2P^HXyUy8xW_Dx(W#=t*C(cTSrfJJwPtAR}1gTETMz+An6Fi zg|aJ^;g5v8l7@|kz|th*j_e0okEUf~!qX!%%ZHiht6iOYbfe%YM_v(QP0X#bT$qh8 z7?2YGCOJkKmD*AdzltshK-IkdWQZgoj*ua2qTV?J-U-Xjn)YJ93RcYJ6<%n!r2eT! zA$q=cjEjlr#D7ze`ipng+zy7cDvWP$sNElfiW7CzB!Bt9uM$a%T=}Rb9_c%f(jYyl z+|-hYB~OGGJ7;qqTuy9y#?1cN%#(#Kp4OZ~duy|nYWuXjr6({Id04o)Ekd;GH%%77 z!QRgQH`Nf|S{S=p+Pkr`ydQHC#+7>6&_a#-FIHVJ$8 zn`89Si7m`Bq12l7U^L18RS4n&ckb)(-9Cm|GWqeD&iej2BE70Eh$b!cr%rx5a^cv% zf%(>F7ktx#l)&v_>D6_RyG9LvqC$TRGV#OcsWG=qJT{j`v)Ts=$gz2~11uR9z4buw zccthb&Ir%nbO8RJN};{AFg11aVtqd_JGt6e+c;j1G0KiJ4v$UBj}4b;$c!`7mCZr^ zr9Od-NjlD353INM|E@maKgayX6#Q-Ezh*--zT2^v3{5H!8bmA^yrYxi;+W!7HG`_t zJkURNsj(s89W|1*ael(ls5uo7}t+@l|bqm%<9K26=(-`}$UGK?c@HoL-8qe5gg zYo3^;g{}mJE-=@BiW$QBrFWU7cC5Ahtu2|JXD@dou5lPp8gmkaSXTclgy9w6*&+(n z34CyL_zG88#(bjv*q3NWMrm{n$%xSHc8xrOF!gKs*VG>dQ7LAi<&_xi;!dsoTV^>U z`cOxCgl~C+FrAFU8APStYT>YZr0+7zBKEP4yge}O|0(mkV1LQ{wsu*~|FN9k*D=V@ z!R+_m%(7|)P>U4B?U`H4-RY9FpKZtU+DG|M zw-R#~jEHxNkVJ0oaOL*`r4XmKmUnj?Y zum%tVNq{dkk7q-gK4b&xRr*4OcGd$c)W0_9QD4Q0k7Ap1&JYfqMpm&6WsL?AY2>ZG zr4tXIvSgsA4Ti$_fv;Eb?Wr5kNEqF!(Vl3m$j&3;xST~=y*O5KaPjsOLNX%Cdnl+G4oPJM#VxggNT*7KN3y2TK2P_K zCueG~h9kzRWTcmJbvZ71B9iEIa$9p#vfmhLL=ecIk+Enw$Hxya^dNb0t#|^1{4LmX zwTO0$@RjA}{w&E@w9&=0y@>M4eq44h?3Kz2i=L625zASNTravR(LPESUNoJslI_Gi z`gZt1s=qVBAk$h!s`g=0+#e@RHfeh6+7P`-zz>n$c%bdOtD%*KJ}ryz!vOYFcN>w` zZi7SK50W|J->lvYdnAcc+?CU{Y>3r2BJL4PH5_&Sj->nA%3?c^7iw_i89Jjvu>(@X=^bHT^4_u0}X=NtwT93+G>&?<}ghb{py% z7ZnU_r%zpBbbPN4C7YJebZH|hAvUuGIuw#vcrF(fsm&02vs?_EDN*G26ZV#A-DKtK`Kei$s_GkEa#_*o8r&9P%aRj@O zl%KmClaFt-VCJct`AG!|v0blaFRf zPfy@QPIeAQ_!Q;yR?6oRJv7*qM=Qh(eNf} zD=WvUdAdrhr|L3xtWjO|5#GIsiCR${J!ziJ$^6z--{eSDf@34yBsP8C%SFZiibkxO zu31V7C^th^ML9}w4^O4K-Gr{tOrNb2R*J$UW15@_$ZFBF?W8sMgRkv9vcv=Yx%6EN zF>$uH1Tzrq8CWtZx?!HU<5T&ulIfQ!21CNdNvfSzc^#` zA@rIf&kfgFye3{Na|z!0{)BCSK)!u|J3fnFjGvIJj9(-O$= zM+$46rA7)1GHej)%}A~fI9sZ@n5n`?X@*Z4hXPuRAbJ!rdIWIyn*ZT^1zDhQtczD{%`QgC}%MS-Crul9c;gRpb zH`Ag?Zl2huN@y)F8{JK)yCFv}&F)2>(ZELI(*|9149&*fK3ej`QDyBHFMO#Vra(rI zM30oAWhL!YtmTn8?1f4-7C=&)?C{}}rc&AUR3fJ)Ns$*)a95iJ zzgEqq=1Xek3AmO?;K~=gwOo}Otd;FV1SWp|m`l9VhMfIlJJ-C&YQ#k@2rsX*&`|zTP1Y3#Y zN=Y*`S9de1H$Q4_Q*X~AK*KD#gQrFZD~**-v^PnPfi+4eQOr#D&@u|TAlgK{6pLcn z=ySssdPJi2)do*XdTNEDwjeR)if4;F!|ik{y-I?$@aQvN!ubuKNItb4}GQCl~X?_TSm=k*tl_FvDHs z==;)IOC;Orx%SW*Yc665l_B*214v&w)&_0fJPPglfXJt!=cnxj0orS3YBrFwhO+G7 zAb+4?h)9ig1a?|}c;ZLUeg_%sC&WfFSbKC#iOxqvULazGVP=>|NgjbsNkFUYtitk4 zhXU+qKo{qh=lbD1elCrUkoa^|4nSM+!ggdeK&|8gHIfTy6o~ueSsF!LX`)YbbZ@cM z%FeK`aUz%8qj&nS1=Cj+W-S~)=Yyhh3Tjv=_3CKSfhzG)cq)FOh?d1G)_0F$EfCF| zV?lL$7|Uq$cJmGlbQ1>pHNSY>?w#$r3ZYcU$5|_nREaj(H5s^!lqVFImlT5zSmck- z`BG#)SHf8iS=*_re@!3DJ!iB6NSL0*g4g+?Fs*VbKRAX1gwz5^?>DEri9) z!=9k86D*M4bFJKbott`?P+=+mhTXuS(^fy4_yKJKvN}+S4zRx@w9U*&7E9^kZ+X@v z(8>j%Xx+Ex-^VZ-cOTqd)+=LQPLTc6^3Ymv@bVSYQ4y+Z)mBH{{5~&y$xRChfwR;ozcp#-A<3cy?-j6u?KRlLd7hb<4gZlhtv--c$IhmGsj@`y9IhWh-T@k$Q; zF{M4t(t_sg%;4k=wi2Wa;#_g^B$&B{7AnX&a*8o?ZTlURvKgx3S_IF{a#19hX)H%d z)3cRf_LXuEuv!UW?zoI}tts(6u7a9Y((L^PIJ&(I9qdhB|DB2vY`(B0(G(0Gwe7~P zucb;xV>cr^6Iy=wz0czzogZZq7!yVV4Qv?PfJ$m{d^$ULIPsS=1!W;n8V(OmgEDaY z;q**$QK%+g(ndQksr>q|26I2)g``OH;3VbemHa?=n^q}4sjs1P-Zusp$H`GA{XJx? zPFt@lxENlv6s{uFiQ}j14+ts>#k;q(i#w*9plkV`If>_V9lh%xqC6TETuj5_^Ir+0r4Q4DQ(WJxRKc*+i{VwqS1132F!PeY@@W zjoGaloWC1ZCKgz=nKBxs&vOjXE=yf4{w8*mVs2#YS*UQ*8S*e#EX*ainzBUa>s{_r zJ!zm)K$>N*@mmsmeI37nAGd=~HMcuqhhD`w#En$|JpdjfsXNU>7~X@Y0e&3sG(`(u zi}Kk8NFh?(#PBdwtPB-&(V2X4x=3)||MgWX@k{0%M)3;P!@sb2FceY!6p%%MJx!efwZBs@)KcW zp!G%>*p2j^9VCQnUNA4#M)x2BEA@7+azu=*ReJUyvLvHbV!7QJgafPtE90`2!#eg? zhPdZ%cU4?q62^~^>bt`Np}$1;4w{V6%wA(0hsJOX{n93IU!vQ-*h9=Z*k%alZuj~s z7(QQ+J^)$^<#w^~vi;FWeT`bKyl)w(56T2nYm@l(Q8wmv9BNernxe7NhIqu<(6=Vk zQFX7VM;x}eLRk;Zn0^;5;420}RB|+8F~PVQ<#0R#j*=pn^3!m#2KF@xEtb$i?ld)A ze~T4Eb5}^-6l?b@R(9S?^qKQkXj2o0{mMwipRSnMfNp2l*G$27aI3M^#wzE#Dba3B zfiY^<#y&IZ%A&QcZ;4L(1AkF6L$X*hy)&NovuN~uPq~Qark4bVf!xi!X0xceq(vu# z#%EBD2`^4K)1@|47)va}l<>QLN<}(>1x^ziLK65iWo``3eH+Y+QOhPNdt z3EtT(LcBQ~3mB9&eekJ$DK4|K;0yAz@=T?eP{#v;{jsI14B(#&Svmm7Fvww` z$x2TaT;`2blI)Monxv*nQA)K(nB6Q1^6`q4+vUi$_Mze{!KP0>?JiDR_ZHs9&B7Xve$-tNIM@8Qix@M!`eme!vw5`EhvW zab0;JWz3_FcLKl+gPaOdZe)Aey$v)vJ!}Cp|{kX ztq(0@L|wu&SPMCw%6td~GC1Le-?U2R(-P8yjA8ReIK-XA!xI} zb5M00xZC2h#eS<>ILwd$aO`-&q2xnv3x+7T5-Xe`;u$||jury%Yo#)P8eN{l=M#mt zYeG>xRR38NYGm=SzMPQ%CT?<@xasdWqY__SQK4F|*g-`;5B$7G-H#(z=3UcKcTSu#J5T*20+aZ>`M8< zNYA)ztF4Cdl_BhzlREyo09;vZUsfndLDsLbE9nWWc>7ba#anG-h0h^-Gz#LD(>D)= zAN~Wm3ppnJrg~;Ppj5r?DE>gDhh*%dLp`~p%896p$PSxT+D`*B+VnqVq|JTfey$+S zy6Z-VvcWP=OhJpN-Hy%p?GkVd#zrYrSok9{rm>jT-1vYGv(O%wqgJ$!7NO^n*5;nz_7vbj<`p>E5r zCe42LhqzPiE~VX~&Yi>ZW|PM}(is3zprngbyyo-zy~MDc!9plDTKC;UR_)P zy^yD{VBAHdTKu=L^@;QFLqU{PV2m^k@|X2eMfMDbx3WJn_tUU7sK>y>8q!H7j^;In zX&f!^L>O7^9*HUcJpcTyW9d0`cX7`zQg-D+;_pD7Bm;pGA$sx)Z87alM!X$jSi0Nk zWWfeGQfuv)mayYv@3dxKMu%i{pK55tWa8xZx9uRMT>`Eg?M8Zsn}0*Yhm=){_v!Bb zq#zbR8Z{g0<;oLWl&GZZMMBhd9(Iy3zG63u1R{+Zpt@8YBLHZ-KrF#7z3smrmufKl z-<)RJpZcjFyc4w%0(UqgE|uc(d|NsONEa~0#e@X2v4ix*B?+q6z#>I?l>Z0zm;2xi zc%LnJkG=u~vq=ST1!5t*!6D)ye1C6GH2t8l&hM68B%ZK#X%9jVeV*vGtHeM6jd?UL z&4}@CU^#NNy%??6XL+2HTkZ^zakf`P_+7C|m`F`h!=+#)wxbste-GsnW$SJPzIn2e z!wrU`6R0ebI!Gqlgb$i$$)7!fg%iS?$oPd&uUTM`b!#EER!h&TLrW_gF_8$Aaam|C zp*=&{PQG{VnMi=3-*?+51_pRR0c^j)pJ&4A>(isxnF>DgozSVSx?ak8qVQ|8Kc9vD zUEs>uZuS)YSzx=`9?aV-UWHI_kB|1U9>_iRkh+HyA#rY%r0gGB3mK{bjv?6~a(}12 zjAoIXE}l`v`Z5>*;KuPxw&S8c64l<8k5{u_^VcdeOLsGwtq9|_orUv0$E3LsdeNjv zV_B#8w?RMdr>8s2gbH0(Vwfg-6 z(-ck5U|CNjzzhx@vP#)MF2mD|*^1dvF*ja=4#5q~?6{23&8R)jt&rA$HfA7LfV~W@ zj)(NVAG_&EFgxNoEc>;gfMQoOA^28iYJV?yTI?azqvP8TjDKPkd$B5_$}3wig)r(R zO?w=Axys?nE1NNy9{Osjn^vGnxJQacYDdZiyT7y7iOmxft8yz?wy$oWHQ_^Ia4Qtr z=8r_Rbr)j0J#Y8Vh7c;`8O4fsd&B zs9~lZ@cV=x_?46XE|I={AUeR5KPaB@&(;V^pg{}cvBuNGrKY8!&_;-yaES?PNRf>v zp#SQ#V_v$qh9CuV&r!q6swAd%FSC;(YP^GE!|uowPaO*B)j@t;HQ%?Mw8Xj zj*6Mx4MDUHf%o&sG}C`<<-Qh)-x+cPW+bZVH*yzBgx;4ZOo+Q+e?ReHYhZO^nk9)> zaFKU#%jl*}|8Dvhg`${*KxnEd->FAHA?Vj*&y+g(as12z4AggF=u?LcoxU5iCXmMF zWV-x4X`jSg2D>MHQP}IMwaoYJ7QSQhED?0~@#vQ1c>-7P=XE=UF3vG1FPMW@9vKse zE~sQ|her6Ru-qu4z$;PGM-zyfJ?yKk_~NZ^Ugy0)7PGL_K~BM$rh*2Sk8o`y+-RO? zw{MS%bxTlJDzQZRV}Tk{<*}7+tpsWdnRb)Avy+T&q~8QA&I*jrd0-qgnjqeUs+v@M zhb;zkfqG&5mbPCQv!iL^`BFW%Du68;XIY{*noaM0HX}5h+!~%<`-1Hy%V@GfB&vu? zrSJizri)7(?DDA#=c)^5E>0GEDiKmnd$&i=2V!Q-1 zjp~}lS~qX9T-yelX1Fij?;%^Al!PuvEr0*I<;KilnplrTFSamXpql7)J}b>?$@l`1NvC*jyrC#l-*sNvrU&@Lv$O}eIu2h)8$QRV6eU{Y1Q}y~H{uFda}c1g$`g|M z%{vxJMQc-Fx-huJ+1IY67q;T}Ndp6)5qoZIgQjcppQV4j-0u2a);RZ2yVZxie)bBw z3%PsC+S>1Mr3(Y zC(6R^IJ>?ShZMi{Eh@(SniZuVD78`%2^(=+jeBpVN*Yuiz9IY)&9byLRwlV=*{aNZ zM7c!Z?r%Bs_$VYrc1Cvgw!hPz?F5w+E|6wuQ<8q~UAsQf$*M#JqQH)RZ#9)?xpMU=zW$#nARGld`+hiMg`>2cb27J9JVd=tU`~Ez##uSL=uF(l_;vuAR(}F zW8WE>R0Fn^*Ue?+PC^b{RwW+Ukg3+LPAjSrj%z`GaQTAL;SIak>|8bDfb#I^WM(|NjuR1z#lY^_yZRTsUiJ;*L$7dbeL^0S1eKRfI{Xb)UPfjZ=1)f3Soj3avx^nQYNBVe70n2WQ5Njxy}pH7YMhSg!FLw*CU2A zbVR>en86%5XQvI6Aa>V zJz1oJe|m8l1V_5hG)Z=dK_|!yfxRNWdP`?~uZcx)77r(TJt2I1JSBx&tc?Q_^UcWb0~SuZP(mjw8py4~fguv%rHr>3Q?F`Sy01Ml4v zx0SZt@+7;E+9Ac`xy})-A-|fz`B|dQ@O!gV6F5a#ygh*Gyeefr7t&I+8>f53+g+7d zO}ENOiVGSce|WAikSzm3u%(VQwwmrd0-4A*N)r40Js}WtioDDb5X&!y(?D0&wWfu; zl8FS}+w(x8aQ7D+CXCn$ic`j2C7p7Rsj5?zBa~J)U}7PtpWX{T=H*K7xgCRNWNJ1F zOpP42NmbA`86bbGh6dW^YJaXxx%Ld!A?3mJL?dT|P~z?{^LY=0;w5YWDncf38n#`M znqeARzu^gn&)~zw$r!n_Qy6*~Do&tsI!q=hS&-1SP55IJK8vMbdj`vKgl_7Sin-eI z@z0BE{aS-pvy?a>8tA#)=SnRuH)A|H#j1nZo9h4lu>{|2zDw)ZI=or?^8$Z512YF~ z+=uzzw~PW?BIsgAoIhQ@9aAV^@@Jp1NqDzkGEJlgzJ{)gb}1JG&5kO6x~wL9%C$$Z z48S}~p#%(Z?JPl@*uoN&L#COY5G1FlT1Jrzm{3BaJ8Xc6zv$xP$jJ9}Pb}l}(}YJ@ zsO`}V)6`mp7wDI?HR-w>;!4c*vF%yUjYqrRMRjJYhZQUTn4}?WZ~44R{tFvTK3)m) zQu9HfGVAeHj9FL&S*3!d6#%_TzJQybN|HlE1Gvi2i5FuM7Ena;yvfk<%nyS;-nbMoNKZ4^PY_N16ex|G7)=(Z4 z#;QViofhAe|7$LUF+6crTa|^dlr;VNuU}}%bkv~)!OWLXLL#&@Tz#V>8a8eo_WyK? z9H(zG`AsegtDlGn#l$Xie~3o)vyHA3YCv|kUk3aquV&EtI7US?|7qs{CJ7fLhzDM|TS3i%> zWE+^|z7=t_L*rjX_|gWq49Pc1@A)=uQlfo&?I-$#Qhp500gYe3kqN#gSsTT^oQvkW zDXNvByr-8_2RVuz(~*h^$0DL(U)p_cPtb?v$y!jvbep~tYGB@qQ1L95(qw49dlqd( z-y`W*F^U4EO@egFU(WTB_p0X0*r#f9#2OpbqCNpI%caCPRZ#97OTBDuGMh7)_9A&i z%l*dQpeh;$z?#xnp1J=qOOfkI*QmP$|%nn~GNwN@ z_2I{QHu^(TJj>`?KKUXlDa^I;>}AvL3HLvc30{H!YSc^Ni^Yr)b79ugOuIAfjMT#8 zpG-E%(Nft2Co + + + + + + + + + + + + Documentation Vehicle master data + + +
+
+
+
+

Aspect Model Vehicle master data

+
urn:samm:io.catenax.vehicle.product_description:3.0.0#ProductDescription
+
+
+
+
+
+
+
+ +
+ + +
+ Master data of one vehicle - from an end customer view. So this model represents the vehicle as it was sold to the customer. All entities and properties are immutable over the lifetime of the vehicle. +
+ + +
+

Overview

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

Properties

+
+ +
+ +
+

Vehicle

+
+ +A vehicle can be a car, bus, truck... + +
+
Name
+
vehicle
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.vehicle.product_description:3.0.0#Vehicle + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
vehicle
+
+ + +
+
+ + + +
+
+

Entities

+
+ +
+
+

Body

+
+
+ All vhicel body-related data. +
+ +
+

Properties

+
+
+ +
+
Number of doors
+
+ +Describes the number of doors of a vehicle. + +
+
Name
+
numberOfDoors
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#positiveInteger + +
+
+
+
+
+ +
+
Example
+
5
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
numberOfDoors
+
+ + +
+
+ +
+
Color identifier
+
+ +Colour code describes the code of a specific colour of a vehicle. + +
+
Name
+
colorId
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
LY7W
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
colorId
+
+ + +
+
+ +
+
Color description
+
+ +Colour name describes the colour of the colour code as a written word. + +
+
Name
+
colorDescription
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Light grey
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
colorDescription
+
+ + +
+
+ +
+
Body variant(KBA)
+
+ +Vehicle variant - Body shapes according German KBA + +
+
Name
+
kbaBody
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • Limousine
    • +
  • Kombilimousine
    • +
  • Kabrio-Limousine
    • +
  • Cabrio-Limousine
    • +
  • Mehrzweckfahrzeug
    • +
  • Pkw-Pick-up
    • +
  • Van
    • +
  • Pick-up
    • +
  • Coupe
    • +
  • Schraeghecklimousine
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
SUV
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
kbaBody
+
+ + +
+
+ +
+
Body variant(NHTSA)
+
+ +Vehicle variant - Body shapes according US NHTSA + +
+
Name
+
nhtsaBody
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • Cargo Van
    • +
  • Convertible
    • +
  • Cabriolet
    • +
  • Coupe
    • +
  • Crossover Utility Vehicle(CUV)
    • +
  • Hatchback
    • +
  • Liftback
    • +
  • Notchback
    • +
  • Limousine
    • +
  • Low Speed Vehicle(LSV)
    • +
  • Neighborhood Electric Vehicle(NEV)
    • +
  • Minivan
    • +
  • Pickup
    • +
  • Roadster
    • +
  • Sedan
    • +
  • Saloon
    • +
  • Sport Utility Truck(SUT)
    • +
  • Sport Utility Vehicle(SUV)
    • +
  • Multi-Purpose Vehicle(MPV)
    • +
  • Van
    • +
  • Wagon
    • +
+
+
+
+
+ Reference +
+
    +
  • https://vpic.nhtsa.dot.gov/api/
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Sedan
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
nhtsaBody
+
+ + +
+
+
+
+

Engine Entity

+
+
+ Describing one installed engine +
+ +
+

Properties

+
+
+ +
+
Engine ID:
+
+ +OEM-specific identifier/type of the installed engine + +
+
Name
+
engineId
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
CKBY
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
engineId
+
+ + +
+
+ +
+
Engine Description
+
+ +Description of the engine + +
+
Name
+
engineDescription
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
2.0 TDI
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
engineDescription
+
+ + +
+
+ +
+
Vehicle engine series
+
+ +Engine series as defined by OEM + +
+
Name
+
engineSeries
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
EA189
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
engineSeries
+
+ + +
+
+ +
+
Engine serial number
+
+ +Serial number of the installed engine + +
+
Name
+
serialNumber
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
3434937GJJG3738
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
serialNumber
+
+ + +
+
+ +
+
Engine size
+
+ +Cubic capacity in a combustion engine - not available in battery-electric vehicles + +
+
Name
+
size
+
+ + + +
+
Characteristic
+
+
+
+
Measurement
+
+
+
Cubic capacity of the engine
+
+
+
Unit
+
+
+
+
    +
  • + cubic centimetre +
    • +
  • + Symbol cm³ +
    • +
  • + Code CMQ +
    • +
  • + Conversion factor 10⁻⁶ m³ +
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#integer + +
+
+
+
+
+ +
+
Example
+
1968
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
size
+
+ + +
+
+ +
+
Engine power
+
+ +Engine power is the power that an engine can put out + +
+
Name
+
power
+
+ + + +
+
Characteristic
+
+
+
+
Measurement
+
+
+
Engine power expressed in kilowatt.
+
+
+
Unit
+
+
+
+
    +
  • + kilowatt +
    • +
  • + Symbol kW +
    • +
  • + Code KWT +
    • +
  • + Conversion factor 10³ W +
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#integer + +
+
+
+
+
+ +
+
Example
+
110
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
power
+
+ + +
+
+ +
+
Engine production date
+
+ +Date when the engine was produced + +
+
Name
+
engineProductionDate
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#dateTime + +
+
+
+
+
+ +
+
Example
+
2017-10-20T00:00:00
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
engineProductionDate
+
+ + +
+
+ +
+
Engine install date
+
+ +Date when the engine was installed + +
+
Name
+
installDate
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#dateTime + +
+
+
+
+
+ +
+
Example
+
2018-01-10T00:00:00
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
installDate
+
+ + +
+
+
+
+

Equipment

+
+
+ One equipment of the vehicle. +
+ +
+

Properties

+
+
+ +
+
Equipment Id
+
+ +The identifier of a specific equipment. + +
+
Name
+
equipmentIdentifier
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
S248A
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
equipmentIdentifier
+
+ + +
+
+ +
+
Equipment description
+
+ +The equipment variants description. + +
+
Name
+
equipmentDescription
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Seat heating front
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
equipmentDescription
+
+ + +
+
+ +
+
Equipment group
+
+ +Bundels all equipment-oriented information into categories like Interior + +
+
Name
+
group
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Interior
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
group
+
+ + +
+
+
+
+

Fuel

+
+
+ Bundels all fuel-related data. +
+ +
+

Properties

+
+
+ +
+
Fuel type(KBA)
+
+ +Description of the fuel according german KBA + +
+
Name
+
kbaFuelType
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • Unbekannt
    • +
  • Diesel
    • +
  • Benzin
    • +
  • Vielstoff
    • +
  • Elektro
    • +
  • Benzin/Fl?ssiggas
    • +
  • Benzin/komp.Erdgas
    • +
  • Hybr.Benzin/E
    • +
  • Erdgas NG
    • +
  • Hybr.Diesel/E
    • +
  • Wasserstoff
    • +
  • Hybr.Wasserst./E
    • +
  • Wasserstoff/Benzin
    • +
  • Wasserst./Benzin/E
    • +
  • BZ/Wasserstoff
    • +
  • BZ/Benzin
    • +
  • BZ/Methanol
    • +
  • BZ/Ethanol
    • +
  • Hybr.Vielstoff/E
    • +
  • Methan
    • +
  • Benzin/Methan
    • +
  • Hybr.Erdgas/E
    • +
  • Benzin/Ethanol
    • +
  • Hybr.B/E ext.aufl.
    • +
  • Hybr.D/E ext.aufl.
    • +
  • Hybr.LPG/E ext.aufl.
    • +
  • Hybr.W/E ext.aufl.
    • +
  • Hybr.V/E ext.aufl.
    • +
  • Hybr.NG/E ext.aufl.
    • +
  • Hybr.Wod.B/Eext.aufl
    • +
  • Wasserstoff/NG
    • +
  • Hybr.W/NG/E ext.aufl
    • +
  • Ethanol
    • +
  • Hybr.BZ/W/E
    • +
  • Hybr.BZ/W/E ext. aufl.
    • +
  • Zweistoff LNG/Diesel
    • +
  • Andere
    • +
  • Fluessiggas
    • +
  • Hybr.Fluessiggas/E
    • +
  • Verfluessigtes Erdgas(LNG)
    • +
+
+
+
+
+ Reference +
+
    +
  • https://www.kba.de/SharedDocs/Downloads/DE/SV/sv221_m1_schad_pdf.pdf
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Diesel
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
kbaFuelType
+
+ + +
+
+ +
+
Fuel type(NHTSA)
+
+ +Description of the fuel according US NHTSA + +
+
Name
+
nhtsaFuelType
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • Compressed Hydrogen/Hydrogen
    • +
  • Compressed Natural Gas(CNG)
    • +
  • Diesel
    • +
  • Electric
    • +
  • Ethanol(E85)
    • +
  • Flexible Fuel Vehicle(FFV)
    • +
  • Fuel Cell
    • +
  • Gasoline
    • +
  • Liquefied Natural Gas(LNG)
    • +
  • Liquefied Petroleum Gas(propane or LPG)
    • +
  • Methanol(M85)
    • +
  • Natural Gas
    • +
  • Neat Ethanol(E100)
    • +
  • Neat Methanol(M100)
    • +
  • Unknown
    • +
+
+
+
+
+ Reference +
+
    +
  • https://vpic.nhtsa.dot.gov/api/
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Diesel
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
nhtsaFuelType
+
+ + +
+
+
+
+

OEM

+
+
+ Describes one original eequipment manufacturer (OEM) to which this vehicle belongs to. +
+ +
+

Properties

+
+
+ +
+
WMI Code
+
+ +Short name/code of vehicle manufacturer according to world manufacturer information(wmi). The wmiCode are the first 3 chars of the vehicle identification number. +A list of in NHTSA registered wmiCodes can be found in attribute Wmi in table [vPICList_lite].[dbo].[Wmi] + +
+
Name
+
wmiCode
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
WBA
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
wmiCode
+
+ +
+
Reference
+
+
    +
  • https://vpic.nhtsa.dot.gov/
    • +
+
+
+ +
+
Constraints
+
+
    +
  • +
    + +
    + WorldManufacturerInformationCodeLength +
    + +
    +
    Description
    +
    Restricts the length of wmiCode to exactly 3 chars
    +
    + +
    +
    Reference
    +
    +
    +
      +
    • https://vpic.nhtsa.dot.gov/
      • +
    +
    +
    +
    + +
    +
    Min. Length
    +
    3
    +
    +
    +
    Max. length
    +
    3
    +
    + +
    • +
+
+
+
+
+ +
+
OEM name
+
+ +Name of OEM according NHTSA or other authorities. Has to be compliant with/linked wmiCode attribute. +For NHTSA: name of table [vPICList_lite].[dbo].[Manufacturer] + +
+
Name
+
wmiDescription
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
BMW AG
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
wmiDescription
+
+ +
+
Reference
+
+
    +
  • https://vpic.nhtsa.dot.gov/
    • +
+
+
+ +
+
+ +
+
CX Business partner number
+
+ +Catena-X business partner number of this company. + +
+
Name
+
cxBPN
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
BPN-811
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
cxBPN
+
+ + +
+
+
+
+

Production

+
+
+ Entity to bundle all production-related data. +
+ +
+

Properties

+
+
+ +
+
Vehicle production Date
+
+ +Production date of the vehicle + +
+
Name
+
productionDate
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#dateTime + +
+
+
+
+
+ +
+
Example
+
2018-01-15T00:00:00
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
productionDate
+
+ + +
+
+ +
+
Production plant id
+
+ +Plant id of the final assembly of the vehicle + +
+
Name
+
plantIdentifier
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
4711
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
plantIdentifier
+
+ + +
+
+ +
+
Vehicle production plant name
+
+ +Long name of the production plant of the vehicle + +
+
Name
+
plantDescription
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Wolfsburg
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
plantDescription
+
+ + +
+
+
+
+

Sale

+
+
+ Bundels all sale-related data +
+ +
+

Properties

+
+
+ +
+
Vehicle sold date:
+
+ +Sold date of the vehicle = warranty start date for this vehicle + +
+
Name
+
soldDate
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#dateTime + +
+
+
+
+
+ +
+
Example
+
2018-02-03T00:00:00
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
soldDate
+
+ + +
+
+ +
+
Vehicle sold country
+
+ +Vehicle sold country in ISO 8601 alpha 3 + +
+
Name
+
countryCode
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
DEU
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
countryCode
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + Country Code Regular Expression +
    + +
    +
    Description
    +
    Regular Expression that ensures a three-letter code
    +
    + +
    +
    Reference
    +
    +
    +
      +
    • https://www.iso.org/iso-3166-country-codes.html
      • +
    +
    +
    +
    + +
    +
    Regular expression
    +
    ^[A-Z][A-Z][A-Z]$
    +
    + +
    • +
+
+
+
+
+ +
+
Vehicle sold region
+
+ +Region where this car was sold + +
+
Name
+
countryGroup
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Europe
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
countryGroup
+
+ + +
+
+
+
+

Vehicle

+
+
+ Vehicle data that does not fit into one of the other entities. +
+ +
+

Properties

+
+
+ +
+
Anonymized VIN
+
+ +OEM-specific hashed VIN; link to car data over pseydomized/hashed VIN or Catena-X unique digital twin identifier. + +
+
Name
+
anonymizedVin
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
3747429FGH382923974682
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
anonymizedVin
+
+ + +
+
+ +
+
Vehicle Catena-X Identifier
+
+ +A fully anonymous Catena-X identifier that is registered in C-X Digital twin registry. Can be used for vehicles, parts, workshops, ..... + +
+
Name
+
catenaXId
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
580d3adf-1981-44a0-a214-13d6ceed9379
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
catenaXId
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + Catena-X Id Regular Expression +
    + +
    +
    Description
    +
    The provided regular expression ensures that the UUID is composed of five groups of characters separated by hyphens, in the form 8-4-4-4-12 for a total of 36 characters (32 hexadecimal characters and 4 hyphens), prefixed by "urn:uuid:" to make it an IRI.
    +
    + +
    +
    Reference
    +
    +
    +
      +
    • https://datatracker.ietf.org/doc/html/rfc4122
      • +
    +
    +
    +
    + +
    +
    Regular expression
    +
    (^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$)|(^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$)
    +
    + +
    • +
+
+
+
+
+ +
+
Vehicle series
+
+ +vehicle series, normally one level above model. E.g. vehicle series ="Golf", vehicle model="Golf VIII" + +
+
Name
+
vehicleSeries
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Golf
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
vehicleSeries
+
+ + +
+
+ +
+
Vehicle model
+
+ +Detail vehicle model like "Golf VIII" + +
+
Name
+
modelDescription
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Golf VIII
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
modelDescription
+
+ + +
+
+ +
+
Model identifier
+
+ +OEM-specific model identifier or OEM-specific project name. + +
+
Name
+
modelIdentifier
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
689-G8
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
modelIdentifier
+
+ + +
+
+ +
+
Vehicle class
+
+ +Class of the vehicle. + +
+
Name
+
class
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
A
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
class
+
+ + +
+
+ +
+
Vehicle steering pos
+
+ +Position of vehicle steering wheel, Left or right. + +
+
Name
+
steeringPos
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • Left-Hand Drive
    • +
  • Right-Hand Drive
    • +
+
+
+
+
+ Reference +
+
    +
  • https://vpic.nhtsa.dot.gov/api/
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Left-Hand Drive
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
steeringPos
+
+ + +
+
+ +
+
Vehicle empty weight
+
+ +The empty weight of the vehicle in kg as specified. + +
+
Name
+
emptyWeight
+
+ + + +
+
Characteristic
+
+
+
+
Measurement
+
+
+
Weight of an object.
+
+
+
Unit
+
+
+
+
    +
  • + kilogram +
    • +
  • + Symbol kg +
    • +
  • + Code KGM +
    • +
  • + Conversion factor kg +
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#double + +
+
+
+
+
+ +
+
Example
+
2000.0
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
emptyWeight
+
+ + +
+
+ +
+
Drive type
+
+ +Drive type of a vehicle according enumeration. + +
+
Name
+
driveType
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • All-Wheel Drive
    • +
  • Front-Wheel Drive
    • +
  • Rear-Wheel Drive
    • +
+
+
+
+
+ Reference +
+
    +
  • https://vpic.nhtsa.dot.gov/api/
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Front-Wheel Drive
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
driveType
+
+ + +
+
+ +
+
Complete system power
+
+ +Complete power of this vehicle in KW. + +
+
Name
+
systemPower
+
+ + + +
+
Characteristic
+
+
+
+
Measurement
+
+
+
Engine power expressed in kilowatt.
+
+
+
Unit
+
+
+
+
    +
  • + kilowatt +
    • +
  • + Symbol kW +
    • +
  • + Code KWT +
    • +
  • + Conversion factor 10³ W +
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#integer + +
+
+
+
+
+ +
+
Example
+
110
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
systemPower
+
+ + +
+
+ +
+
Hybridization
+
+ +Degree of hybridization in this vehicle. + +
+
Name
+
hybridizationType
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • battery electric vehicle
    • +
  • hybrid electric vehicle
    • +
  • no hybrid
    • +
  • plugin hybrid electric vehicle
    • +
  • range extender
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
no hybrid
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
hybridizationType
+
+ + +
+
+ +
+
Software category
+
+ +Some OEMs bring in the software as complete package for all systems: +To identify this software: software category and software version is needed. +Software category when this car was built. + +
+
Name
+
softwareCategory
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
TZGH64738
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
softwareCategory
+
+ + +
+
+ +
+
Software version
+
+ +Some OEMs brings in the software as complete package for all systems: +To identify this software: software category and software version is needed. +Software version when this car was built +. + +
+
Name
+
softwareVersion
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
3.4.9837.567
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
softwareVersion
+
+ + +
+
+ +
+
OEM
+
+ +Original equipment manufacturer. + +
+
Name
+
oem
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.vehicle.product_description:3.0.0#OriginalEquipmentManufacturer + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
oem
+
+ + +
+
+ +
+
Vehicle body
+
+ +Vehicle body. + +
+
Name
+
body
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.vehicle.product_description:3.0.0#Body + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
body
+
+ + +
+
+ +
+
Equipments
+
+ +Equipments. + +
+
Name
+
equipments
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.vehicle.product_description:3.0.0#Equipment + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
equipments
+
+ + +
+
+ +
+
Production
+
+ +This property bundles production-related information. + +
+
Name
+
production
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.vehicle.product_description:3.0.0#Production + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
production
+
+ + +
+
+ +
+
Sale
+
+ +This property bundles all sales related information. + +
+
Name
+
sale
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.vehicle.product_description:3.0.0#Sale + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
sale
+
+ + +
+
+ +
+
Engines
+
+ +List of installed engines in the vehicle. + +
+
Name
+
engines
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.vehicle.product_description:3.0.0#Engine + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
engines
+
+ + +
+
+ +
+
Fuel
+
+ +The fuel type of the vehicle. + +
+
Name
+
fuel
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.vehicle.product_description:3.0.0#Fuel + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
fuel
+
+ + +
+
+
+ +
+ Third party licenses + +
+ +
+ + +
+ + + \ No newline at end of file diff --git a/io.catenax.vehicle.product_description/3.0.0/gen/ProductDescription.json b/io.catenax.vehicle.product_description/3.0.0/gen/ProductDescription.json new file mode 100644 index 00000000..f0a80445 --- /dev/null +++ b/io.catenax.vehicle.product_description/3.0.0/gen/ProductDescription.json @@ -0,0 +1,58 @@ +{ + "vehicle" : { + "catenaXId" : "580d3adf-1981-44a0-a214-13d6ceed9379", + "modelIdentifier" : "689-G8", + "emptyWeight" : 2000.0, + "production" : { + "plantIdentifier" : "4711", + "productionDate" : "2018-01-15T00:00:00", + "plantDescription" : "Wolfsburg" + }, + "driveType" : "All-Wheel Drive", + "fuel" : { + "kbaFuelType" : "Unbekannt", + "nhtsaFuelType" : "Compressed Hydrogen/Hydrogen" + }, + "steeringPos" : "Left-Hand Drive", + "hybridizationType" : "battery electric vehicle", + "body" : { + "numberOfDoors" : 5, + "kbaBody" : "Limousine", + "nhtsaBody" : "Cargo Van", + "colorId" : "LY7W ", + "colorDescription" : "Light grey" + }, + "anonymizedVin" : "3747429FGH382923974682", + "modelDescription" : "Golf VIII", + "equipments" : [ { + "equipmentIdentifier" : "S248A", + "equipmentDescription" : "Seat heating front", + "group" : "Interior" + } ], + "sale" : { + "soldDate" : "2018-02-03T00:00:00", + "countryCode" : "DEU", + "countryGroup" : "Europe" + }, + "vehicleSeries" : "Golf", + "softwareCategory" : "TZGH64738", + "oem" : { + "wmiCode" : "WBA", + "cxBPN" : "BPN-811", + "wmiDescription" : "BMW AG" + }, + "engines" : [ { + "serialNumber" : "3434937GJJG3738", + "size" : 1968, + "installDate" : "2018-01-10T00:00:00", + "engineDescription" : "2.0 TDI", + "power" : 110, + "engineId" : "CKBY", + "engineSeries" : "EA189", + "engineProductionDate" : "2017-10-20T00:00:00" + } ], + "systemPower" : 110, + "class" : "A", + "softwareVersion" : "3.4.9837.567" + } +} \ No newline at end of file diff --git a/io.catenax.vehicle.product_description/3.0.0/gen/ProductDescription.yml b/io.catenax.vehicle.product_description/3.0.0/gen/ProductDescription.yml new file mode 100644 index 00000000..a7ffbd16 --- /dev/null +++ b/io.catenax.vehicle.product_description/3.0.0/gen/ProductDescription.yml @@ -0,0 +1,515 @@ +--- +openapi: 3.0.3 +info: + title: Vehicle master data + version: v3 +servers: +- url: catenax.io/api/v3 + variables: + api-version: + default: v3 +paths: + /{tenant-id}/product-description: + get: + tags: + - ProductDescription + operationId: getProductDescription + parameters: + - name: tenant-id + in: path + description: The ID of the tenant owning the requested Twin. + required: true + schema: + type: string + format: uuid + responses: + "200": + $ref: '#/components/responses/ProductDescription' + "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 + urn_samm_io.catenax.vehicle.product_description_3.0.0_UniqueID: + type: string + description: "Characteristic for a unique id: every linked property to this\ + \ characteristic is a unique ID." + urn_samm_io.catenax.vehicle.product_description_3.0.0_CatenaXIdTrait: + type: string + description: "The provided regular expression ensures that the UUID is composed\ + \ of five groups of characters separated by hyphens, in the form 8-4-4-4-12\ + \ for a total of 36 characters (32 hexadecimal characters and 4 hyphens),\ + \ prefixed by \"urn:uuid:\" to make it an IRI." + pattern: "(^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$)|(^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$)" + urn_samm_org.eclipse.esmf.samm_characteristic_2.1.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_samm_io.catenax.vehicle.product_description_3.0.0_VehicleSteeringPos: + type: string + description: "Vehicle steering position enumeration from NHTSA, see table [vPICList_lite].[dbo].[Steering]" + enum: + - Left-Hand Drive + - Right-Hand Drive + urn_samm_io.catenax.vehicle.product_description_3.0.0_Weight: + type: number + description: Weight of an object. + urn_samm_io.catenax.vehicle.product_description_3.0.0_DriveTypeNHTSA: + type: string + description: "Enumeration of drive type according NHTSA, table [vPICList_lite].[dbo].[DriveType]" + enum: + - All-Wheel Drive + - Front-Wheel Drive + - Rear-Wheel Drive + urn_samm_io.catenax.vehicle.product_description_3.0.0_EnginePower: + type: number + description: Engine power expressed in kilowatt. + urn_samm_io.catenax.vehicle.product_description_3.0.0_Hybridization: + type: string + description: Enumeration of possible hybridization values + enum: + - battery electric vehicle + - hybrid electric vehicle + - no hybrid + - plugin hybrid electric vehicle + - range extender + urn_samm_io.catenax.vehicle.product_description_3.0.0_OemShortNameTrait: + type: string + description: Restricts the length of wmiCode to exactly 3 chars + maxLength: 3 + minLength: 3 + urn_samm_io.catenax.vehicle.product_description_3.0.0_OEMCharacteristic: + description: OEM characteristic describes an original eequipment manufacturer(OEM). + type: object + properties: + wmiCode: + description: "Short name/code of vehicle manufacturer according to world\ + \ manufacturer information(wmi). The wmiCode are the first 3 chars of\ + \ the vehicle identification number.\nA list of in NHTSA registered wmiCodes\ + \ can be found in attribute Wmi in table [vPICList_lite].[dbo].[Wmi] " + $ref: '#/components/schemas/urn_samm_io.catenax.vehicle.product_description_3.0.0_OemShortNameTrait' + wmiDescription: + description: |- + Name of OEM according NHTSA or other authorities. Has to be compliant with/linked wmiCode attribute. + For NHTSA: name of table [vPICList_lite].[dbo].[Manufacturer] + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + cxBPN: + description: Catena-X business partner number of this company. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + required: + - wmiCode + - wmiDescription + - cxBPN + urn_samm_io.catenax.vehicle.product_description_3.0.0_PositiveNumber: + type: number + minimum: 1 + urn_samm_io.catenax.vehicle.product_description_3.0.0_KbaVariant: + type: string + description: 'Current version of the Enumeration is sub-set of list defined + from the German Federal Office for motor vehicles. ' + enum: + - Limousine + - Kombilimousine + - Kabrio-Limousine + - Cabrio-Limousine + - Mehrzweckfahrzeug + - Pkw-Pick-up + - Van + - Pick-up + - Coupe + - Schraeghecklimousine + urn_samm_io.catenax.vehicle.product_description_3.0.0_NhtsaVariant: + type: string + description: "Enumeration comming from NHTSA offline database vpic, table [vPICList_lite].[dbo].[BodyStyle]" + enum: + - Cargo Van + - Convertible + - Cabriolet + - Coupe + - Crossover Utility Vehicle(CUV) + - Hatchback + - Liftback + - Notchback + - Limousine + - Low Speed Vehicle(LSV) + - Neighborhood Electric Vehicle(NEV) + - Minivan + - Pickup + - Roadster + - Sedan + - Saloon + - Sport Utility Truck(SUT) + - Sport Utility Vehicle(SUV) + - Multi-Purpose Vehicle(MPV) + - Van + - Wagon + urn_samm_io.catenax.vehicle.product_description_3.0.0_BodyCharacteristic: + description: Bundles all body-related information. + type: object + properties: + numberOfDoors: + description: Describes the number of doors of a vehicle. + $ref: '#/components/schemas/urn_samm_io.catenax.vehicle.product_description_3.0.0_PositiveNumber' + colorId: + description: Colour code describes the code of a specific colour of a vehicle. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + colorDescription: + description: Colour name describes the colour of the colour code as a written + word. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + kbaBody: + description: Vehicle variant - Body shapes according German KBA + $ref: '#/components/schemas/urn_samm_io.catenax.vehicle.product_description_3.0.0_KbaVariant' + nhtsaBody: + description: Vehicle variant - Body shapes according US NHTSA + $ref: '#/components/schemas/urn_samm_io.catenax.vehicle.product_description_3.0.0_NhtsaVariant' + required: + - numberOfDoors + - colorId + - colorDescription + urn_samm_io.catenax.vehicle.product_description_3.0.0_Equipment: + description: One equipment of the vehicle. + type: object + properties: + equipmentIdentifier: + description: The identifier of a specific equipment. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + equipmentDescription: + description: The equipment variants description. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + group: + description: Bundels all equipment-oriented information into categories + like Interior + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + required: + - equipmentIdentifier + - equipmentDescription + - group + urn_samm_io.catenax.vehicle.product_description_3.0.0_Equipments: + description: List of equipments installed in the vehicle. + type: array + items: + $ref: '#/components/schemas/urn_samm_io.catenax.vehicle.product_description_3.0.0_Equipment' + urn_samm_org.eclipse.esmf.samm_characteristic_2.1.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_samm_io.catenax.vehicle.product_description_3.0.0_ProductionCharacteristic: + description: Production Characteristic + type: object + properties: + productionDate: + description: Production date of the vehicle + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Timestamp' + plantIdentifier: + description: Plant id of the final assembly of the vehicle + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + plantDescription: + description: Long name of the production plant of the vehicle + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + required: + - productionDate + - plantIdentifier + - plantDescription + urn_samm_io.catenax.vehicle.product_description_3.0.0_CountryCodeTrait: + type: string + description: 'Regular Expression that ensures a three-letter code ' + pattern: "^[A-Z][A-Z][A-Z]$" + urn_samm_io.catenax.vehicle.product_description_3.0.0_SaleCharacteristic: + description: Characteristic for sale-oriented information. + type: object + properties: + soldDate: + description: Sold date of the vehicle = warranty start date for this vehicle + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Timestamp' + countryCode: + description: Vehicle sold country in ISO 8601 alpha 3 + $ref: '#/components/schemas/urn_samm_io.catenax.vehicle.product_description_3.0.0_CountryCodeTrait' + countryGroup: + description: Region where this car was sold + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + required: + - soldDate + - countryCode + - countryGroup + urn_samm_io.catenax.vehicle.product_description_3.0.0_CubicCapacity: + type: number + description: Cubic capacity of the engine + urn_samm_io.catenax.vehicle.product_description_3.0.0_Engine: + description: Describing one installed engine + type: object + properties: + engineId: + description: OEM-specific identifier/type of the installed engine + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + engineDescription: + description: Description of the engine + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + engineSeries: + description: Engine series as defined by OEM + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + serialNumber: + description: Serial number of the installed engine + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + size: + description: Cubic capacity in a combustion engine - not available in battery-electric + vehicles + $ref: '#/components/schemas/urn_samm_io.catenax.vehicle.product_description_3.0.0_CubicCapacity' + power: + description: Engine power is the power that an engine can put out + $ref: '#/components/schemas/urn_samm_io.catenax.vehicle.product_description_3.0.0_EnginePower' + engineProductionDate: + description: Date when the engine was produced + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Timestamp' + installDate: + description: Date when the engine was installed + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Timestamp' + required: + - engineId + - engineDescription + - engineSeries + - serialNumber + - power + urn_samm_io.catenax.vehicle.product_description_3.0.0_Engines: + description: A list of all installed engines in the vehicle + type: array + items: + $ref: '#/components/schemas/urn_samm_io.catenax.vehicle.product_description_3.0.0_Engine' + urn_samm_io.catenax.vehicle.product_description_3.0.0_FuelKBA: + type: string + description: Enumeration of possible fuel types of a vehicle according german + KBA + enum: + - Unbekannt + - Diesel + - Benzin + - Vielstoff + - Elektro + - Benzin/Fl?ssiggas + - Benzin/komp.Erdgas + - Hybr.Benzin/E + - Erdgas NG + - Hybr.Diesel/E + - Wasserstoff + - Hybr.Wasserst./E + - Wasserstoff/Benzin + - Wasserst./Benzin/E + - BZ/Wasserstoff + - BZ/Benzin + - BZ/Methanol + - BZ/Ethanol + - Hybr.Vielstoff/E + - Methan + - Benzin/Methan + - Hybr.Erdgas/E + - Benzin/Ethanol + - Hybr.B/E ext.aufl. + - Hybr.D/E ext.aufl. + - Hybr.LPG/E ext.aufl. + - Hybr.W/E ext.aufl. + - Hybr.V/E ext.aufl. + - Hybr.NG/E ext.aufl. + - Hybr.Wod.B/Eext.aufl + - Wasserstoff/NG + - Hybr.W/NG/E ext.aufl + - Ethanol + - Hybr.BZ/W/E + - Hybr.BZ/W/E ext. aufl. + - Zweistoff LNG/Diesel + - Andere + - Fluessiggas + - Hybr.Fluessiggas/E + - Verfluessigtes Erdgas(LNG) + urn_samm_io.catenax.vehicle.product_description_3.0.0_FuelNHTSA: + type: string + description: "Enumeration from NHTSA vpic database, table [vPICList_lite].[dbo].[FuelType]" + enum: + - Compressed Hydrogen/Hydrogen + - Compressed Natural Gas(CNG) + - Diesel + - Electric + - Ethanol(E85) + - Flexible Fuel Vehicle(FFV) + - Fuel Cell + - Gasoline + - Liquefied Natural Gas(LNG) + - Liquefied Petroleum Gas(propane or LPG) + - Methanol(M85) + - Natural Gas + - Neat Ethanol(E100) + - Neat Methanol(M100) + - Unknown + urn_samm_io.catenax.vehicle.product_description_3.0.0_FuelCharacteristic: + description: Characteristic for the fuel used in the vehicle. + type: object + properties: + kbaFuelType: + description: Description of the fuel according german KBA + $ref: '#/components/schemas/urn_samm_io.catenax.vehicle.product_description_3.0.0_FuelKBA' + nhtsaFuelType: + description: Description of the fuel according US NHTSA + $ref: '#/components/schemas/urn_samm_io.catenax.vehicle.product_description_3.0.0_FuelNHTSA' + urn_samm_io.catenax.vehicle.product_description_3.0.0_VehicleCharacteristic: + description: This chracteristic bundles all general vehicle data. + type: object + properties: + anonymizedVin: + description: OEM-specific hashed VIN; link to car data over pseydomized/hashed + VIN or Catena-X unique digital twin identifier. + $ref: '#/components/schemas/urn_samm_io.catenax.vehicle.product_description_3.0.0_UniqueID' + catenaXId: + description: "A fully anonymous Catena-X identifier that is registered in\ + \ C-X Digital twin registry. Can be used for vehicles, parts, workshops,\ + \ ....." + $ref: '#/components/schemas/urn_samm_io.catenax.vehicle.product_description_3.0.0_CatenaXIdTrait' + vehicleSeries: + description: "vehicle series, normally one level above model. E.g. vehicle\ + \ series =\"Golf\", vehicle model=\"Golf VIII\"" + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + modelDescription: + description: Detail vehicle model like "Golf VIII" + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + modelIdentifier: + description: OEM-specific model identifier or OEM-specific project name. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + class: + description: Class of the vehicle. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + steeringPos: + description: "Position of vehicle steering wheel, Left or right." + $ref: '#/components/schemas/urn_samm_io.catenax.vehicle.product_description_3.0.0_VehicleSteeringPos' + emptyWeight: + description: The empty weight of the vehicle in kg as specified. + $ref: '#/components/schemas/urn_samm_io.catenax.vehicle.product_description_3.0.0_Weight' + driveType: + description: Drive type of a vehicle according enumeration. + $ref: '#/components/schemas/urn_samm_io.catenax.vehicle.product_description_3.0.0_DriveTypeNHTSA' + systemPower: + description: Complete power of this vehicle in KW. + $ref: '#/components/schemas/urn_samm_io.catenax.vehicle.product_description_3.0.0_EnginePower' + hybridizationType: + description: Degree of hybridization in this vehicle. + $ref: '#/components/schemas/urn_samm_io.catenax.vehicle.product_description_3.0.0_Hybridization' + softwareCategory: + description: |- + Some OEMs bring in the software as complete package for all systems: + To identify this software: software category and software version is needed. + Software category when this car was built. + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + softwareVersion: + description: |- + Some OEMs brings in the software as complete package for all systems: + To identify this software: software category and software version is needed. + Software version when this car was built + . + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text' + oem: + description: Original equipment manufacturer. + $ref: '#/components/schemas/urn_samm_io.catenax.vehicle.product_description_3.0.0_OEMCharacteristic' + body: + description: Vehicle body. + $ref: '#/components/schemas/urn_samm_io.catenax.vehicle.product_description_3.0.0_BodyCharacteristic' + equipments: + description: Equipments. + $ref: '#/components/schemas/urn_samm_io.catenax.vehicle.product_description_3.0.0_Equipments' + production: + description: This property bundles production-related information. + $ref: '#/components/schemas/urn_samm_io.catenax.vehicle.product_description_3.0.0_ProductionCharacteristic' + sale: + description: This property bundles all sales related information. + $ref: '#/components/schemas/urn_samm_io.catenax.vehicle.product_description_3.0.0_SaleCharacteristic' + engines: + description: List of installed engines in the vehicle. + $ref: '#/components/schemas/urn_samm_io.catenax.vehicle.product_description_3.0.0_Engines' + fuel: + description: The fuel type of the vehicle. + $ref: '#/components/schemas/urn_samm_io.catenax.vehicle.product_description_3.0.0_FuelCharacteristic' + required: + - anonymizedVin + - vehicleSeries + - modelDescription + - modelIdentifier + - class + - steeringPos + - emptyWeight + - driveType + - systemPower + - oem + - body + - equipments + - production + - sale + - engines + - fuel + ProductDescription: + description: Master data of one vehicle - from an end customer view. So this + model represents the vehicle as it was sold to the customer. All entities + and properties are immutable over the lifetime of the vehicle. + type: object + properties: + vehicle: + description: "A vehicle can be a car, bus, truck..." + $ref: '#/components/schemas/urn_samm_io.catenax.vehicle.product_description_3.0.0_VehicleCharacteristic' + required: + - vehicle + 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' + ProductDescription: + content: + application/json: + schema: + $ref: '#/components/schemas/ProductDescription' + description: The request was successful. + requestBodies: + ProductDescription: + content: + application/json: + schema: + $ref: '#/components/schemas/ProductDescription'