From df8fa9da36737d19c2f623b2a9e0edf47ac3ca9a Mon Sep 17 00:00:00 2001 From: GitHub Actions Bot Date: Fri, 2 Feb 2024 12:17:27 +0000 Subject: [PATCH] Adding auto-generated artifacts for new models --- .../2.0.0/gen/TractionBatteryCode-aas.xml | 514 +++++++++++ .../2.0.0/gen/TractionBatteryCode-schema.json | 59 ++ .../2.0.0/gen/TractionBatteryCode.aasx | Bin 0 -> 3861 bytes .../2.0.0/gen/TractionBatteryCode.html | 809 ++++++++++++++++++ .../2.0.0/gen/TractionBatteryCode.json | 8 + .../2.0.0/gen/TractionBatteryCode.yml | 193 +++++ 6 files changed, 1583 insertions(+) create mode 100644 io.catenax.traction_battery_code/2.0.0/gen/TractionBatteryCode-aas.xml create mode 100644 io.catenax.traction_battery_code/2.0.0/gen/TractionBatteryCode-schema.json create mode 100644 io.catenax.traction_battery_code/2.0.0/gen/TractionBatteryCode.aasx create mode 100644 io.catenax.traction_battery_code/2.0.0/gen/TractionBatteryCode.html create mode 100644 io.catenax.traction_battery_code/2.0.0/gen/TractionBatteryCode.json create mode 100644 io.catenax.traction_battery_code/2.0.0/gen/TractionBatteryCode.yml diff --git a/io.catenax.traction_battery_code/2.0.0/gen/TractionBatteryCode-aas.xml b/io.catenax.traction_battery_code/2.0.0/gen/TractionBatteryCode-aas.xml new file mode 100644 index 000000000..48563a69f --- /dev/null +++ b/io.catenax.traction_battery_code/2.0.0/gen/TractionBatteryCode-aas.xml @@ -0,0 +1,514 @@ + + + + + defaultAdminShell + + + en + defaultAdminShell + + + + urn:samm:io.catenax.traction_battery_code:2.0.0#TractionBatteryCode + + Type + + + + ModelReference + + + Submodel + urn:samm:io.catenax.traction_battery_code:2.0.0#TractionBatteryCode/submodel + + + + + + + + + TractionBatteryCode + + + en + The traction battery code is an identification code for any automotive traction battery, ultracapacitor and other reachargeble energy storage device. It allows to carry information as required by the National Standard of the People's Republic of China according to GB/T 34014-2017 published by the Standardization Administration of China (SAC). + + + + urn:samm:io.catenax.traction_battery_code:2.0.0#TractionBatteryCode/submodel + Template + + ModelReference + + + ConceptDescription + urn:samm:io.catenax.traction_battery_code:2.0.0#TractionBatteryCode + + + + + + ExternalReference + + + GlobalReference + https://std.samr.gov.cn/gb/search/gbDetailed?id=71F772D818B4D3A7E05397BE0A0AB82A + + + + + + + tractionBatteryCode + + + en + Traction Battery Code + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.traction_battery_code:2.0.0#tractionBatteryCode + + + + xs:string + + + + subcomponents + + + en + Subcomponents + + + + + en + Subcomponents of the component, if applicable. The relationship between traction battery codes are as follows: + +If this traction battery code is given for a cell subcomponents are not required. +If this traction battery code is given for a battery module a list of cells are required to be registered as subcomponents. +If this traction battery code is given for a battery pack a list of modules are required to be registered as subcomponents (containing each a list of cell subcomponents respectively). + + + true + DataElement + + + TractionBatteryComponent + + + en + Battery Component + + + + + en + A battery component like a cell or a module. + + + + + tractionBatteryCode + + + en + Traction Battery Code + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.traction_battery_code:2.0.0#tractionBatteryCode + + + + xs:string + + + + productType + + + en + Product Type + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.traction_battery_code:2.0.0#productType + + + + xs:string + + + + + + + + productType + + + en + Product Type + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.traction_battery_code:2.0.0#productType + + + + xs:string + + + + + + + + APPLICATION_CLASS + TractionBatteryCode + + + en + Traction Battery Code + + + + + en + The traction battery code is an identification code for any automotive traction battery, ultracapacitor and other reachargeble energy storage device. It allows to carry information as required by the National Standard of the People's Republic of China according to GB/T 34014-2017 published by the Standardization Administration of China (SAC). + + + urn:samm:io.catenax.traction_battery_code:2.0.0#TractionBatteryCode + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Traction Battery Code + + + + + en + TractionBatteryCode + + + + + en + The traction battery code is an identification code for any automotive traction battery, ultracapacitor and other reachargeble energy storage device. It allows to carry information as required by the National Standard of the People's Republic of China according to GB/T 34014-2017 published by the Standardization Administration of China (SAC). + + + + + + + + + tractionBatteryCode + + + en + Traction Battery Code + + + urn:samm:io.catenax.traction_battery_code:2.0.0#tractionBatteryCode + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Traction Battery Code + + + + + en + tractionBatteryCode + + + STRING + + + en + Traction Battery Code identifying a single traction battery component like a pack, module or cell. + + + + + + + + + tractionBatteryCode + + + en + Traction Battery Code + + + urn:samm:io.catenax.traction_battery_code:2.0.0#tractionBatteryCode + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Traction Battery Code + + + + + en + tractionBatteryCode + + + STRING + + + en + Traction Battery Code identifying a single traction battery component like a pack, module or cell. + + + + + + + + + productType + + + en + Product Type + + + urn:samm:io.catenax.traction_battery_code:2.0.0#productType + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Product Type + + + + + en + productType + + + STRING + + + en + The type of the battery component, e.g. a pack, a module or a cell. + + + + + + pack + + ModelReference + + + DataElement + urn:samm:io.catenax.traction_battery_code:2.0.0#ComponentTypeCharacterstic:pack + + + + + + module + + ModelReference + + + DataElement + urn:samm:io.catenax.traction_battery_code:2.0.0#ComponentTypeCharacterstic:module + + + + + + cell + + ModelReference + + + DataElement + urn:samm:io.catenax.traction_battery_code:2.0.0#ComponentTypeCharacterstic:cell + + + + + + + + + + + + + subcomponents + + + en + Subcomponents + + + urn:samm:io.catenax.traction_battery_code:2.0.0#subcomponents + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Subcomponents + + + + + en + subcomponents + + + STRING + + + en + Subcomponents of the component, if applicable. The relationship between traction battery codes are as follows: + +If this traction battery code is given for a cell subcomponents are not required. +If this traction battery code is given for a battery module a list of cells are required to be registered as subcomponents. +If this traction battery code is given for a battery pack a list of modules are required to be registered as subcomponents (containing each a list of cell subcomponents respectively). + + + + + + + + + productType + + + en + Product Type + + + urn:samm:io.catenax.traction_battery_code:2.0.0#productType + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Product Type + + + + + en + productType + + + STRING + + + en + The type of the battery component, e.g. a pack, a module or a cell. + + + + + + + + + diff --git a/io.catenax.traction_battery_code/2.0.0/gen/TractionBatteryCode-schema.json b/io.catenax.traction_battery_code/2.0.0/gen/TractionBatteryCode-schema.json new file mode 100644 index 000000000..4c7e4a5b6 --- /dev/null +++ b/io.catenax.traction_battery_code/2.0.0/gen/TractionBatteryCode-schema.json @@ -0,0 +1,59 @@ +{ + "$schema" : "http://json-schema.org/draft-04/schema", + "description" : "The traction battery code is an identification code for any automotive traction battery, ultracapacitor and other reachargeble energy storage device. It allows to carry information as required by the National Standard of the People's Republic of China according to GB/T 34014-2017 published by the Standardization Administration of China (SAC).", + "type" : "object", + "components" : { + "schemas" : { + "urn_samm_io.catenax.traction_battery_code_2.0.0_TractionBatteryCodeTrait" : { + "type" : "string", + "description" : "The traction battery code as required by the National Standard of the People's Republic of China according to GB/T 34014-2017 published by the Standardization Administration of China (SAC). It can have a length of either 24 or 18 characters.", + "pattern" : "(^[A-Z0-9]{3}[PMC]{1}[A-GZ]{1}[A-Z0-9]{2}[A-Z0-9]{7}[1-9A-GH-NPR-Y]{1}[1-9A-C]{1}[0-9A-GH-NPR-Y]{1}[0-9]{7}$)|(^[A-Z0-9]{3}[PMC]{1}[A-GZ]{1}[A-Z0-9]{2}[1-9A-GH-NPR-Y]{1}[1-9A-C]{1}[0-9A-GH-NPR-Y]{1}[0-9]{7}[R]{1}[PMC]{1}$)" + }, + "urn_samm_io.catenax.traction_battery_code_2.0.0_ComponentTypeCharacterstic" : { + "type" : "string", + "enum" : [ "pack", "module", "cell" ] + }, + "urn_samm_io.catenax.traction_battery_code_2.0.0_TractionBatteryComponent" : { + "description" : "A battery component like a cell or a module.", + "type" : "object", + "properties" : { + "tractionBatteryCode" : { + "description" : "Traction Battery Code identifying a single traction battery component like a pack, module or cell. ", + "$ref" : "#/components/schemas/urn_samm_io.catenax.traction_battery_code_2.0.0_TractionBatteryCodeTrait" + }, + "subcomponents" : { + "description" : "Subcomponents of the component, if applicable. The relationship between traction battery codes are as follows:\n\nIf this traction battery code is given for a cell subcomponents are not required. \nIf this traction battery code is given for a battery module a list of cells are required to be registered as subcomponents.\nIf this traction battery code is given for a battery pack a list of modules are required to be registered as subcomponents (containing each a list of cell subcomponents respectively).", + "$ref" : "#/components/schemas/urn_samm_io.catenax.traction_battery_code_2.0.0_ComponentList" + }, + "productType" : { + "description" : "The type of the battery component, e.g. a pack, a module or a cell.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.traction_battery_code_2.0.0_ComponentTypeCharacterstic" + } + }, + "required" : [ "tractionBatteryCode", "productType" ] + }, + "urn_samm_io.catenax.traction_battery_code_2.0.0_ComponentList" : { + "description" : "A list of battery components like modules or cells.", + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/urn_samm_io.catenax.traction_battery_code_2.0.0_TractionBatteryComponent" + } + } + } + }, + "properties" : { + "tractionBatteryCode" : { + "description" : "Traction Battery Code identifying a single traction battery component like a pack, module or cell. ", + "$ref" : "#/components/schemas/urn_samm_io.catenax.traction_battery_code_2.0.0_TractionBatteryCodeTrait" + }, + "subcomponents" : { + "description" : "Subcomponents of the component, if applicable. The relationship between traction battery codes are as follows:\n\nIf this traction battery code is given for a cell subcomponents are not required. \nIf this traction battery code is given for a battery module a list of cells are required to be registered as subcomponents.\nIf this traction battery code is given for a battery pack a list of modules are required to be registered as subcomponents (containing each a list of cell subcomponents respectively).", + "$ref" : "#/components/schemas/urn_samm_io.catenax.traction_battery_code_2.0.0_ComponentList" + }, + "productType" : { + "description" : "The type of the battery component, e.g. a pack, a module or a cell.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.traction_battery_code_2.0.0_ComponentTypeCharacterstic" + } + }, + "required" : [ "tractionBatteryCode", "productType" ] +} \ No newline at end of file diff --git a/io.catenax.traction_battery_code/2.0.0/gen/TractionBatteryCode.aasx b/io.catenax.traction_battery_code/2.0.0/gen/TractionBatteryCode.aasx new file mode 100644 index 0000000000000000000000000000000000000000..a01d79f45b037134679249ceb45de6dd151f9e2f GIT binary patch literal 3861 zcmaKv2T)T>+kitaq4y?AN9lr;OO@WFNN>^-5F~&g2qG;IrGtci=_n#dmnuDULPvT) zszLyfrc&ac+;8s4?{~lZo;f?aGrRAZ^X%@-^BU<95HbKrNl5|xPO6rGOF@tA+o*YY zJ_36_vNsL%2K(BH20%RGjfdS4;uIl_MQH8pUGZM+c|=Hp4K<2@RO^mD{eq>n&T@!u z7Q&q6$SJAq>J}WmD@C=bo*7I*xtPw#LM~db^oa85?sBYvxG;+~hf_ZBNOu)#>dcp0 zx|DKJMJzeD96U1_W!tNM`-K{kCnl|_mJCHJUqfwneBX{j^)`8?qJv5M1YSFdgjhPp z0|h9S3V2@lV9w-zrGD&(Dx{P!$6oNNJYQJgpHmxjTE@gdh{y*kwq<)J)bL=vP?#!w zRw|#`!9QbzKx@}pJvZ%j)ZAlo%mZ&{X=X{r>q1#QlUaK+9n#G?g&wX>O%)#Ld2{Cg zBRvw*sWo<*V=R+dJOFn5H#LFZr~$Dv?0vuN-EKv7Iw|V+gMyG$DzpNkX~LnQn3F#A&DzJvo<4DJl;DVX#{FOx63mkjIz`u4 zs#W5BVFc}tD}4wIk!y+ib+{qyg{B}up8K7|yG)WR_^+bL2<&W;KvU~OLHZ0}oS=-Z z-_4&>A0OQDuOT2Qs@H8O_x@f_Zv)BxY%@uAoL`52Tq-&J(Epi&6Q5K{**OQdi}I;T zx=mN5sRQ#>^-S+v_N!ky{Gf~$7+Qh6oy~<2&BJV-aed_MSYG=%<^$BW3JN2CZ1$ob z;CnnJN0eMPL46g+$+N|4=L?p?`+wy`gPq~%=o=u0Yec+!++5u}50OGT!$JedQ9b0q z8&mCJ5y3Z81b?w-({{*U!mePzzW^<8EkMMo0MPy$bs&Bx z>qXdueb9;q#Z1M;OGaP0mB46Wazrgm?o)tq3`(EfhmrfoY8)3NBUT?C^SSLIw_gcb zCKV&;Fv`%-*;TE?j^cPHb>~oY`2M?{E4eR~5?k4at7l}x8lAHQZ3K-6iShzkh&Gg3Krq%`&?o_ve#%1yo;n)?F2DbCt^n{9p!Hab$W^`m#g7AxCR zm+g5Mbhu!JhOZ{v>#TQ`&iZ}MzfP`o-TubwFy%YyPaQWR%3ZNBHiuWp_zfRTO1ibpSH4D`POutO@TSyGld(+`CH8fY*=Lg(QGcN7nuG4(8>EH zD%FC{42iBY)r^~*k-C~rH1u?oH(zKAtM8640s}_*OK`J%KS1yT}@VtzYPr5 z30hopcr3k&CmW#8`6FNhu76FSrdx7?$5Tpe-Y9K7UlnXVn?4MgHsn0kLnbVm?k8Ct z7Wo{QY*&g7hh+EU6Pt<0;Egr1<+C{j z^2bo3w8on|n22V7!?(N>Np*}&#S;wMjza_Z`r7zB5bFLE!XzrXcHn3*qq8S{=ImC@ zMGKEmnin!Fwmfj7XqLZe-t>f1UhjYbBV*;*rR_EDV&e2@zJIX5{NcSR+XFw(#|&1M zVx1EnVnQPgI<-ywq@f;4iJu7h-alVOsX2Y40h7Lung?_~(&e#@dvdL+-~ntuIS80I zc~%;uNO%noGTX#xfseR6M^Bq5HVsY{V5Qe4~bkfZ98V1oqV*RCD0ZY2SyU)kMZ6 zGEA6xJgn|rD^1MU7;2K!)auKLSi3-sbdr(7@V-s5()Ap*_eVK}fvlGkPb2K(XGmjT zy%Szpvx^D_t;pvq8uTa}!Q=q97`l4c=3jL{q8;xN!q+T{{Xd3F=h=foOjc$m3p4Or zc*o3$Dp>Mv?8Ut3exAg*NFrZk3L1t!{6Xrks;Xcy{Czb5uDQ$iTHs~O!v(-6l3wI{ z8R41iJNla54#O*zz%B{DsEg=%R{@edLjx)?18RfOM6rZZf%Kf^gb-!9_MId7i^E9- zrZzosK3Fgx1Ln0{;#J;%O1E#;vq83ZmME&byQs--f)*AdsgvqjU|*WJo9?-|#Fg?ZS!il!7J#B} z`hN%M>1UYD*F68s;Mk$-5UsLJ!K)2c$xbS%k~!ECpX|qq?3GArg359KGmKQ7B7|f@;j~w zthP(ia24X2->vGM_3(5UdEAuAV=|q?-rArbXs^N%zCpffXRW96$2Futn#0kE?ua9} zT39i*q|t-TQl(YLTaUwsI*HKFo7LH_+O8LZVY1{g;vr62BHEP2$g6F}q;RyAx|u>> zXQ@(1yz==j&x;7!%*9Ro!IeqnZJ0xo5rGo}n3ncJLF{=I2Wb1F5{IhM@uI z3mvU;LzT%D5w%-zh^4=Xga}(J(`^xoRN4b}`!sJD+26_$ z%y9ZIDDt>R5Gx-MF7huN^Axxur)RziYG-l4f|}2Rv)2C*%bqUvP{U|e%-aM!5?WL~ zgql@``ug7DIO;weT+Zcwkth%%3v)c;(|~ zHLaGpqjws`(})Abu)#q+L$qmOH0rMF*~%+UkbT)FcbPyp+AlXyuxfS%H|w+OnsQt= zHd#|BHW~F4-IOwO12(?o1#crF>iMSEsqqpyMj{HL-X>uq=7xM?cgJ1*;wqpvWzf>k z?hTVV@hK!p_^jYThC;@uxOFz5eS~Fra9N`-yHo34(Wksr9(XelV)*hjYZu`>sU1V7+c#0$eOK?(GvafGanLLK=JD#I?&_(*x|Jg_!DQ3q z50jewmgS{hpT-?N9-w;ua8OzE7imm4nm6;^&-M{UQFWfClpjN3o~r~4On zzxFDda}6;CI~I!RAHkxFAzAfXK)AquY@7HGPv*8RAbdt2U>YngWu6-x+S+ia zj8hD~V_Gm5DFD!9_ix@si&YGem$Q+Nm$xrgF?_%{zknny=yr>kCzq|0~bRCquNjoDmaUca9u{};AyUc3mnB~F}&ZOzz{AM2! z0?&3_Czwh8rl|(g+7GZx@4D&8v6Ef>QI&*KBjH4Umb`(>QZtHKL~w8N^O*6|TLxcg z@+!E}Vr7;91GPJmf~2+w9Rq~=JF4AUFByOnZSO;fwQuK>5d9ILYN8v`f|q^plh_6P zkn?Fn<1)Y9k%+`urDIShRe<0NaxJu-*d*dpRUm=bC+@-qY z_l1`Q8>i;K;vW8gi~8@YFPkV%!hc20->d&w$$w9D`Mlx8^;h%}{IkaXp5ZcH+`0S} ZHz@w$lp5&~5#y#1V;?9MQ7|QL^nX@}hCl!S literal 0 HcmV?d00001 diff --git a/io.catenax.traction_battery_code/2.0.0/gen/TractionBatteryCode.html b/io.catenax.traction_battery_code/2.0.0/gen/TractionBatteryCode.html new file mode 100644 index 000000000..a9b271d42 --- /dev/null +++ b/io.catenax.traction_battery_code/2.0.0/gen/TractionBatteryCode.html @@ -0,0 +1,809 @@ + + + + + + + + + + + + + + Documentation Traction Battery Code + + +
+
+
+
+

