diff --git a/io.catenax.fleet.vehicles/2.0.0/metadata.json b/io.catenax.fleet.vehicles/2.0.0/metadata.json index a182c7b8..970dbd81 100644 --- a/io.catenax.fleet.vehicles/2.0.0/metadata.json +++ b/io.catenax.fleet.vehicles/2.0.0/metadata.json @@ -1 +1 @@ -{ "status" : "release"} \ No newline at end of file +{ "status" : "deprecate"} \ No newline at end of file diff --git a/io.catenax.fleet.vehicles/2.1.0/Vehicles.ttl b/io.catenax.fleet.vehicles/2.1.0/Vehicles.ttl new file mode 100644 index 00000000..3778e92b --- /dev/null +++ b/io.catenax.fleet.vehicles/2.1.0/Vehicles.ttl @@ -0,0 +1,403 @@ +####################################################################### +# Copyright (c) 2022, 2024 Robert Bosch GmbH +# Copyright (c) 2022, 2024 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) +# Copyright (c) 2022, 2024 Volkswagen AG +# Copyright (c) 2022, 2024 ZF Friedrichshafen AG +# Copyright (c) 2022, 2024 SAP SE +# Copyright (c) 2022, 2024 Siemens AG +# Copyright (c) 2022, 2024 Contributors to the Eclipse Foundation +# Copyright (c) 2022 Mercedes Benz AG +# +# See the NOTICE file(s) distributed with this work for additional +# information regarding copyright ownership. +# +# This work is made available under the terms of the +# Creative Commons Attribution 4.0 International (CC-BY-4.0) license, +# which is available at +# https://creativecommons.org/licenses/by/4.0/legalcode. +# +# SPDX-License-Identifier: CC-BY-4.0 +####################################################################### +@prefix samm: . +@prefix samm-c: . +@prefix samm-e: . +@prefix unit: . +@prefix rdf: . +@prefix rdfs: . +@prefix xsd: . +@prefix : . +@prefix ext-number: . +@prefix ext-uuid: . + +:Vehicles a samm:Aspect ; + samm:preferredName "Vehicles"@en ; + samm:description "This aspect model was created in the Catena-X use case quality. The purpose of this aspect model is to transfer general information of a list/fleet of vehicles - primarily how the vehicles are equipped, when they were built and which engines are installed."@en ; + samm:properties ( :listOfVehicles [ samm:property :metaInformation; samm:optional true ] ) ; + samm:operations ( ) ; + samm:events ( ) . + +:listOfVehicles a samm:Property ; + samm:preferredName "listOfVehicles"@en ; + samm:description "List of Vehicle.ProductDescription"@en ; + samm:characteristic :VehiclesList . + +:metaInformation a samm:Property ; + samm:preferredName "Meta information"@en ; + samm:description "This meta information is valid for all entries in this data set. The meta information is used to tell the data consumer which selection criteria were applied by the data provider. "@en ; + samm:characteristic :MetaCharacteristic . + +:VehiclesList a samm-c:List ; + samm:preferredName "List of vehicles"@en ; + samm:description "List of vehicles"@en ; + samm:dataType :Vehicle . + +:MetaCharacteristic a samm:Characteristic ; + samm:preferredName "MetaCharacteristic"@en ; + samm:description "Characteristic for the meta information."@en ; + samm:dataType :MetaInformation . + +:Vehicle a samm:Entity ; + samm:preferredName "Vehicle"@en ; + samm:description "Vehicle data that does not fit into one of the other entities."@en ; + samm:properties ( [ samm:property :recordStatus; samm:optional true ] :anonymizedVin [ samm:property :catenaXVehicleId; samm:optional true ] [ samm:property :class; samm:optional true ] [ samm:property :driveSystemPower; samm:optional true ] [ samm:property :driveType; samm:optional true ] [ samm:property :powerTrainType; samm:optional true ] [ samm:property :modelDescription; samm:optional true ] [ samm:property :modelIdentifier; samm:optional true ] [ samm:property :plantCatenaXId; samm:optional true ] [ samm:property :plantCountryCode; samm:optional true ] [ samm:property :plantDescription; samm:optional true ] [ samm:property :plantIdentifier; samm:optional true ] [ samm:property :productionDate; samm:optional true ] [ samm:property :softwareCategory; samm:optional true ] [ samm:property :softwareVersion; samm:optional true ] [ samm:property :soldCountryCode; samm:optional true ] [ samm:property :soldCountryGroup; samm:optional true ] [ samm:property :soldDate; samm:optional true ] [ samm:property :steeringPos; samm:optional true ] [ samm:property :vehicleSeries; samm:optional true ] [ samm:property :wmiCode; samm:optional true ] [ samm:property :wmiNameNHTSA; samm:optional true ] [ samm:property :engines; samm:optional true ] [ samm:property :equipments; samm:optional true ] ) . + +:MetaInformation a samm:Entity ; + samm:preferredName "Meta Information"@en ; + samm:description "This entity groups all meta information properties. Meta information properties give hints for a Catena-X data consumer to better understand, how this data set was created on the Catena-X data provider side."@en ; + samm:properties ( :selectionCriteria [ samm:property :selectionStart; samm:optional true ] [ samm:property :selectionEnd; samm:optional true ] ) . + +:recordStatus a samm:Property ; + samm:preferredName "Record status"@en ; + samm:description "The record operation enumeration can be used to realize delta update concept.\nDelta update concept means:\n- You transfer an initial load of data\n- After the first week only the delta to the initial load is transferred\n\n\nThe record status describes whether this record is:\n- new=>This record is transferred the first time\n- update=> Some properties of this record have changed compared to a previous transfer\n- delete=> This record was transferred in the initial load or in a previous delta update, but is not used any more and therefore it should be deleted on data consumer side\n- same=> This record was transferred in the initial load or in a previous delta update"@en ; + samm:characteristic :RecordStatusEnumeration ; + samm:exampleValue "update" . + +:anonymizedVin a samm:Property ; + samm:preferredName "Anonymized VIN"@en ; + samm:description "OEM-specific hashed VIN; link to car data over pseydomized/hashed VIN or Catena-X unique digital twin identifier."@en ; + samm:characteristic :UniqueID ; + samm:exampleValue "3747429FGH382923974682" . + +:catenaXVehicleId a samm:Property ; + samm:preferredName "Vehicle Catena-X Identifier"@en ; + samm:description "A unique identifier for the vehicle in the Catena-X data space."@en ; + samm:characteristic ext-uuid:UuidV4Trait ; + samm:exampleValue "urn:uuid:580d3adf-1981-44a0-a214-13d6ceed9379" . + +:class a samm:Property ; + samm:preferredName "Vehicle class"@en ; + samm:description "Class of the vehicle."@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "A" . + +:driveSystemPower a samm:Property ; + samm:preferredName "Complete system power"@en ; + samm:description "Complete power of this vehicle in KW. This sums up the power of each individual engine installed in this vehicle."@en ; + samm:characteristic :EnginePower ; + samm:exampleValue 200 . + +:driveType a samm:Property ; + samm:preferredName "Drive type"@en ; + samm:description "Drive type of a vehicle according enumeration."@en ; + samm:characteristic :DriveTypeNHTSA ; + samm:exampleValue "Front-Wheel Drive" . + +:powerTrainType a samm:Property ; + samm:preferredName "Powertrain Type"@en ; + samm:description "Describes the installed powertrain in the vehicle."@en ; + samm:characteristic :PowerTrainTypes . + +:modelDescription a samm:Property ; + samm:preferredName "Vehicle model"@en ; + samm:description "Detail vehicle model like \"Golf VIII\""@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "Golf VIII" . + +:modelIdentifier a samm:Property ; + samm:preferredName "Model identifier"@en ; + samm:description "OEM-specific model identifier or OEM-specific project name."@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "689-G8" . + +:plantCatenaXId a samm:Property ; + samm:preferredName "Plant Catena-X ID"@en ; + samm:description "Unique Catena-X plant identifier, also called BPNS."@en ; + samm:characteristic ext-number:BpnsTrait ; + samm:exampleValue "BPNS0123456789ZZ" . + +:plantCountryCode a samm:Property ; + samm:preferredName "Plant country"@en ; + samm:description "Country code of the plant, where the vehicle was produced."@en ; + samm:characteristic :CountryCodeTrait ; + samm:exampleValue "DEU" . + +:plantDescription a samm:Property ; + samm:preferredName "Vehicle production plant name"@en ; + samm:description "Long name of the production plant of the vehicle"@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "Wolfsburg" . + +:plantIdentifier a samm:Property ; + samm:preferredName "Production plant id"@en ; + samm:description "Plant id of the final assembly of the vehicle"@en ; + samm:characteristic :UniqueID ; + samm:exampleValue "4711" . + +:productionDate a samm:Property ; + samm:preferredName "Vehicle production Date"@en ; + samm:description "Production date of the vehicle"@en ; + samm:characteristic samm-c:Timestamp ; + samm:exampleValue "2018-01-15T00:00:00"^^xsd:dateTime . + +:softwareCategory a samm:Property ; + samm:preferredName "Software category"@en ; + samm: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."@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "TZGH64738" . + +:softwareVersion a samm:Property ; + samm:preferredName "Software version"@en ; + samm: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."@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "3.4.9837.567" . + +:soldCountryCode a samm:Property ; + samm:preferredName "Sold country code"@en ; + samm:description "The country code in 3 letter format where this vehicle was sold."@en ; + samm:characteristic :CountryCodeTrait ; + samm:exampleValue "DEU" . + +:soldCountryGroup a samm:Property ; + samm:preferredName "Vehicle sold region"@en ; + samm:description "The region where this car was sold."@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "Europe" . + +:soldDate a samm:Property ; + samm:preferredName "Vehicle sold date:"@en ; + samm:description "Sold date of the vehicle = warranty start date for this vehicle"@en ; + samm:characteristic samm-c:Timestamp ; + samm:exampleValue "2018-02-03T00:00:00"^^xsd:dateTime . + +:steeringPos a samm:Property ; + samm:preferredName "Vehicle steering pos"@en ; + samm:description "Position of vehicle steering wheel, Left or right."@en ; + samm:characteristic :VehicleSteeringPos ; + samm:exampleValue "Left-Hand Drive" . + +:vehicleSeries a samm:Property ; + samm:preferredName "Vehicle series"@en ; + samm:description "vehicle series, normally one level above model. E.g. vehicle series =\"Golf\", vehicle model=\"Golf VIII\""@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "Golf" . + +:wmiCode a samm:Property ; + samm:preferredName "WMI Code"@en ; + samm:description "The world manufacturer index are the first 3 letters of the VIN. IT describes a code for the vehicle manufacturer. Also see the description from NTHSA."@en ; + samm:see ; + samm:characteristic :OemShortNameTrait ; + samm:exampleValue "WVW" . + +:wmiNameNHTSA a samm:Property ; + samm:preferredName "WMI name according NHTSA"@en ; + samm:description "Name of the vehicle manufacturer according NHTSA: use https://vpic.nhtsa.dot.gov/api/vehicles/decodewmi/WVW?format=json - entry to be used is CommonName."@en ; + samm:see ; + samm:characteristic samm-c:Text ; + samm:exampleValue "Volkswagen" . + +:engines a samm:Property ; + samm:preferredName "Engines"@en ; + samm:description "List of installed engines in the vehicle."@en ; + samm:characteristic :EnginesList . + +:equipments a samm:Property ; + samm:preferredName "Equipments"@en ; + samm:description "Equipments."@en ; + samm:characteristic :EquipmentsList . + +:selectionCriteria a samm:Property ; + samm:preferredName "Selection criteria"@en ; + samm:description "Describes the selection criteria a Catena-X data provider has applied to create this data set."@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "Export of vehicles that are involved in the linked qualityTask and FleetClaim list. " . + +:selectionStart a samm:Property ; + samm:preferredName "Selection start"@en ; + samm:description "Describes the starting point for providing records in this data set."@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "2023-01-01T00:00:00" . + +:selectionEnd a samm:Property ; + samm:preferredName "Selection end"@en ; + samm:description "Describes the end point for providing records in this data set."@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "2023-12-31T23:59:59" . + +:RecordStatusEnumeration a samm-c:Enumeration ; + samm:preferredName "Record status enumeration"@en ; + samm:description "Defining the enumeration for the record status"@en ; + samm:dataType xsd:string ; + samm-c:values ( "new" "update" "delete" "same" ) . + +:UniqueID a samm:Characteristic ; + samm:preferredName "unique ID"@en ; + samm:description "This Characteristic describes a property that is truly unique either inside the Company that is providing the data or even in Catena-X dataspace. Only one property in a semantic entity should be a uniqueID. Unique ids can be used to link a data set with other semantic models."@en ; + samm:dataType xsd:string . + +:EnginePower a samm-c:Measurement ; + samm:preferredName "Engine Power"@en ; + samm:description "Engine power expressed in kilowatt."@en ; + samm:dataType xsd:integer ; + samm-c:unit unit:kilowatt . + +:DriveTypeNHTSA a samm-c:Enumeration ; + samm:preferredName "Drive type(NHTSA)"@en ; + samm:description "Enumeration of drive type according NHTSA, table [vPICList_lite].[dbo].[DriveType]"@en ; + samm:see ; + samm:dataType xsd:string ; + samm-c:values ( "All-Wheel Drive" "Front-Wheel Drive" "Rear-Wheel Drive" ) . + +:PowerTrainTypes a samm-c:Enumeration ; + samm:preferredName "Powertrain types "@en ; + samm:description "This enumeration comes from NHTSA (US authority) database. Table [vPICList_lite].[dbo].[ElectrificationLevel] extended by Gasoline and Diesel as entry."@en ; + samm:dataType xsd:string ; + samm-c:values ( "BEV (Battery Electric Vehicle)" "Diesel" "FCEV (Fuel Cell Electric Vehicle)" "Gasoline" "HEV (Hybrid Electric Vehicle)" "Mild HEV (Hybrid Electric Vehicle)" "PHEV (Plug-in Hybrid Electric Vehicle)" "Other" ) . + +:CountryCodeTrait a samm-c:Trait ; + samm-c:baseCharacteristic :CountryCodeCharacteristic ; + samm-c:constraint :CountryCodeRegularExpression . + +:VehicleSteeringPos a samm-c:Enumeration ; + samm:preferredName "Vehicle steering position(NHTSA)"@en ; + samm:description "Vehicle steering position enumeration from NHTSA, see table [vPICList_lite].[dbo].[Steering]"@en ; + samm:see ; + samm:dataType xsd:string ; + samm-c:values ( "Left-Hand Drive" "Right-Hand Drive" ) . + +:OemShortNameTrait a samm-c:Trait ; + samm-c:baseCharacteristic samm-c:Text ; + samm-c:constraint :WorldManufacturerInformationCodeLength . + +:EnginesList a samm-c:List ; + samm:preferredName "Engines"@en ; + samm:description "A list of all installed engines in the vehicle"@en ; + samm:dataType :Engine . + +:EquipmentsList a samm-c:List ; + samm:preferredName "Equipment List"@en ; + samm:description "List of equipments installed in the vehicle."@en ; + samm:dataType :Equipment . + +:CountryCodeCharacteristic a samm:Characteristic ; + samm:preferredName "Country Code Characteristic"@en ; + samm:description "ISO 3166-1 alpha-3 ? three-letter country codes "@en ; + samm:dataType xsd:string . + +:CountryCodeRegularExpression a samm-c:RegularExpressionConstraint ; + samm:preferredName "Country Code Regular Expression"@en ; + samm:description "Regular Expression that ensures a three-letter code "@en ; + samm:see ; + samm:value "^[A-Z][A-Z][A-Z]$" . + +:WorldManufacturerInformationCodeLength a samm-c:LengthConstraint ; + samm:preferredName "Length restriction for WMI"@en ; + samm:description "Restricts the length of wmiCode to exactly 3 chars."@en ; + samm:see ; + samm-c:minValue "3"^^xsd:nonNegativeInteger ; + samm-c:maxValue "3"^^xsd:nonNegativeInteger . + +:Engine a samm:Entity ; + samm:preferredName "Engine Entity"@en ; + samm:description "Describing one installed engine"@en ; + samm:properties ( :engineId [ samm:property :engineDescription; samm:optional true ] [ samm:property :engineSeries; samm:optional true ] [ samm:property :serialNumber; samm:optional true ] [ samm:property :size; samm:optional true ] [ samm:property :power; samm:optional true ] [ samm:property :engineProductionDate; samm:optional true ] [ samm:property :installDate; samm:optional true ] [ samm:property :nhtsaFuelType; samm:optional true ] ) . + +:Equipment a samm:Entity ; + samm:preferredName "Equipment"@en ; + samm:description "One equipment of the vehicle."@en ; + samm:properties ( :equipmentIdentifier [ samm:property :equipmentDescription; samm:optional true ] [ samm:property :group; samm:optional true ] ) . + +:engineId a samm:Property ; + samm:preferredName "Engine ID:"@en ; + samm:description "OEM-specific identifier/type of the installed engine"@en ; + samm:characteristic :UniqueID ; + samm:exampleValue "CKBY" . + +:engineDescription a samm:Property ; + samm:preferredName "Engine Description"@en ; + samm:description "Description of the engine"@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "2.0 TDI" . + +:engineSeries a samm:Property ; + samm:preferredName "Vehicle engine series"@en ; + samm:description "Engine series as defined by OEM"@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "EA189" . + +:serialNumber a samm:Property ; + samm:preferredName "Engine serial number"@en ; + samm:description "Serial number of the installed engine"@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "3434937GJJG3738" . + +:size a samm:Property ; + samm:preferredName "Engine size"@en ; + samm:description "Cubic capacity in a combustion engine - not available in battery-electric vehicles"@en ; + samm:characteristic :CubicCapacity ; + samm:exampleValue 1968 . + +:power a samm:Property ; + samm:preferredName "Engine power"@en ; + samm:description "Engine power is the power that an engine can put out"@en ; + samm:characteristic :EnginePower ; + samm:exampleValue 110 . + +:engineProductionDate a samm:Property ; + samm:preferredName "Engine production date"@en ; + samm:description "Date when the engine was produced"@en ; + samm:characteristic samm-c:Timestamp ; + samm:exampleValue "2017-10-20T00:00:00"^^xsd:dateTime . + +:installDate a samm:Property ; + samm:preferredName "Engine install date"@en ; + samm:description "Date when the engine was installed"@en ; + samm:characteristic samm-c:Timestamp ; + samm:exampleValue "2018-01-10T00:00:00"^^xsd:dateTime . + +:nhtsaFuelType a samm:Property ; + samm:preferredName "Fuel type(NHTSA)"@en ; + samm:description "Description of the fuel according US NHTSA"@en ; + samm:characteristic :FuelTypesNHTSA ; + samm:exampleValue "Diesel" . + +:equipmentIdentifier a samm:Property ; + samm:preferredName "Equipment Id"@en ; + samm:description "The identifier of a specific equipment."@en ; + samm:characteristic :UniqueID ; + samm:exampleValue "S248A" . + +:equipmentDescription a samm:Property ; + samm:preferredName "Equipment description"@en ; + samm:description "The equipment variants description."@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "Seat heating front" . + +:group a samm:Property ; + samm:preferredName "Equipment group"@en ; + samm:description "Bundels all equipment-oriented information into categories like Interior"@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "Interior" . + +:CubicCapacity a samm-c:Measurement ; + samm:preferredName "Cubic Capacity"@en ; + samm:description "Cubic capacity of the engine"@en ; + samm:dataType xsd:integer ; + samm-c:unit unit:cubicCentimetre . + +:FuelTypesNHTSA a samm-c:Enumeration ; + samm:preferredName "Fuel types (NHTSA)"@en ; + samm:description "Enumeration from NHTSA vpic database, table [vPICList_lite].[dbo].[FuelType]"@en ; + samm:see ; + samm:dataType xsd:string ; + samm-c: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" ) . + diff --git a/io.catenax.fleet.vehicles/2.1.0/gen/Vehicles-schema.json b/io.catenax.fleet.vehicles/2.1.0/gen/Vehicles-schema.json new file mode 100644 index 00000000..3c4dbcf2 --- /dev/null +++ b/io.catenax.fleet.vehicles/2.1.0/gen/Vehicles-schema.json @@ -0,0 +1,296 @@ +{ + "$schema" : "http://json-schema.org/draft-04/schema", + "description" : "This aspect model was created in the Catena-X use case quality. The purpose of this aspect model is to transfer general information of a list/fleet of vehicles - primarily how the vehicles are equipped, when they were built and which engines are installed.", + "type" : "object", + "components" : { + "schemas" : { + "urn_samm_io.catenax.fleet.vehicles_2.0.0_RecordStatusEnumeration" : { + "type" : "string", + "description" : "Defining the enumeration for the record status", + "enum" : [ "new", "update", "delete", "same" ] + }, + "urn_samm_io.catenax.fleet.vehicles_2.0.0_UniqueID" : { + "type" : "string", + "description" : "This Characteristic describes a property that is truly unique either inside the Company that is providing the data or even in Catena-X dataspace. Only one property in a semantic entity should be a uniqueID. Unique ids can be used to link a data set with other semantic models." + }, + "urn_samm_io.catenax.shared.uuid_2.0.0_UuidV4Trait" : { + "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_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.fleet.vehicles_2.0.0_EnginePower" : { + "type" : "number", + "description" : "Engine power expressed in kilowatt." + }, + "urn_samm_io.catenax.fleet.vehicles_2.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.fleet.vehicles_2.0.0_PowerTrainTypes" : { + "type" : "string", + "description" : "This enumeration comes from NHTSA (US authority) database. Table [vPICList_lite].[dbo].[ElectrificationLevel] extended by Gasoline and Diesel as entry.", + "enum" : [ "BEV (Battery Electric Vehicle)", "Diesel", "FCEV (Fuel Cell Electric Vehicle)", "Gasoline", "HEV (Hybrid Electric Vehicle)", "Mild HEV (Hybrid Electric Vehicle)", "PHEV (Plug-in Hybrid Electric Vehicle)", "Other" ] + }, + "urn_samm_io.catenax.shared.business_partner_number_2.0.0_BpnsTrait" : { + "type" : "string", + "description" : "The provided regular expression ensures that the BPNS is composed of prefix 'BPNS', 10 digits and two alphanumeric letters.", + "pattern" : "^BPNS[a-zA-Z0-9]{12}$" + }, + "urn_samm_io.catenax.fleet.vehicles_2.0.0_CountryCodeTrait" : { + "type" : "string", + "description" : "Regular Expression that ensures a three-letter code ", + "pattern" : "^[A-Z][A-Z][A-Z]$" + }, + "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.fleet.vehicles_2.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.fleet.vehicles_2.0.0_OemShortNameTrait" : { + "type" : "string", + "description" : "Restricts the length of wmiCode to exactly 3 chars.", + "maxLength" : 3, + "minLength" : 3 + }, + "urn_samm_io.catenax.fleet.vehicles_2.0.0_CubicCapacity" : { + "type" : "number", + "description" : "Cubic capacity of the engine" + }, + "urn_samm_io.catenax.fleet.vehicles_2.0.0_FuelTypesNHTSA" : { + "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.fleet.vehicles_2.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_io.catenax.fleet.vehicles_2.0.0_UniqueID" + }, + "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.fleet.vehicles_2.0.0_CubicCapacity" + }, + "power" : { + "description" : "Engine power is the power that an engine can put out", + "$ref" : "#/components/schemas/urn_samm_io.catenax.fleet.vehicles_2.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" + }, + "nhtsaFuelType" : { + "description" : "Description of the fuel according US NHTSA", + "$ref" : "#/components/schemas/urn_samm_io.catenax.fleet.vehicles_2.0.0_FuelTypesNHTSA" + } + }, + "required" : [ "engineId" ] + }, + "urn_samm_io.catenax.fleet.vehicles_2.0.0_EnginesList" : { + "description" : "A list of all installed engines in the vehicle", + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/urn_samm_io.catenax.fleet.vehicles_2.0.0_Engine" + } + }, + "urn_samm_io.catenax.fleet.vehicles_2.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_io.catenax.fleet.vehicles_2.0.0_UniqueID" + }, + "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" ] + }, + "urn_samm_io.catenax.fleet.vehicles_2.0.0_EquipmentsList" : { + "description" : "List of equipments installed in the vehicle.", + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/urn_samm_io.catenax.fleet.vehicles_2.0.0_Equipment" + } + }, + "urn_samm_io.catenax.fleet.vehicles_2.0.0_Vehicle" : { + "description" : "Vehicle data that does not fit into one of the other entities.", + "type" : "object", + "properties" : { + "recordStatus" : { + "description" : "The record operation enumeration can be used to realize delta update concept.\nDelta update concept means:\n- You transfer an initial load of data\n- After the first week only the delta to the initial load is transferred\n\n\nThe record status describes whether this record is:\n- new=>This record is transferred the first time\n- update=> Some properties of this record have changed compared to a previous transfer\n- delete=> This record was transferred in the initial load or in a previous delta update, but is not used any more and therefore it should be deleted on data consumer side\n- same=> This record was transferred in the initial load or in a previous delta update", + "$ref" : "#/components/schemas/urn_samm_io.catenax.fleet.vehicles_2.0.0_RecordStatusEnumeration" + }, + "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.fleet.vehicles_2.0.0_UniqueID" + }, + "catenaXVehicleId" : { + "description" : "A unique identifier for the vehicle in the Catena-X data space.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.uuid_2.0.0_UuidV4Trait" + }, + "class" : { + "description" : "Class of the vehicle.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "driveSystemPower" : { + "description" : "Complete power of this vehicle in KW. This sums up the power of each individual engine installed in this vehicle.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.fleet.vehicles_2.0.0_EnginePower" + }, + "driveType" : { + "description" : "Drive type of a vehicle according enumeration.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.fleet.vehicles_2.0.0_DriveTypeNHTSA" + }, + "powerTrainType" : { + "description" : "Describes the installed powertrain in the vehicle.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.fleet.vehicles_2.0.0_PowerTrainTypes" + }, + "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" + }, + "plantCatenaXId" : { + "description" : "Unique Catena-X plant identifier, also called BPNS.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.business_partner_number_2.0.0_BpnsTrait" + }, + "plantCountryCode" : { + "description" : "Country code of the plant, where the vehicle was produced.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.fleet.vehicles_2.0.0_CountryCodeTrait" + }, + "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" + }, + "plantIdentifier" : { + "description" : "Plant id of the final assembly of the vehicle", + "$ref" : "#/components/schemas/urn_samm_io.catenax.fleet.vehicles_2.0.0_UniqueID" + }, + "productionDate" : { + "description" : "Production date of the vehicle", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Timestamp" + }, + "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" + }, + "soldCountryCode" : { + "description" : "The country code in 3 letter format where this vehicle was sold.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.fleet.vehicles_2.0.0_CountryCodeTrait" + }, + "soldCountryGroup" : { + "description" : "The region where this car was sold.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "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" + }, + "steeringPos" : { + "description" : "Position of vehicle steering wheel, Left or right.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.fleet.vehicles_2.0.0_VehicleSteeringPos" + }, + "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" + }, + "wmiCode" : { + "description" : "The world manufacturer index are the first 3 letters of the VIN. IT describes a code for the vehicle manufacturer. Also see the description from NTHSA.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.fleet.vehicles_2.0.0_OemShortNameTrait" + }, + "wmiNameNHTSA" : { + "description" : "Name of the vehicle manufacturer according NHTSA: use https://vpic.nhtsa.dot.gov/api/vehicles/decodewmi/WVW?format=json - entry to be used is CommonName.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "engines" : { + "description" : "List of installed engines in the vehicle.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.fleet.vehicles_2.0.0_EnginesList" + }, + "equipments" : { + "description" : "Equipments.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.fleet.vehicles_2.0.0_EquipmentsList" + } + }, + "required" : [ "anonymizedVin" ] + }, + "urn_samm_io.catenax.fleet.vehicles_2.0.0_VehiclesList" : { + "description" : "List of vehicles", + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/urn_samm_io.catenax.fleet.vehicles_2.0.0_Vehicle" + } + }, + "urn_samm_io.catenax.fleet.vehicles_2.0.0_MetaCharacteristic" : { + "description" : "Characteristic for the meta information.", + "type" : "object", + "properties" : { + "selectionCriteria" : { + "description" : "Describes the selection criteria a Catena-X data provider has applied to create this data set.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "selectionStart" : { + "description" : "Describes the starting point for providing records in this data set.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "selectionEnd" : { + "description" : "Describes the end point for providing records in this data set.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + } + }, + "required" : [ "selectionCriteria" ] + } + } + }, + "properties" : { + "listOfVehicles" : { + "description" : "List of Vehicle.ProductDescription", + "$ref" : "#/components/schemas/urn_samm_io.catenax.fleet.vehicles_2.0.0_VehiclesList" + }, + "metaInformation" : { + "description" : "This meta information is valid for all entries in this data set. The meta information is used to tell the data consumer which selection criteria were applied by the data provider. ", + "$ref" : "#/components/schemas/urn_samm_io.catenax.fleet.vehicles_2.0.0_MetaCharacteristic" + } + }, + "required" : [ "listOfVehicles" ] +} \ No newline at end of file diff --git a/io.catenax.fleet.vehicles/2.1.0/gen/Vehicles.html b/io.catenax.fleet.vehicles/2.1.0/gen/Vehicles.html new file mode 100644 index 00000000..934371ed --- /dev/null +++ b/io.catenax.fleet.vehicles/2.1.0/gen/Vehicles.html @@ -0,0 +1,3030 @@ + + + + + + + + + + + + + + Documentation Vehicles + + +
+
+
+
+