Aspect Model Traction Battery Code

+
urn:samm:io.catenax.traction_battery_code:2.0.0#TractionBatteryCode
+
+
+
+
+
+
+
+ +
+ + +
+ The traction battery code is an identification code for any automotive traction battery, ultracapacitor and other reachargeble energy storage device. It allows to carry information as required by the National Standard of the People's Republic of China according to GB/T 34014-2017 published by the Standardization Administration of China (SAC). +
+ + +
+

Overview

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

Properties

+
+ +
+ +
+

Product Type

+
+ +The type of the battery component, e.g. a pack, a module or a cell. + +
+
Name
+
productType
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • pack
    • +
  • module
    • +
  • cell
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
pack
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
productType
+
+ + +
+
+ +
+

Subcomponents

+
+ +Subcomponents of the component, if applicable. The relationship between traction battery codes are as follows: + +If this traction battery code is given for a cell subcomponents are not required. +If this traction battery code is given for a battery module a list of cells are required to be registered as subcomponents. +If this traction battery code is given for a battery pack a list of modules are required to be registered as subcomponents (containing each a list of cell subcomponents respectively). + +
+
Name
+
subcomponents
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.traction_battery_code:2.0.0#TractionBatteryComponent + +
+
+
+
+
+ + +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
subcomponents
+
+ + +
+
+ +
+

Traction Battery Code

+
+ +Traction Battery Code identifying a single traction battery component like a pack, module or cell. + +
+
Name
+
tractionBatteryCode
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
X12MCPM27KLPCLX2M2382320
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
tractionBatteryCode
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + Traction Battery Code Regular Expression +
    + +
    +
    Description
    +
    The traction battery code as required by the National Standard of the People's Republic of China according to GB/T 34014-2017 published by the Standardization Administration of China (SAC). It can have a length of either 24 or 18 characters.
    +
    + +
    +
    Reference
    +
    +
    +
      +
    • https://std.samr.gov.cn/gb/search/gbDetailed?id=71F772D818B4D3A7E05397BE0A0AB82A
      • +
    +
    +
    +
    + +
    +
    Regular expression
    +
    (^[A-Z0-9]{3}[PMC]{1}[A-GZ]{1}[A-Z0-9]{2}[A-Z0-9]{7}[1-9A-GH-NPR-Y]{1}[1-9A-C]{1}[0-9A-GH-NPR-Y]{1}[0-9]{7}$)|(^[A-Z0-9]{3}[PMC]{1}[A-GZ]{1}[A-Z0-9]{2}[1-9A-GH-NPR-Y]{1}[1-9A-C]{1}[0-9A-GH-NPR-Y]{1}[0-9]{7}[R]{1}[PMC]{1}$)
    +
    + +
    • +