Aspect Model Vehicles

+
urn:samm:io.catenax.fleet.vehicles:2.0.0#Vehicles
+
+
+
+
+
+
+
+ +
+ + +
+ This aspect model was created in the Catena-X use case quality. The purpose of this aspect model is to transfer general information of a list/fleet of vehicles - primarily how the vehicles are equipped, when they were built and which engines are installed. +
+ + +
+

Overview

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

Properties

+
+ +
+ +
+

Meta information

+
+ +This meta information is valid for all entries in this data set. The meta information is used to tell the data consumer which selection criteria were applied by the data provider. + +
+
Name
+
metaInformation
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.fleet.vehicles:2.0.0#MetaInformation + +
+
+
+
+
+ + +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
metaInformation
+
+ + +
+
+ +
+

listOfVehicles

+
+ +List of Vehicle.ProductDescription + +
+
Name
+
listOfVehicles
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has no order
+
+
+
Duplicates not allowed
+
+
+
+ Type urn:samm:io.catenax.fleet.vehicles:2.0.0#Vehicle + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
listOfVehicles
+
+ + +
+
+ + + +
+
+

Entities

+
+ +
+
+

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
+
+ Yes
+
+ +
+
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
+
+ Yes
+
+ +
+
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
+
+ Yes
+
+ +
+
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
+
+
+
+
    +
  • + $unit.getPreferredName( $i18n.getLocale() ) +
    • +
  • +
    +
    +
    + Reference +
    +
    +
    +
    +
    +
    • +