+
+
+
+
+ + + +
+
+

Entities

+
+ +
+
+

Battery Component

+
+
+ A battery component like a cell or a module. +
+ +
+

Properties

+
+
+ +
+
Traction Battery Code
+
+ +Traction Battery Code identifying a single traction battery component like a pack, module or cell. + +
+
Name
+
tractionBatteryCode
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
X12MCPM27KLPCLX2M2382320
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
tractionBatteryCode
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + Traction Battery Code Regular Expression +
    + +
    +
    Description
    +
    The traction battery code as required by the National Standard of the People's Republic of China according to GB/T 34014-2017 published by the Standardization Administration of China (SAC). It can have a length of either 24 or 18 characters.
    +
    + +
    +
    Reference
    +
    +
    +
      +
    • https://std.samr.gov.cn/gb/search/gbDetailed?id=71F772D818B4D3A7E05397BE0A0AB82A
      • +
    +
    +
    +
    + +
    +
    Regular expression
    +
    (^[A-Z0-9]{3}[PMC]{1}[A-GZ]{1}[A-Z0-9]{2}[A-Z0-9]{7}[1-9A-GH-NPR-Y]{1}[1-9A-C]{1}[0-9A-GH-NPR-Y]{1}[0-9]{7}$)|(^[A-Z0-9]{3}[PMC]{1}[A-GZ]{1}[A-Z0-9]{2}[1-9A-GH-NPR-Y]{1}[1-9A-C]{1}[0-9A-GH-NPR-Y]{1}[0-9]{7}[R]{1}[PMC]{1}$)
    +
    + +
    • +