+
+
+
+
+ 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
+
+
+
+
    +
  • + $unit.getPreferredName( $i18n.getLocale() ) +
    • +
  • +
    +
    +
    + Reference +
    +
    +
    +
    +
    +
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#integer + +
+
+
+
+
+ +
+
Example
+
110
+
+ +
+
Optional
+
+ Yes
+
+ +
+
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
+
+ + +
+
+ +
+
Fuel type(NHTSA)
+
+ +Description of the fuel according US NHTSA + +
+
Name
+
nhtsaFuelType
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
+
+
+
+
+ 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
+
+ + +
+
+
+
+

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
+
+ Yes
+
+ +
+
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
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
group
+
+ + +
+
+
+
+

Meta Information

+
+
+ This entity groups all meta information properties. Meta information properties give hints for a Catena-X data consumer to better understand, how this data set was created on the Catena-X data provider side. +
+ +
+

Properties

+
+
+ +
+
Selection criteria
+
+ +Describes the selection criteria a Catena-X data provider has applied to create this data set. + +
+
Name
+
selectionCriteria
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Export of vehicles that are involved in the linked qualityTask and FleetClaim list.
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
selectionCriteria
+
+ + +
+
+ +
+
Selection start
+
+ +Describes the starting point for providing records in this data set. + +
+
Name
+
selectionStart
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
2023-01-01T00:00:00
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
selectionStart
+
+ + +
+
+ +
+
Selection end
+
+ +Describes the end point for providing records in this data set. + +
+
Name
+
selectionEnd
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
2023-12-31T23:59:59
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
selectionEnd
+
+ + +
+
+
+
+

Vehicle

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

Properties

+
+
+ +
+
Record status
+
+ +The record operation enumeration can be used to realize delta update concept. +Delta update concept means: +- You transfer an initial load of data +- After the first week only the delta to the initial load is transferred + + +The record status describes whether this record is: +- new=>This record is transferred the first time +- update=> Some properties of this record have changed compared to a previous transfer +- delete=> This record was transferred in the initial load or in a previous delta update, but is not used any more and therefore it should be deleted on data consumer side +- same=> This record was transferred in the initial load or in a previous delta update + +
+
Name
+
recordStatus
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
update
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
recordStatus
+
+ + +
+
+ +
+
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 unique identifier for the vehicle in the Catena-X data space. + +
+
Name
+
catenaXVehicleId
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
urn:uuid:580d3adf-1981-44a0-a214-13d6ceed9379
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
catenaXVehicleId
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + UUID v4 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
    +
    $regularExpressionConstraint.getValue()
    +
    + +
    • +
+
+
+
+
+ +
+
Vehicle class
+
+ +Class of the vehicle. + +
+
Name
+
class
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
A
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
class
+
+ + +
+
+ +
+
Complete system power
+
+ +Complete power of this vehicle in KW. This sums up the power of each individual engine installed in this vehicle. + +
+
Name
+
driveSystemPower
+
+ + + +
+
Characteristic
+
+
+
+
Measurement
+
+
+
Engine power expressed in kilowatt.
+
+
+
Unit
+
+
+
+
    +
  • + $unit.getPreferredName( $i18n.getLocale() ) +
    • +
  • +
    +
    +
    + Reference +
    +
    +
    +
    +
    +
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#integer + +
+
+
+
+
+ +
+
Example
+
200
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
driveSystemPower
+
+ + +
+
+ +
+
Drive type
+
+ +Drive type of a vehicle according enumeration. + +
+
Name
+
driveType
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
+
+
+
+
+ Reference +
+
    +
  • https://vpic.nhtsa.dot.gov/api/
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Front-Wheel Drive
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
driveType
+
+ + +
+
+ +
+
Powertrain Type
+
+ +Describes the installed powertrain in the vehicle. + +
+
Name
+
powerTrainType
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ + +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
powerTrainType
+
+ + +
+
+ +
+
Vehicle model
+
+ +Detail vehicle model like "Golf VIII" + +
+
Name
+
modelDescription
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Golf VIII
+
+ +
+
Optional
+
+ Yes
+
+ +
+
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
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
modelIdentifier
+
+ + +
+
+ +
+
Plant Catena-X ID
+
+ +Unique Catena-X plant identifier, also called BPNS. + +
+
Name
+
plantCatenaXId
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
BPNS0123456789ZZ
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
plantCatenaXId
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + BPNS Regular Expression +
    + +
    +
    Description
    +
    The provided regular expression ensures that the BPNS is composed of prefix 'BPNS', 10 digits and two alphanumeric letters.
    +
    + + +
    +
    Regular expression
    +
    $regularExpressionConstraint.getValue()
    +
    + +
    • +