+
+
+
+
+ +
+
Subcomponents
+
+ +Subcomponents of the component, if applicable. The relationship between traction battery codes are as follows: + +If this traction battery code is given for a cell subcomponents are not required. +If this traction battery code is given for a battery module a list of cells are required to be registered as subcomponents. +If this traction battery code is given for a battery pack a list of modules are required to be registered as subcomponents (containing each a list of cell subcomponents respectively). + +
+
Name
+
subcomponents
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.traction_battery_code:2.0.0#TractionBatteryComponent + +
+
+
+
+
+ + +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
subcomponents
+
+ + +
+
+ +
+
Product Type
+
+ +The type of the battery component, e.g. a pack, a module or a cell. + +
+
Name
+
productType
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • pack
    • +
  • module
    • +
  • cell
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
pack
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
productType
+
+ + +
+
+
+ +
+ Third party licenses + +
+ +
+ + +
+ + + \ No newline at end of file diff --git a/io.catenax.traction_battery_code/2.0.0/gen/TractionBatteryCode.json b/io.catenax.traction_battery_code/2.0.0/gen/TractionBatteryCode.json new file mode 100644 index 000000000..bd962349f --- /dev/null +++ b/io.catenax.traction_battery_code/2.0.0/gen/TractionBatteryCode.json @@ -0,0 +1,8 @@ +{ + "productType" : "pack", + "tractionBatteryCode" : "X12MCPM27KLPCLX2M2382320", + "subcomponents" : [ { + "productType" : "pack", + "tractionBatteryCode" : "X12MCPM27KLPCLX2M2382320" + } ] +} \ No newline at end of file diff --git a/io.catenax.traction_battery_code/2.0.0/gen/TractionBatteryCode.yml b/io.catenax.traction_battery_code/2.0.0/gen/TractionBatteryCode.yml new file mode 100644 index 000000000..80f538af4 --- /dev/null +++ b/io.catenax.traction_battery_code/2.0.0/gen/TractionBatteryCode.yml @@ -0,0 +1,193 @@ +--- +openapi: 3.0.3 +info: + title: Traction Battery Code + version: v2 +servers: +- url: catenax.io/api/v2 + variables: + api-version: + default: v2 +paths: + /{tenant-id}/traction-battery-code: + get: + tags: + - TractionBatteryCode + operationId: getTractionBatteryCode + 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/TractionBatteryCode' + "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/TractionBatteryCode' + totalItems: + type: number + totalPages: + type: number + pageSize: + type: number + currentPage: + type: number + urn_samm_io.catenax.traction_battery_code_2.0.0_TractionBatteryCodeTrait: + type: string + description: The traction battery code as required by the National Standard + of the People's Republic of China according to GB/T 34014-2017 published by + the Standardization Administration of China (SAC). It can have a length of + either 24 or 18 characters. + pattern: "(^[A-Z0-9]{3}[PMC]{1}[A-GZ]{1}[A-Z0-9]{2}[A-Z0-9]{7}[1-9A-GH-NPR-Y]{1}[1-9A-C]{1}[0-9A-GH-NPR-Y]{1}[0-9]{7}$)|(^[A-Z0-9]{3}[PMC]{1}[A-GZ]{1}[A-Z0-9]{2}[1-9A-GH-NPR-Y]{1}[1-9A-C]{1}[0-9A-GH-NPR-Y]{1}[0-9]{7}[R]{1}[PMC]{1}$)" + urn_samm_io.catenax.traction_battery_code_2.0.0_ComponentTypeCharacterstic: + type: string + enum: + - pack + - module + - cell + urn_samm_io.catenax.traction_battery_code_2.0.0_TractionBatteryComponent: + description: A battery component like a cell or a module. + type: object + properties: + tractionBatteryCode: + description: "Traction Battery Code identifying a single traction battery\ + \ component like a pack, module or cell. " + $ref: '#/components/schemas/urn_samm_io.catenax.traction_battery_code_2.0.0_TractionBatteryCodeTrait' + subcomponents: + description: "Subcomponents of the component, if applicable. The relationship\ + \ between traction battery codes are as follows:\n\nIf this traction battery\ + \ code is given for a cell subcomponents are not required. \nIf this traction\ + \ battery code is given for a battery module a list of cells are required\ + \ to be registered as subcomponents.\nIf this traction battery code is\ + \ given for a battery pack a list of modules are required to be registered\ + \ as subcomponents (containing each a list of cell subcomponents respectively)." + $ref: '#/components/schemas/urn_samm_io.catenax.traction_battery_code_2.0.0_ComponentList' + productType: + description: "The type of the battery component, e.g. a pack, a module or\ + \ a cell." + $ref: '#/components/schemas/urn_samm_io.catenax.traction_battery_code_2.0.0_ComponentTypeCharacterstic' + required: + - tractionBatteryCode + - productType + urn_samm_io.catenax.traction_battery_code_2.0.0_ComponentList: + description: A list of battery components like modules or cells. + type: array + items: + $ref: '#/components/schemas/urn_samm_io.catenax.traction_battery_code_2.0.0_TractionBatteryComponent' + TractionBatteryCode: + description: "The traction battery code is an identification code for any automotive\ + \ traction battery, ultracapacitor and other reachargeble energy storage device.\ + \ It allows to carry information as required by the National Standard of the\ + \ People's Republic of China according to GB/T 34014-2017 published by the\ + \ Standardization Administration of China (SAC)." + type: object + properties: + tractionBatteryCode: + description: "Traction Battery Code identifying a single traction battery\ + \ component like a pack, module or cell. " + $ref: '#/components/schemas/urn_samm_io.catenax.traction_battery_code_2.0.0_TractionBatteryCodeTrait' + subcomponents: + description: "Subcomponents of the component, if applicable. The relationship\ + \ between traction battery codes are as follows:\n\nIf this traction battery\ + \ code is given for a cell subcomponents are not required. \nIf this traction\ + \ battery code is given for a battery module a list of cells are required\ + \ to be registered as subcomponents.\nIf this traction battery code is\ + \ given for a battery pack a list of modules are required to be registered\ + \ as subcomponents (containing each a list of cell subcomponents respectively)." + $ref: '#/components/schemas/urn_samm_io.catenax.traction_battery_code_2.0.0_ComponentList' + productType: + description: "The type of the battery component, e.g. a pack, a module or\ + \ a cell." + $ref: '#/components/schemas/urn_samm_io.catenax.traction_battery_code_2.0.0_ComponentTypeCharacterstic' + required: + - tractionBatteryCode + - productType + 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' + TractionBatteryCode: + content: + application/json: + schema: + $ref: '#/components/schemas/PagingSchema' + description: The request was successful. + requestBodies: + TractionBatteryCode: + content: + application/json: + schema: + $ref: '#/components/schemas/TractionBatteryCode'