+
+
+
+
+ +
+
Plant country
+
+ +Country code of the plant, where the vehicle was produced. + +
+
Name
+
plantCountryCode
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
DEU
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
plantCountryCode
+
+ + +
+
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
    +
    $regularExpressionConstraint.getValue()
    +
    + +
    • +
+
+
+
+
+ +
+
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
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
plantDescription
+
+ + +
+
+ +
+
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
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
plantIdentifier
+
+ + +
+
+ +
+
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
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
productionDate
+
+ + +
+
+ +
+
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
+
+ + +
+
+ +
+
Sold country code
+
+ +The country code in 3 letter format where this vehicle was sold. + +
+
Name
+
soldCountryCode
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
DEU
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
soldCountryCode
+
+ + +
+
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
    +
    $regularExpressionConstraint.getValue()
    +
    + +
    • +
+
+
+
+
+ +
+
Vehicle sold region
+
+ +The region where this car was sold. + +
+
Name
+
soldCountryGroup
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Europe
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
soldCountryGroup
+
+ + +
+
+ +
+
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
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
soldDate
+
+ + +
+
+ +
+
Vehicle steering pos
+
+ +Position of vehicle steering wheel, Left or right. + +
+
Name
+
steeringPos
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
+
+
+
+
+ Reference +
+
    +
  • https://vpic.nhtsa.dot.gov/api/
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Left-Hand Drive
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
steeringPos
+
+ + +
+
+ +
+
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
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
vehicleSeries
+
+ + +
+
+ +
+
WMI Code
+
+ +The world manufacturer index are the first 3 letters of the VIN. IT describes a code for the vehicle manufacturer. Also see the description from NTHSA. + +
+
Name
+
wmiCode
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
WVW
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
wmiCode
+
+ +
+
Reference
+
+
    +
  • https://vpic.nhtsa.dot.gov/
    • +
+
+
+ +
+
Constraints
+
+
    +
  • +
    + +
    + Length restriction for WMI +
    + +
    +
    Description
    +
    Restricts the length of wmiCode to exactly 3 chars.
    +
    + +
    +
    Reference
    +
    +
    +
      +
    • https://vpic.nhtsa.dot.gov/
      • +
    +
    +
    +
    + + +
    • +
+
+
+
+
+ +
+
WMI name according NHTSA
+
+ +Name of the vehicle manufacturer according NHTSA: use https://vpic.nhtsa.dot.gov/api/vehicles/decodewmi/WVW?format=json - entry to be used is CommonName. + +
+
Name
+
wmiNameNHTSA
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Volkswagen
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
wmiNameNHTSA
+
+ +
+
Reference
+
+
    +
  • https://vpic.nhtsa.dot.gov/
    • +
+
+
+ +
+
+ +
+
Engines
+
+ +List of installed engines in the vehicle. + +
+
Name
+
engines
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has no order
+
+
+
Duplicates not allowed
+
+
+
+ Type urn:samm:io.catenax.fleet.vehicles:2.0.0#Engine + +
+
+
+
+
+ + +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
engines
+
+ + +
+
+ +
+
Equipments
+
+ +Equipments. + +
+
Name
+
equipments
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has no order
+
+
+
Duplicates not allowed
+
+
+
+ Type urn:samm:io.catenax.fleet.vehicles:2.0.0#Equipment + +
+
+
+
+
+ + +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
equipments
+
+ + +
+
+
+ +
+ Third party licenses + +
+ +
+ + +
+ + + \ No newline at end of file diff --git a/io.catenax.fleet.vehicles/2.1.0/gen/Vehicles.json b/io.catenax.fleet.vehicles/2.1.0/gen/Vehicles.json new file mode 100644 index 00000000..65a61187 --- /dev/null +++ b/io.catenax.fleet.vehicles/2.1.0/gen/Vehicles.json @@ -0,0 +1,48 @@ +{ + "metaInformation" : { + "selectionEnd" : "2023-12-31T23:59:59", + "selectionStart" : "2023-01-01T00:00:00", + "selectionCriteria" : "Export of vehicles that are involved in the linked qualityTask and FleetClaim list. " + }, + "listOfVehicles" : [ { + "modelIdentifier" : "689-G8", + "soldDate" : "2018-02-03T00:00:00", + "plantDescription" : "Wolfsburg", + "anonymizedVin" : "3747429FGH382923974682", + "soldCountryGroup" : "Europe", + "wmiCode" : "WVW", + "productionDate" : "2018-01-15T00:00:00", + "catenaXVehicleId" : "urn:uuid:580d3adf-1981-44a0-a214-13d6ceed9379", + "engines" : [ { + "serialNumber" : "3434937GJJG3738", + "size" : 1968, + "installDate" : "2018-01-10T00:00:00", + "engineDescription" : "2.0 TDI", + "power" : 110, + "nhtsaFuelType" : "Compressed Hydrogen/Hydrogen", + "engineId" : "CKBY", + "engineSeries" : "EA189", + "engineProductionDate" : "2017-10-20T00:00:00" + } ], + "driveSystemPower" : 200, + "class" : "A", + "driveType" : "All-Wheel Drive", + "wmiNameNHTSA" : "Volkswagen", + "steeringPos" : "Left-Hand Drive", + "powerTrainType" : "BEV (Battery Electric Vehicle)", + "soldCountryCode" : "DEU", + "plantCatenaXId" : "BPNS0123456789ZZ", + "plantCountryCode" : "DEU", + "modelDescription" : "Golf VIII", + "plantIdentifier" : "4711", + "equipments" : [ { + "equipmentIdentifier" : "S248A", + "equipmentDescription" : "Seat heating front", + "group" : "Interior" + } ], + "recordStatus" : "new", + "softwareCategory" : "TZGH64738", + "vehicleSeries" : "Golf", + "softwareVersion" : "3.4.9837.567" + } ] +} \ No newline at end of file diff --git a/io.catenax.fleet.vehicles/2.1.0/gen/Vehicles.png b/io.catenax.fleet.vehicles/2.1.0/gen/Vehicles.png new file mode 100644 index 00000000..c9cc01e5 Binary files /dev/null and b/io.catenax.fleet.vehicles/2.1.0/gen/Vehicles.png differ diff --git a/io.catenax.fleet.vehicles/2.1.0/metadata.json b/io.catenax.fleet.vehicles/2.1.0/metadata.json new file mode 100644 index 00000000..a182c7b8 --- /dev/null +++ b/io.catenax.fleet.vehicles/2.1.0/metadata.json @@ -0,0 +1 @@ +{ "status" : "release"} \ No newline at end of file diff --git a/io.catenax.fleet.vehicles/RELEASE_NOTES.md b/io.catenax.fleet.vehicles/RELEASE_NOTES.md index df76b01e..87e25cb6 100644 --- a/io.catenax.fleet.vehicles/RELEASE_NOTES.md +++ b/io.catenax.fleet.vehicles/RELEASE_NOTES.md @@ -1,8 +1,17 @@ # Changelog All notable changes to this model will be documented in this file. -## [Purpose of this model] -This aspect model was created in the Catena-X use case quality. The purpose of this aspect model is to transfer general information of a list/fleet of vehicles - primarily how the vehicles are equipped, when they were built and which engines are installed. +## [Unreleased] +- Version 2.0.0 of model is deprecated. It has a wrong regex for BPNS validation from the old shared model for BPNS trait. + +## [2.1.0] - 2024-02-19 +### Added + +### Changed +- reference to shared aspect model for BPNS was changed to latest version + +### Removed + ## [2.0.0] - 2024-01-22 ### Added